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
BunkerSiloCompacter
DescriptionSpecialization for increasing bunker silo compaction level and playing samples during the processFunctions
- doCheckSpeedLimit
- getBunkerSiloCompacterScale
- getDefaultSpeedLimit
- initSpecialization
- loadBunkerSiloCompactorFromXML
- onDelete
- onLoad
- onUpdate
- prerequisitesPresent
- registerEventListeners
- registerFunctions
- registerOverwrittenFunctions
doCheckSpeedLimit
DescriptionReturns if speed limit should be checkedDefinition
doCheckSpeedLimit()Return Values
| boolean | checkSpeedlimit | check speed limit |
| 153 | function BunkerSiloCompacter:doCheckSpeedLimit(superFunc) |
| 154 | local spec = self.spec_bunkerSiloCompacter |
| 155 | if spec.useSpeedLimit then |
| 156 | return superFunc(self) or spec.lastIsCompacting |
| 157 | end |
| 158 | |
| 159 | return superFunc(self) |
| 160 | end |
getBunkerSiloCompacterScale
DescriptionDefinitiongetBunkerSiloCompacterScale()Code
| 94 | function BunkerSiloCompacter:getBunkerSiloCompacterScale() |
| 95 | return self.spec_bunkerSiloCompacter.scale |
| 96 | end |
getDefaultSpeedLimit
DescriptionReturns default speed limitDefinition
getDefaultSpeedLimit()Return Values
| float | speedLimit | speed limit |
| 165 | function BunkerSiloCompacter.getDefaultSpeedLimit() |
| 166 | return 5 |
| 167 | end |
initSpecialization
DescriptionDefinitioninitSpecialization()Code
| 23 | function BunkerSiloCompacter.initSpecialization() |
| 24 | local schema = Vehicle.xmlSchema |
| 25 | schema:setXMLSpecializationType("BunkerSiloCompacter") |
| 26 | |
| 27 | schema:register(XMLValueType.FLOAT, BunkerSiloCompacter.XML_PATH .. "#compactingScale", "Compacting scale", 1) |
| 28 | schema:register(XMLValueType.BOOL, BunkerSiloCompacter.XML_PATH .. "#useSpeedLimit", "Defines if speed limit is used while compactor has contact with ground", false) |
| 29 | |
| 30 | SoundManager.registerSampleXMLPaths(schema, BunkerSiloCompacter.XML_PATH .. ".sounds", "rolling") |
| 31 | SoundManager.registerSampleXMLPaths(schema, BunkerSiloCompacter.XML_PATH .. ".sounds", "compacting") |
| 32 | |
| 33 | schema:setXMLSpecializationType() |
| 34 | end |
loadBunkerSiloCompactorFromXML
DescriptionDefinitionloadBunkerSiloCompactorFromXML()Code
| 86 | function BunkerSiloCompacter:loadBunkerSiloCompactorFromXML(xmlFile, key) |
| 87 | local spec = self.spec_bunkerSiloCompacter |
| 88 | spec.scale = xmlFile:getValue(key .. "#compactingScale", 1) |
| 89 | spec.useSpeedLimit = xmlFile:getValue(key .. "#useSpeedLimit", false) |
| 90 | end |
onDelete
DescriptionDefinitiononDelete()Code
| 79 | function BunkerSiloCompacter:onDelete() |
| 80 | local spec = self.spec_bunkerSiloCompacter |
| 81 | g_soundManager:deleteSamples(spec.samples) |
| 82 | end |
onLoad
DescriptionDefinitiononLoad()Code
| 59 | function BunkerSiloCompacter:onLoad(savegame) |
| 60 | local spec = self.spec_bunkerSiloCompacter |
| 61 | |
| 62 | self:loadBunkerSiloCompactorFromXML(self.xmlFile, BunkerSiloCompacter.XML_PATH) |
| 63 | |
| 64 | if self.isClient then |
| 65 | spec.samples = {} |
| 66 | spec.samples.rolling = g_soundManager:loadSampleFromXML(self.xmlFile, BunkerSiloCompacter.XML_PATH .. ".sounds", "rolling", self.baseDirectory, self.components, 0, AudioGroup.VEHICLE, self.i3dMappings, self) |
| 67 | spec.samples.compacting = g_soundManager:loadSampleFromXML(self.xmlFile, BunkerSiloCompacter.XML_PATH .. ".sounds", "compacting", self.baseDirectory, self.components, 0, AudioGroup.VEHICLE, self.i3dMappings, self) |
| 68 | spec.lastIsCompacting = false |
| 69 | spec.lastHasGroundContact = false |
| 70 | end |
| 71 | |
| 72 | if self.getWheels == nil then |
| 73 | SpecializationUtil.removeEventListener(self, "onUpdate", BunkerSiloCompacter) |
| 74 | end |
| 75 | end |
onUpdate
DescriptionCalled on updateDefinition
onUpdate(float dt, boolean isActive, boolean isActiveForInput, boolean isSelected)Arguments
| float | dt | time since last call in ms |
| boolean | isActive | true if vehicle is active |
| boolean | isActiveForInput | true if vehicle is active for input |
| boolean | isSelected | true if vehicle is selected |
| 104 | function BunkerSiloCompacter:onUpdate(dt, isActiveForInput, isActiveForInputIgnoreSelection, isSelected) |
| 105 | local spec = self.spec_bunkerSiloCompacter |
| 106 | local hasGroundContact = false |
| 107 | local isCompacting = false |
| 108 | |
| 109 | local wheels = self:getWheels() |
| 110 | for i=1, #wheels do |
| 111 | local wheel = wheels[i] |
| 112 | if wheel.contact ~= Wheels.WHEEL_NO_CONTACT then |
| 113 | hasGroundContact = true |
| 114 | if wheel.contact == Wheels.WHEEL_GROUND_HEIGHT_CONTACT then |
| 115 | isCompacting = true |
| 116 | break |
| 117 | end |
| 118 | end |
| 119 | end |
| 120 | |
| 121 | if spec.lastHasGroundContact ~= hasGroundContact or spec.lastIsCompacting ~= isCompacting then |
| 122 | if hasGroundContact then |
| 123 | if isCompacting then |
| 124 | if not g_soundManager:getIsSamplePlaying(spec.samples.compacting) then |
| 125 | g_soundManager:playSample(spec.samples.compacting) |
| 126 | end |
| 127 | else |
| 128 | if g_soundManager:getIsSamplePlaying(spec.samples.compacting) then |
| 129 | g_soundManager:stopSample(spec.samples.compacting) |
| 130 | end |
| 131 | end |
| 132 | |
| 133 | if not g_soundManager:getIsSamplePlaying(spec.samples.rolling) then |
| 134 | g_soundManager:playSample(spec.samples.rolling) |
| 135 | end |
| 136 | else |
| 137 | if g_soundManager:getIsSamplePlaying(spec.samples.compacting) then |
| 138 | g_soundManager:stopSample(spec.samples.compacting) |
| 139 | end |
| 140 | if g_soundManager:getIsSamplePlaying(spec.samples.rolling) then |
| 141 | g_soundManager:stopSample(spec.samples.rolling) |
| 142 | end |
| 143 | end |
| 144 | |
| 145 | spec.lastHasGroundContact = hasGroundContact |
| 146 | spec.lastIsCompacting = isCompacting |
| 147 | end |
| 148 | end |
prerequisitesPresent
DescriptionDefinitionprerequisitesPresent()Code
| 17 | function BunkerSiloCompacter.prerequisitesPresent(specializations) |
| 18 | return true |
| 19 | end |
registerEventListeners
DescriptionDefinitionregisterEventListeners()Code
| 51 | function BunkerSiloCompacter.registerEventListeners(vehicleType) |
| 52 | SpecializationUtil.registerEventListener(vehicleType, "onLoad", BunkerSiloCompacter) |
| 53 | SpecializationUtil.registerEventListener(vehicleType, "onUpdate", BunkerSiloCompacter) |
| 54 | SpecializationUtil.registerEventListener(vehicleType, "onDelete", BunkerSiloCompacter) |
| 55 | end |
registerFunctions
DescriptionDefinitionregisterFunctions()Code
| 38 | function BunkerSiloCompacter.registerFunctions(vehicleType) |
| 39 | SpecializationUtil.registerFunction(vehicleType, "loadBunkerSiloCompactorFromXML", BunkerSiloCompacter.loadBunkerSiloCompactorFromXML) |
| 40 | SpecializationUtil.registerFunction(vehicleType, "getBunkerSiloCompacterScale", BunkerSiloCompacter.getBunkerSiloCompacterScale) |
| 41 | end |
registerOverwrittenFunctions
DescriptionDefinitionregisterOverwrittenFunctions()Code
| 45 | function BunkerSiloCompacter.registerOverwrittenFunctions(vehicleType) |
| 46 | SpecializationUtil.registerOverwrittenFunction(vehicleType, "doCheckSpeedLimit", BunkerSiloCompacter.doCheckSpeedLimit) |
| 47 | end |