LUADOC - Farming Simulator 17

Printable Version

CombineStrawEnableEvent

Description
Event for straw enable state
Functions

emptyNew

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

new

Description
Create new instance of event
Definition
new(table vehicle, boolean isStrawEnabled)
Arguments
tablevehiclevehicle
booleanisStrawEnabledis straw enabled
Code
24function CombineStrawEnableEvent:new(vehicle, isStrawEnabled)
25 local self = CombineStrawEnableEvent:emptyNew()
26 self.vehicle = vehicle;
27 self.isStrawEnabled = isStrawEnabled;
28 return self;
29end;

readStream

Description
Called on client side on join
Definition
readStream(integer streamId, integer connection)
Arguments
integerstreamIdstreamId
integerconnectionconnection
Code
35function CombineStrawEnableEvent:readStream(streamId, connection)
36 self.vehicle = readNetworkNodeObject(streamId);
37 self.isStrawEnabled = streamReadBool(streamId);
38 self:run(connection);
39end;

writeStream

Description
Called on server side on join
Definition
writeStream(integer streamId, integer connection)
Arguments
integerstreamIdstreamId
integerconnectionconnection
Code
45function CombineStrawEnableEvent:writeStream(streamId, connection)
46 writeNetworkNodeObject(streamId, self.vehicle);
47 streamWriteBool(streamId, self.isStrawEnabled);
48end;

run

Description
Run action on receiving side
Definition
run(integer connection)
Arguments
integerconnectionconnection
Code
53function CombineStrawEnableEvent:run(connection)
54 self.vehicle:setIsStrawEnabled(self.isStrawEnabled, true);
55 if not connection:getIsServer() then
56 g_server:broadcastEvent(CombineStrawEnableEvent:new(self.vehicle, self.isStrawEnabled), nil, connection, self.vehicle);
57 end;
58end;

sendEvent

Description
Broadcast event from server to all clients, if called on client call function on server and broadcast it to all clients
Definition
sendEvent(table vehicle, boolean isStrawEnabled, boolean noEventSend)
Arguments
tablevehiclevehicle
booleanisStrawEnabledis straw enabled
booleannoEventSendno event send
Code
65function CombineStrawEnableEvent.sendEvent(vehicle, isStrawEnabled, noEventSend)
66 if noEventSend == nil or noEventSend == false then
67 if g_server ~= nil then
68 g_server:broadcastEvent(CombineStrawEnableEvent:new(vehicle, isStrawEnabled), nil, nil, vehicle);
69 else
70 g_client:getServerConnection():sendEvent(CombineStrawEnableEvent:new(vehicle, isStrawEnabled));
71 end;
72 end;
73end;