Script v1.4.4.0
- Handtools
- Events
- Objects
- Placeables
- Triggers
- Utils
- Vehicles
- Specializations
- AIVehicle
- AnimatedVehicle
- ArticulatedAxis
- Attachable
- AttacherJointControl
- AttacherJoints
- BaleGrab
- BaleLoader
- Baler
- BaleWrapper
- BuiltInCutterTrailer
- BunkerSiloCompacter
- Combine
- ConveyorBelt
- Cover
- CrabSteering
- Crawler
- Cultivator
- Cutter
- Cylindered
- Drivable
- DynamicMountAttacher
- Fillable
- FillActivatable
- FillVolume
- Foldable
- ForageWagon
- FrontloaderAttacher
- FruitPreparer
- FuelTrailer
- Honk
- HookLiftContainer
- HookLiftTrailer
- Leveler
- Lights
- LivestockTrailer
- ManureBarrel
- ManureSpreader
- MixerWagon
- Motorized
- Mountable
- Mower
- NonTabbable
- Overloading
- Pickup
- Pipe
- Plough
- PowerConsumer
- RandomlyMovingParts
- ReceivingHopper
- ReverseDriving
- RidgeMarker
- Roller
- Ropes
- RotorSpreader
- SemiTrailerFront
- Shovel
- SowingMachine
- SpeedRotatingParts
- Sprayer
- Steerable
- StrawBlower
- StumpCutter
- Tedder
- TensionBelts
- Trailer
- TreePlanter
- TreePlanterActivatable
- TreeSaw
- TurnOnVehicle
- Washable
- WaterTrailer
- Weeder
- WheelRotations
- Windrower
- WoodCrusher
- WoodHarvester
- WorkArea
- WorkParticles
Engine v7.0.0.2
- General
- Entity
- Node
- Scenegraph
- Lighting
- Camera
- Shape
- Particle System
- Physics
- Spline
- Animation
- Overlays
- Sound
- Input
- XML
- Network
- Callbacks
- Text Rendering
- Terrain Detail
- Tire Track
- Editor
- Rendering
- String
- Math
- I3D
- Fillplanes
Foundation Reference
FuelTrailer
DescriptionClass for fuel trailersFunctions
- prerequisitesPresent
- load
- delete
- mouseEvent
- readStream
- writeStream
- updateTick
- draw
- setIsFuelFilling
- addFuelFillTrigger
- removeFuelFillTrigger
prerequisitesPresent
DescriptionChecks if all prerequisite specializations are loadedDefinition
prerequisitesPresent(table specializations)Arguments
table | specializations | specializations |
boolean | hasPrerequisite | true if all prerequisite specializations are loaded |
17 | function FuelTrailer.prerequisitesPresent(specializations) |
18 | return not SpecializationUtil.hasSpecialization(Motorized, specializations) and SpecializationUtil.hasSpecialization(Fillable, specializations); |
19 | end; |
load
DescriptionCalled on loadingDefinition
load(table savegame)Arguments
table | savegame | savegame |
24 | function FuelTrailer:load(savegame) |
25 | |
26 | self.setIsFuelFilling = SpecializationUtil.callSpecializationsFunction("setIsFuelFilling"); |
27 | self.addFuelFillTrigger = FuelTrailer.addFuelFillTrigger; |
28 | self.removeFuelFillTrigger = FuelTrailer.removeFuelFillTrigger; |
29 | |
30 | self.fuelTrailerFillActivatable = FuelTrailerFillActivatable:new(self); |
31 | |
32 | self.fuelFillTriggers = {}; |
33 | self.isFuelFilling = false; |
34 | |
35 | self.fuelTrailer = {} |
36 | self.fuelTrailer.fillUnitIndex = 1 |
37 | |
38 | self.fuelFillLitersPerSecond = Utils.getNoNil(getXMLFloat(self.xmlFile, "vehicle.fuelFillLitersPerSecond"), 50); |
39 | |
40 | local gasStationTriggerNode = Utils.indexToObject(self.components, getXMLString(self.xmlFile, "vehicle.gasStationTrigger#index")); |
41 | |
42 | if gasStationTriggerNode ~= nil then |
43 | self.gasStationTrigger = GasStation:new(gasStationTriggerNode, self); |
44 | end; |
45 | |
46 | if self.isClient then |
47 | self.sampleRefuel = SoundUtil.loadSample(self.xmlFile, {}, "vehicle.refuelSound", "$data/maps/sounds/refuel.wav", self.baseDirectory, self.components[1].node); |
48 | end; |
49 | end; |
delete
DescriptionCalled on deletingDefinition
delete()Code
53 | function FuelTrailer:delete() |
54 | for _, trigger in pairs(self.fuelFillTriggers) do |
55 | trigger:onVehicleDeleted(self); |
56 | end |
57 | g_currentMission:removeActivatableObject(self.fuelTrailerFillActivatable); |
58 | if self.gasStationTrigger ~= nil then |
59 | self.gasStationTrigger:delete(); |
60 | self.gasStationTrigger = nil; |
61 | end; |
62 | if self.isClient then |
63 | SoundUtil.deleteSample(self.sampleRefuel); |
64 | end; |
65 | end; |
mouseEvent
DescriptionCalled on mouse eventDefinition
mouseEvent(float posX, float posY, boolean isDown, boolean isUp, integer button)Arguments
float | posX | x position |
float | posY | y position |
boolean | isDown | is mouse button down |
boolean | isUp | is mouse button up |
integer | button | mouse button |
74 | function FuelTrailer:mouseEvent(posX, posY, isDown, isUp, button) |
75 | end; |
readStream
DescriptionCalled on client side on joinDefinition
readStream(integer streamId, integer connection)Arguments
integer | streamId | streamId |
integer | connection | connection |
84 | function FuelTrailer:readStream(streamId, connection) |
85 | local isFuelFilling = streamReadBool(streamId); |
86 | self:setIsFuelFilling(isFuelFilling, true); |
87 | end; |
writeStream
DescriptionCalled on server side on joinDefinition
writeStream(integer streamId, integer connection)Arguments
integer | streamId | streamId |
integer | connection | connection |
93 | function FuelTrailer:writeStream(streamId, connection) |
94 | streamWriteBool(streamId, self.isFuelFilling); |
95 | end; |
updateTick
DescriptionCalled on update tickDefinition
updateTick(float dt)Arguments
float | dt | time since last call in ms |
109 | function FuelTrailer:updateTick(dt) |
110 | |
111 | if self.isServer and self.isFuelFilling then |
112 | local delta = 0; |
113 | if self.fuelFillTrigger ~= nil then |
114 | delta = self.fuelFillLitersPerSecond*dt*0.001; |
115 | delta = self.fuelFillTrigger:fillFuel(self, delta); |
116 | end |
117 | |
118 | if delta <= 0 then |
119 | self:setIsFuelFilling(false); |
120 | end |
121 | end |
122 | end; |
draw
DescriptionCalled on drawDefinition
draw()Code
126 | function FuelTrailer:draw() |
127 | if self.isClient then |
128 | |
129 | if self:getUnitFillLevel(self.fuelTrailer.fillUnitIndex) <= 0 and self:getUnitCapacity(self.fuelTrailer.fillUnitIndex) ~= 0 then |
130 | g_currentMission:addExtraPrintText(g_i18n:getText("info_firstFillTheTool")); |
131 | end; |
132 | end |
133 | end; |
setIsFuelFilling
DescriptionSet is fuel fillingDefinition
setIsFuelFilling(boolean isFilling, boolean noEventSend)Arguments
boolean | isFilling | new is filling state |
boolean | noEventSend | no event send |
139 | function FuelTrailer:setIsFuelFilling(isFilling, noEventSend) |
140 | if isFilling ~= self.isFuelFilling then |
141 | if noEventSend == nil or noEventSend == false then |
142 | if g_server ~= nil then |
143 | g_server:broadcastEvent(SteerableToggleRefuelEvent:new(self, isFilling), nil, nil, self); |
144 | else |
145 | g_client:getServerConnection():sendEvent(SteerableToggleRefuelEvent:new(self, isFilling)); |
146 | end; |
147 | end; |
148 | self.isFuelFilling = isFilling; |
149 | if isFilling then |
150 | -- find the first trigger which is activable |
151 | self.fuelFillTrigger = nil; |
152 | for i=1, table.getn(self.fuelFillTriggers) do |
153 | local trigger = self.fuelFillTriggers[i]; |
154 | if trigger:getIsActivatable(self) then |
155 | self.fuelFillTrigger = trigger; |
156 | break; |
157 | end; |
158 | end; |
159 | end |
160 | if self.isClient and self.sampleRefuel ~= nil then |
161 | if isFilling then |
162 | SoundUtil.play3DSample(self.sampleRefuel); |
163 | else |
164 | SoundUtil.stop3DSample(self.sampleRefuel); |
165 | end; |
166 | end; |
167 | end |
168 | end |
addFuelFillTrigger
DescriptionAdds fuel fill trigger if vehicle enters oneDefinition
addFuelFillTrigger(table trigger)Arguments
table | trigger | trigger |
173 | function FuelTrailer:addFuelFillTrigger(trigger) |
174 | if table.getn(self.fuelFillTriggers) == 0 then |
175 | g_currentMission:addActivatableObject(self.fuelTrailerFillActivatable); |
176 | end; |
177 | table.insert(self.fuelFillTriggers, trigger); |
178 | end; |
removeFuelFillTrigger
DescriptionRemoves fuel fill trigger if vehicle leaves oneDefinition
removeFuelFillTrigger(table trigger)Arguments
table | trigger | trigger |
183 | function FuelTrailer:removeFuelFillTrigger(trigger) |
184 | for i=1, table.getn(self.fuelFillTriggers) do |
185 | if self.fuelFillTriggers[i] == trigger then |
186 | table.remove(self.fuelFillTriggers, i); |
187 | break; |
188 | end; |
189 | end; |
190 | if table.getn(self.fuelFillTriggers) == 0 or trigger == self.fuelFillTrigger then |
191 | if self.isServer then |
192 | self:setIsFuelFilling(false); |
193 | end; |
194 | if table.getn(self.fuelFillTriggers) == 0 then |
195 | g_currentMission:removeActivatableObject(self.fuelTrailerFillActivatable); |
196 | end |
197 | end; |
198 | end; |