LUADOC - Farming Simulator 17

Printable Version

Script v1.4.4.0

Engine v7.0.0.2

Foundation Reference

TrailerToggleTipEvent

Description
Event for toggle trailer tipping
Functions

emptyNew

Description
Create instance of Event class
Definition
emptyNew()
Return Values
tableselfinstance of class event
Code
15function TrailerToggleTipEvent:emptyNew()
16 local self = Event:new(TrailerToggleTipEvent_mt);
17 return self;
18end;

new

Description
Create new instance of event
Definition
new(table object, boolean isStart, table tipTrigger, integer tipReferencePointIndex)
Arguments
tableobjectobject
booleanisStartis start
tabletipTriggertip trigger
integertipReferencePointIndexindex of tip reference point
Code
26function TrailerToggleTipEvent:new(object, isStart, tipTrigger, tipReferencePointIndex)
27 local self = TrailerToggleTipEvent:emptyNew()
28 self.isStart = isStart;
29 self.tipTrigger = tipTrigger;
30 self.tipReferencePointIndex = Utils.getNoNil(tipReferencePointIndex, 1);
31 assert(self.tipReferencePointIndex <= 15);
32 self.object = object;
33 return self;
34end;

readStream

Description
Called on client side on join
Definition
readStream(integer streamId, integer connection)
Arguments
integerstreamIdstreamId
integerconnectionconnection
Code
40function TrailerToggleTipEvent:readStream(streamId, connection)
41 self.object = readNetworkNodeObject(streamId);
42 self.isStart = streamReadBool(streamId);
43 if self.isStart then
44 self.tipTrigger = readNetworkNodeObject(streamId);
45 self.tipReferencePointIndex = streamReadUIntN(streamId, 4);
46 end;
47 self:run(connection);
48end;

writeStream

Description
Called on server side on join
Definition
writeStream(integer streamId, integer connection)
Arguments
integerstreamIdstreamId
integerconnectionconnection
Code
54function TrailerToggleTipEvent:writeStream(streamId, connection)
55 writeNetworkNodeObject(streamId, self.object);
56 streamWriteBool(streamId, self.isStart);
57 if self.isStart then
58 writeNetworkNodeObject(streamId, self.tipTrigger);
59 streamWriteUIntN(streamId, self.tipReferencePointIndex, 4);
60 end;
61end;

run

Description
Run action on receiving side
Definition
run(integer connection)
Arguments
integerconnectionconnection
Code
66function TrailerToggleTipEvent:run(connection)
67 if not connection:getIsServer() then
68 g_server:broadcastEvent(self, false, connection, self.object);
69 end;
70
71 if self.isStart then
72 self.object:onStartTip(self.tipTrigger, self.tipReferencePointIndex, true);
73 else
74 self.object:onEndTip(true);
75 end;
76end;