LUADOC - Farming Simulator 17

Printable Version

ReceivingTipTrigger

Description
Class for receiving tip triggers
Parent
TipTrigger
Functions

new

Description
Creating receiving tip trigger
Definition
new(boolean isServer, boolean isClient, table customMt)
Arguments
booleanisServeris server
booleanisClientis client
tablecustomMtcustom metatable
Return Values
tableinstanceInstance of object
Code
18function ReceivingTipTrigger:new(isServer, isClient, customMt)
19 if customMt == nil then
20 customMt = ReceivingTipTrigger_mt;
21 end
22 local self = TipTrigger:new(isServer, isClient, customMt);
23 return self;
24end;

load

Description
Loading receiving tip trigger
Definition
load(integer id, table owner)
Arguments
integeridnode id
tableownerowner of tip trigger
Return Values
booleanisSuccessfullis successfull
Code
31function ReceivingTipTrigger:load(id, owner)
32 local isSuccessfull = ReceivingTipTrigger:superClass().load(self, id);
33 self.owner = owner;
34
35 return isSuccessfull;
36end;

delete

Description
Delete receiving tip trigger
Definition
delete()
Code
40function ReceivingTipTrigger:delete()
41 ReceivingTipTrigger:superClass().delete(self);
42end;

addFillLevelFromTool

Description
Add fill level from tool to trigger owner
Definition
addFillLevelFromTool(table trailer, float fillDelta, integer fillType, integer toolType)
Arguments
tabletrailertrailer
floatfillDeltadelta to fill
integerfillTypefill type index
integertoolTypetool type index
Return Values
floatfillDeltareal fill delta
Code
67function ReceivingTipTrigger:addFillLevelFromTool(trailer, fillDelta, fillType, toolType)
68 if fillDelta > 0 then
69
70 local capacity = self.owner:getUnitCapacity(self.owner.receivingHopper.fillUnitIndex);
71 local fillLevel = self.owner:getUnitFillLevel(self.owner.receivingHopper.fillUnitIndex);
72 local delta = math.min(fillDelta, capacity - fillLevel);
73
74 if delta <= 0 then
75 trailer:onEndTip(true);
76 else
77 self.owner:setUnitFillLevel(self.owner.receivingHopper.fillUnitIndex, fillLevel + delta, fillType);
78 end
79
80 return delta;
81 end
82end