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
PlaceableAnimatedObjects
DescriptionSpecialization for placeablesFunctions
- loadFromXMLFile
- onDelete
- onLoad
- onPostFinalizePlacement
- onReadStream
- onWriteStream
- prerequisitesPresent
- registerEventListeners
- registerOverwrittenFunctions
- registerSavegameXMLPaths
- registerXMLPaths
- saveToXMLFile
- setOwnerFarmId
loadFromXMLFile
DescriptionDefinitionloadFromXMLFile()Code
165 | function PlaceableAnimatedObjects:loadFromXMLFile(xmlFile, key) |
166 | local spec = self.spec_animatedObjects |
167 | for i, animatedObject in ipairs(spec.animatedObjects) do |
168 | animatedObject:loadFromXMLFile(xmlFile, string.format("%s.animatedObject(%d)", key, i - 1)) |
169 | end |
170 | end |
onDelete
DescriptionDefinitiononDelete()Code
113 | function PlaceableAnimatedObjects:onDelete() |
114 | local spec = self.spec_animatedObjects |
115 | |
116 | if spec.animatedObjects ~= nil then |
117 | for _, animatedObject in ipairs(spec.animatedObjects) do |
118 | animatedObject:delete() |
119 | animatedObject:setOwnerFarmId(self:getOwnerFarmId(), false) |
120 | end |
121 | spec.animatedObjects = nil |
122 | end |
123 | end |
onLoad
DescriptionCalled on loadingDefinition
onLoad(table savegame)Arguments
table | savegame | savegame |
58 | function PlaceableAnimatedObjects:onLoad(savegame) |
59 | local spec = self.spec_animatedObjects |
60 | local xmlFile = self.xmlFile |
61 | |
62 | spec.animatedObjects = {} |
63 | xmlFile:iterate("placeable.animatedObjects.animatedObject", function(index, animationKey) |
64 | local animatedObject = AnimatedObject.new(self.isServer, self.isClient) |
65 | animatedObject.dependencies = {} |
66 | |
67 | xmlFile:iterate(animationKey .. ".dependency", function(_, dependencyKey) |
68 | local dependendIndex = xmlFile:getInt(dependencyKey.."#animatedObjectIndex") |
69 | if dependendIndex ~= nil then |
70 | local minTime = xmlFile:getValue(dependencyKey.."#minTime", 0) |
71 | local maxTime = xmlFile:getValue(dependencyKey.."#maxTime", 0) |
72 | local dependency = {objectIndex=dependendIndex, minTime=minTime, maxTime=maxTime} |
73 | table.insert(animatedObject.dependencies, dependency) |
74 | else |
75 | Logging.xmlError(xmlFile, "Missing animatedObjectIndex for '%s'", dependencyKey) |
76 | end |
77 | end) |
78 | |
79 | if animatedObject:load(self.components, xmlFile, animationKey, self.configFileName, self.i3dMappings) then |
80 | table.insert(spec.animatedObjects, animatedObject) |
81 | else |
82 | Logging.xmlError(xmlFile, "Failed to load animated object %i", index) |
83 | end |
84 | end) |
85 | |
86 | for _, animatedObject in ipairs(spec.animatedObjects) do |
87 | if #animatedObject.dependencies > 0 then |
88 | animatedObject.getCanBeTriggered = Utils.overwrittenFunction(animatedObject.getCanBeTriggered, function(_, superFunc) |
89 | if not superFunc(animatedObject) then |
90 | return false |
91 | end |
92 | |
93 | for _, dependency in ipairs(animatedObject.dependencies) do |
94 | local dependendObject = spec.animatedObjects[dependency.objectIndex] |
95 | if dependendObject ~= nil then |
96 | local t = dependendObject.animation.time |
97 | if t < dependency.minTime or t > dependency.maxTime then |
98 | return false |
99 | end |
100 | else |
101 | Logging.xmlWarning(xmlFile, "Invalid dependency animated object index '%d'", dependency.objectIndex) |
102 | end |
103 | end |
104 | |
105 | return true |
106 | end) |
107 | end |
108 | end |
109 | end |
onPostFinalizePlacement
DescriptionDefinitiononPostFinalizePlacement()Code
127 | function PlaceableAnimatedObjects:onPostFinalizePlacement() |
128 | local spec = self.spec_animatedObjects |
129 | |
130 | for _, animatedObject in ipairs(spec.animatedObjects) do |
131 | animatedObject:register(true) |
132 | end |
133 | end |
onReadStream
DescriptionDefinitiononReadStream()Code
137 | function PlaceableAnimatedObjects:onReadStream(streamId, connection) |
138 | if connection:getIsServer() then |
139 | local spec = self.spec_animatedObjects |
140 | for _, animatedObject in ipairs(spec.animatedObjects) do |
141 | local animatedObjectId = NetworkUtil.readNodeObjectId(streamId) |
142 | animatedObject:readStream(streamId, connection) |
143 | g_client:finishRegisterObject(animatedObject, animatedObjectId) |
144 | end |
145 | end |
146 | end |
onWriteStream
DescriptionCalled on server side when placeable was fully loaded on client sideDefinition
onWriteStream(integer streamId, table connection)Arguments
integer | streamId | stream ID |
table | connection | connection |
152 | function PlaceableAnimatedObjects:onWriteStream(streamId, connection) |
153 | if not connection:getIsServer() then |
154 | local spec = self.spec_animatedObjects |
155 | for _, animatedObject in ipairs(spec.animatedObjects) do |
156 | NetworkUtil.writeNodeObjectId(streamId, NetworkUtil.getObjectId(animatedObject)) |
157 | animatedObject:writeStream(streamId, connection) |
158 | g_server:registerObjectInStream(connection, animatedObject) |
159 | end |
160 | end |
161 | 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 |
18 | function PlaceableAnimatedObjects.prerequisitesPresent(specializations) |
19 | return true |
20 | end |
registerEventListeners
DescriptionDefinitionregisterEventListeners()Code
30 | function PlaceableAnimatedObjects.registerEventListeners(placeableType) |
31 | SpecializationUtil.registerEventListener(placeableType, "onLoad", PlaceableAnimatedObjects) |
32 | SpecializationUtil.registerEventListener(placeableType, "onDelete", PlaceableAnimatedObjects) |
33 | SpecializationUtil.registerEventListener(placeableType, "onReadStream", PlaceableAnimatedObjects) |
34 | SpecializationUtil.registerEventListener(placeableType, "onWriteStream", PlaceableAnimatedObjects) |
35 | SpecializationUtil.registerEventListener(placeableType, "onPostFinalizePlacement", PlaceableAnimatedObjects) |
36 | end |
registerOverwrittenFunctions
DescriptionDefinitionregisterOverwrittenFunctions()Code
24 | function PlaceableAnimatedObjects.registerOverwrittenFunctions(placeableType) |
25 | SpecializationUtil.registerOverwrittenFunction(placeableType, "setOwnerFarmId", PlaceableAnimatedObjects.setOwnerFarmId) |
26 | end |
registerSavegameXMLPaths
DescriptionDefinitionregisterSavegameXMLPaths()Code
51 | function PlaceableAnimatedObjects.registerSavegameXMLPaths(schema, basePath) |
52 | AnimatedObject.registerSavegameXMLPaths(schema, basePath .. ".animatedObject(?)") |
53 | end |
registerXMLPaths
DescriptionDefinitionregisterXMLPaths()Code
40 | function PlaceableAnimatedObjects.registerXMLPaths(schema, basePath) |
41 | schema:setXMLSpecializationType("AnimatedObjects") |
42 | AnimatedObject.registerXMLPaths(schema, basePath .. ".animatedObjects") |
43 | schema:register(XMLValueType.INT, basePath .. ".animatedObjects.animatedObject(?).dependency(?)#animatedObjectIndex", "Animated object index") |
44 | schema:register(XMLValueType.FLOAT, basePath .. ".animatedObjects.animatedObject(?).dependency(?)#minTime", "Min Time") |
45 | schema:register(XMLValueType.FLOAT, basePath .. ".animatedObjects.animatedObject(?).dependency(?)#maxTime", "Max Time") |
46 | schema:setXMLSpecializationType() |
47 | end |
saveToXMLFile
DescriptionDefinitionsaveToXMLFile()Code
174 | function PlaceableAnimatedObjects:saveToXMLFile(xmlFile, key, usedModNames) |
175 | local spec = self.spec_animatedObjects |
176 | |
177 | for i, animatedObject in ipairs(spec.animatedObjects) do |
178 | animatedObject:saveToXMLFile(xmlFile, string.format("%s.animatedObject(%d)", key, i - 1), usedModNames) |
179 | end |
180 | end |
setOwnerFarmId
DescriptionDefinitionsetOwnerFarmId()Code
184 | function PlaceableAnimatedObjects:setOwnerFarmId(superFunc, ownerFarmId, noEventSend) |
185 | superFunc(self, ownerFarmId, noEventSend) |
186 | |
187 | local spec = self.spec_animatedObjects |
188 | |
189 | if spec.animatedObjects ~= nil then |
190 | for _, animatedObject in ipairs(spec.animatedObjects) do |
191 | animatedObject:setOwnerFarmId(ownerFarmId, true) |
192 | end |
193 | end |
194 | end |