Script v1_7_1_0
- AI
- Animals
- Collections
- Contracts
- Debug
- Economy
- Elements
- EnvironmentalScore
- Errors
- Events
- GUI
- Handtools
- Hud
- I3d
- Input
- Jobs
- Maps
- Materials
- Misc
- Objects
- Parameters
- Placeables
- Placement
- Player
- Shop
- Sounds
- Specialization
- Specializations
- AIConveyorBelt
- AIDrivable
- AIFieldWorker
- AIImplement
- AIJobVehicle
- AIVehicle
- AIVehicleObstacle
- AnimatedVehicle
- ArticulatedAxis
- Attachable
- AttacherJointControl
- AttacherJoints
- AutoLoader
- BaleGrab
- BaleLoader
- Baler
- BaleWrapper
- BaseMaterial
- BigBag
- BunkerSiloCompacter
- BunkerSiloInteractor
- CCTDrivable
- Combine
- ConnectionHoses
- ConveyorBelt
- Cover
- CrabSteering
- Crawlers
- CropSensor
- Cultivator
- Cutter
- Cylindered
- CylinderedFoldable
- Dashboard
- Dischargeable
- Drivable
- DynamicallyLoadedParts
- DynamicMountAttacher
- Enterable
- ExtendedAIVehicle
- ExtendedCombine
- ExtendedMotorized
- ExtendedMower
- ExtendedSowingMachine
- ExtendedSprayer
- ExtendedWearable
- FertilizingCultivator
- FertilizingSowingMachine
- FillTriggerVehicle
- FillUnit
- FillVolume
- Foldable
- FoliageBending
- ForageWagon
- FrontloaderAttacher
- FruitPreparer
- GroundAdjustedNodes
- GroundReference
- HeadlandAnimation
- Honk
- HookLiftContainer
- HookLiftTrailer
- IKChains
- InlineWrapper
- JigglingParts
- Leveler
- LicensePlates
- Lights
- LivestockTrailer
- Locomotive
- LogGrab
- ManureBarrel
- ManureSensor
- MixerWagon
- Motorized
- Mountable
- Mower
- Mulcher
- MultipleItemPurchase
- Pallet
- Pickup
- Pipe
- PlaceableAI
- PlaceableAnimatedObjects
- PlaceableBeehive
- PlaceableBeehivePalletSpa...
- PlaceableBunkerSilo
- PlaceableBuyingStation
- PlaceableCartridgePlayer
- PlaceableChargingStation
- PlaceableClearAreas
- PlaceableColorable
- PlaceableDeletedNodes
- PlaceableDoghouse
- PlaceableDynamicallyLoade...
- PlaceableFarmhouse
- PlaceableFence
- PlaceableFoliageAreas
- PlaceableGreenhouse
- PlaceableHighPressureWash...
- PlaceableHotspots
- PlaceableHusbandry
- PlaceableHusbandryAnimals
- PlaceableHusbandryFeeding...
- PlaceableHusbandryFence
- PlaceableHusbandryFood
- PlaceableHusbandryLiquidM...
- PlaceableHusbandryMilk
- PlaceableHusbandryPallets
- PlaceableHusbandryStraw
- PlaceableHusbandryWater
- PlaceableIncomePerHour
- PlaceableIndoorAreas
- PlaceableInfoTrigger
- PlaceableLeveling
- PlaceableLights
- PlaceableManureHeap
- PlaceablePlacement
- PlaceableProductionPoint
- PlaceableSellingStation
- PlaceableSilo
- PlaceableSiloExtension
- PlaceableSolarPanels
- PlaceableTipOcclusionArea...
- PlaceableTrainSystem
- PlaceableTriggerMarkers
- PlaceableVine
- PlaceableWardrobe
- PlaceableWeatherStation
- PlaceableWeighingStation
- PlaceableWindTurbine
- PlaceableWorkshop
- Plow
- PlowPacker
- PowerConsumer
- PowerTakeOffs
- PrecisionFarmingStatistic
- PushHandTool
- RandomlyMovingParts
- ReceivingHopper
- ReverseDriving
- Rideable
- RidgeMarker
- Roller
- Ropes
- RTKStation
- SaltSpreader
- SemiTrailerFront
- Shovel
- SlopeCompensation
- SmartAttach
- SoilSampler
- SowingMachine
- SpeedRotatingParts
- SplineVehicle
- Sprayer
- StonePicker
- StrawBlower
- StumpCutter
- SupportVehicle
- Suspensions
- Tedder
- TensionBeltObject
- TensionBelts
- TestAreas
- TipOccluder
- Trailer
- TreePlanter
- TreeSaplingPallet
- TreeSaw
- TurnOnVehicle
- VariableWorkWidth
- VehicleSettings
- VineCutter
- VineDetector
- VinePrepruner
- Washable
- WaterTrailer
- Wearable
- Weeder
- WeedSpotSpray
- Wheels
- WindBending
- Windrower
- Wipers
- WoodCrusher
- WoodHarvester
- WorkArea
- WorkMode
- WorkParticles
- StateMachine
- Statistics
- Tasks
- Triggers
- Utils
- Vehicles
Engine v1_7_1_0
- AI
- Animation
- Camera
- Entity
- Fillplanes
- general
- General
- I3D
- Input
- Lighting
- Math
- Network
- Node
- NoteNode
- Overlays
- Particle System
- Physics
- Rendering
- Scenegraph
- Shape
- Sound
- Spline
- String
- Terrain Detail
- Text Rendering
- Tire Track
- VoiceChat
- XML
Foundation Reference
SaltSpreader
DescriptionSpecialization for road salt spreadersFunctions
- doCheckSpeedLimit
- getAreControlledActionsAllowed
- getCanBeTurnedOn
- getDefaultSpeedLimit
- getDirtMultiplier
- getTurnedOnNotAllowedWarning
- getVariableWorkWidthUsage
- getWearMultiplier
- initSpecialization
- onDelete
- onLoad
- onTurnedOff
- onTurnedOn
- onUpdateTick
- prerequisitesPresent
- processSaltSpreaderArea
- registerEventListeners
- registerFunctions
- registerOverwrittenFunctions
doCheckSpeedLimit
DescriptionReturns if speed limit should be checkedDefinition
doCheckSpeedLimit()Return Values
boolean | checkSpeedlimit | check speed limit |
149 | function SaltSpreader:doCheckSpeedLimit(superFunc) |
150 | return superFunc(self) or self:getIsTurnedOn() |
151 | end |
getAreControlledActionsAllowed
DescriptionReturns if controlled actions are allowedDefinition
getAreControlledActionsAllowed()Return Values
boolean | allow | allow controlled actions |
string | warning | not allowed warning |
177 | function SaltSpreader:getAreControlledActionsAllowed(superFunc) |
178 | local spec = self.spec_saltSpreader |
179 | |
180 | if self:getFillUnitFillLevel(spec.fillUnitIndex) <= 0 then |
181 | return false, spec.fillToolWarning |
182 | end |
183 | |
184 | return superFunc(self) |
185 | end |
getCanBeTurnedOn
DescriptionDefinitiongetCanBeTurnedOn()Code
189 | function SaltSpreader:getCanBeTurnedOn(superFunc) |
190 | local spec = self.spec_saltSpreader |
191 | if self:getFillUnitFillLevel(spec.fillUnitIndex) <= 0 then |
192 | return false |
193 | end |
194 | |
195 | return superFunc(self) |
196 | end |
getDefaultSpeedLimit
DescriptionReturns default speed limitDefinition
getDefaultSpeedLimit()Return Values
float | speedLimit | speed limit |
234 | function SaltSpreader.getDefaultSpeedLimit() |
235 | return 20 |
236 | end |
getDirtMultiplier
DescriptionDefinitiongetDirtMultiplier()Code
155 | function SaltSpreader:getDirtMultiplier(superFunc) |
156 | if self:getIsTurnedOn() then |
157 | return superFunc(self) + self:getWorkDirtMultiplier() |
158 | end |
159 | |
160 | return superFunc(self) |
161 | end |
getTurnedOnNotAllowedWarning
DescriptionDefinitiongetTurnedOnNotAllowedWarning()Code
200 | function SaltSpreader:getTurnedOnNotAllowedWarning(superFunc) |
201 | local spec = self.spec_saltSpreader |
202 | if self:getFillUnitFillLevel(spec.fillUnitIndex) <= 0 then |
203 | return spec.fillToolWarning |
204 | end |
205 | |
206 | return superFunc(self) |
207 | end |
getVariableWorkWidthUsage
DescriptionReturns the current usage for variable work width (nil if usage should not be displayed)Definition
getVariableWorkWidthUsage()Return Values
float | usage | usage |
212 | function SaltSpreader:getVariableWorkWidthUsage(superFunc) |
213 | local usage = superFunc(self) |
214 | if usage == nil then |
215 | if self:getIsTurnedOn() then |
216 | local spec = self.spec_saltSpreader |
217 | local usageMultiplier = 1 |
218 | if spec.usageWorkArea ~= nil then |
219 | usageMultiplier = self:getWorkAreaWidth(spec.usageWorkArea) |
220 | end |
221 | |
222 | return spec.usage * usageMultiplier * 1000 * 60 |
223 | end |
224 | |
225 | return 0 |
226 | end |
227 | |
228 | return usage |
229 | end |
getWearMultiplier
DescriptionDefinitiongetWearMultiplier()Code
165 | function SaltSpreader:getWearMultiplier(superFunc) |
166 | if self:getIsTurnedOn() then |
167 | return superFunc(self) + self:getWorkWearMultiplier() |
168 | end |
169 | |
170 | return superFunc(self) |
171 | end |
initSpecialization
DescriptionCalled on specialization initializingDefinition
initSpecialization()Code
15 | function SaltSpreader.initSpecialization() |
16 | g_workAreaTypeManager:addWorkAreaType("saltSpreader", false) |
17 | |
18 | local schema = Vehicle.xmlSchema |
19 | schema:setXMLSpecializationType("SaltSpreader") |
20 | |
21 | schema:register(XMLValueType.INT, "vehicle.saltSpreader#fillUnitIndex", "Fill unit index", 1) |
22 | schema:register(XMLValueType.INT, "vehicle.saltSpreader#unloadInfoIndex", "Unload info index", 1) |
23 | schema:register(XMLValueType.INT, "vehicle.saltSpreader#usageWorkArea", "Width of this work area is used as multiplier for usage") |
24 | schema:register(XMLValueType.FLOAT, "vehicle.saltSpreader#usage", "Salt usage in liter per second", 1) |
25 | |
26 | EffectManager.registerEffectXMLPaths(schema, "vehicle.saltSpreader.effects") |
27 | |
28 | schema:setXMLSpecializationType() |
29 | end |
onDelete
DescriptionCalled on deletingDefinition
onDelete()Code
92 | function SaltSpreader:onDelete() |
93 | local spec = self.spec_saltSpreader |
94 | g_effectManager:deleteEffects(spec.effects) |
95 | end |
onLoad
DescriptionCalled on loadingDefinition
onLoad(table savegame)Arguments
table | savegame | savegame |
70 | function SaltSpreader:onLoad(savegame) |
71 | local spec = self.spec_saltSpreader |
72 | |
73 | spec.fillUnitIndex = self.xmlFile:getValue("vehicle.saltSpreader#fillUnitIndex", 1) |
74 | spec.unloadInfoIndex = self.xmlFile:getValue("vehicle.saltSpreader#unloadInfoIndex", 1) |
75 | spec.usageWorkArea = self.xmlFile:getValue("vehicle.saltSpreader#usageWorkArea") |
76 | spec.usage = self.xmlFile:getValue("vehicle.saltSpreader#usage", 1) / 1000 |
77 | |
78 | if self.isClient then |
79 | spec.effects = g_effectManager:loadEffect(self.xmlFile, "vehicle.saltSpreader.effects", self.components, self, self.i3dMappings) |
80 | end |
81 | |
82 | spec.fillToolWarning = g_i18n:getText("info_firstFillTheTool") |
83 | spec.snowSystem = g_currentMission.snowSystem |
84 | |
85 | if not self.isServer then |
86 | SpecializationUtil.removeEventListener(self, "onUpdateTick", SaltSpreader) |
87 | end |
88 | end |
onTurnedOff
DescriptionCalled on turn offDefinition
onTurnedOff(boolean noEventSend)Arguments
boolean | noEventSend | no event send |
139 | function SaltSpreader:onTurnedOff() |
140 | if self.isClient then |
141 | local spec = self.spec_saltSpreader |
142 | g_effectManager:stopEffects(spec.effects) |
143 | end |
144 | end |
onTurnedOn
DescriptionCalled on turn onDefinition
onTurnedOn(boolean noEventSend)Arguments
boolean | noEventSend | no event send |
125 | function SaltSpreader:onTurnedOn() |
126 | if self.isClient then |
127 | local spec = self.spec_saltSpreader |
128 | local fillTypeIndex = self:getFillUnitFillType(spec.fillUnitIndex) |
129 | if fillTypeIndex ~= FillType.UNKNOWN then |
130 | g_effectManager:setFillType(spec.effects, fillTypeIndex) |
131 | g_effectManager:startEffects(spec.effects) |
132 | end |
133 | end |
134 | end |
onUpdateTick
DescriptionCalled on updateDefinition
onUpdateTick(float dt, boolean isActiveForInput, boolean isSelected)Arguments
float | dt | time since last call in ms |
boolean | isActiveForInput | true if vehicle is active for input |
boolean | isSelected | true if vehicle is selected |
102 | function SaltSpreader:onUpdateTick(dt, isActiveForInput, isActiveForInputIgnoreSelection, isSelected) |
103 | if self:getIsTurnedOn() then |
104 | local spec = self.spec_saltSpreader |
105 | |
106 | local fillLevel = self:getFillUnitFillLevel(spec.fillUnitIndex) |
107 | if fillLevel > 0 then |
108 | local usageMultiplier = 1 |
109 | if spec.usageWorkArea ~= nil then |
110 | usageMultiplier = self:getWorkAreaWidth(spec.usageWorkArea) |
111 | end |
112 | |
113 | local usage = spec.usage * dt * usageMultiplier |
114 | local unloadInfo = self:getFillVolumeUnloadInfo(spec.unloadInfoIndex) |
115 | self:addFillUnitFillLevel(self:getOwnerFarmId(), spec.fillUnitIndex, -usage, self:getFillUnitFillType(spec.fillUnitIndex), ToolType.UNDEFINED, unloadInfo) |
116 | else |
117 | self:setIsTurnedOn(false) |
118 | end |
119 | end |
120 | end |
prerequisitesPresent
DescriptionChecks if all prerequisite specializations are loadedDefinition
prerequisitesPresent(table specializations)Arguments
table | specializations | specializations |
boolean | hasPrerequisite | true if all prerequisite specializations are loaded |
35 | function SaltSpreader.prerequisitesPresent(specializations) |
36 | return SpecializationUtil.hasSpecialization(WorkArea, specializations) and SpecializationUtil.hasSpecialization(TurnOnVehicle, specializations) |
37 | end |
processSaltSpreaderArea
DescriptionDefinitionprocessSaltSpreaderArea()Code
240 | function SaltSpreader:processSaltSpreaderArea(workArea) |
241 | if self.isServer then |
242 | local xs, _, zs = getWorldTranslation(workArea.start) |
243 | local xw, _, zw = getWorldTranslation(workArea.width) |
244 | local xh, _, zh = getWorldTranslation(workArea.height) |
245 | |
246 | return self.spec_saltSpreader.snowSystem:saltArea(xs, zs, xw, zw, xh, zh) |
247 | end |
248 | return 0, 0 |
249 | end |
registerEventListeners
DescriptionDefinitionregisterEventListeners()Code
59 | function SaltSpreader.registerEventListeners(vehicleType) |
60 | SpecializationUtil.registerEventListener(vehicleType, "onLoad", SaltSpreader) |
61 | SpecializationUtil.registerEventListener(vehicleType, "onDelete", SaltSpreader) |
62 | SpecializationUtil.registerEventListener(vehicleType, "onUpdateTick", SaltSpreader) |
63 | SpecializationUtil.registerEventListener(vehicleType, "onTurnedOn", SaltSpreader) |
64 | SpecializationUtil.registerEventListener(vehicleType, "onTurnedOff", SaltSpreader) |
65 | end |
registerFunctions
DescriptionDefinitionregisterFunctions()Code
41 | function SaltSpreader.registerFunctions(vehicleType) |
42 | SpecializationUtil.registerFunction(vehicleType, "processSaltSpreaderArea", SaltSpreader.processSaltSpreaderArea) |
43 | end |
registerOverwrittenFunctions
DescriptionDefinitionregisterOverwrittenFunctions()Code
47 | function SaltSpreader.registerOverwrittenFunctions(vehicleType) |
48 | SpecializationUtil.registerOverwrittenFunction(vehicleType, "doCheckSpeedLimit", SaltSpreader.doCheckSpeedLimit) |
49 | SpecializationUtil.registerOverwrittenFunction(vehicleType, "getDirtMultiplier", SaltSpreader.getDirtMultiplier) |
50 | SpecializationUtil.registerOverwrittenFunction(vehicleType, "getWearMultiplier", SaltSpreader.getWearMultiplier) |
51 | SpecializationUtil.registerOverwrittenFunction(vehicleType, "getAreControlledActionsAllowed", SaltSpreader.getAreControlledActionsAllowed) |
52 | SpecializationUtil.registerOverwrittenFunction(vehicleType, "getCanBeTurnedOn", SaltSpreader.getCanBeTurnedOn) |
53 | SpecializationUtil.registerOverwrittenFunction(vehicleType, "getTurnedOnNotAllowedWarning", SaltSpreader.getTurnedOnNotAllowedWarning) |
54 | SpecializationUtil.registerOverwrittenFunction(vehicleType, "getVariableWorkWidthUsage", SaltSpreader.getVariableWorkWidthUsage) |
55 | end |