LUADOC - Farming Simulator 17

Printable Version

Script v1.4.4.0

Engine v7.0.0.2

Foundation Reference

HPWPlaceableStateEvent

Description
Event for hpw state
Functions

emptyNew

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

new

Description
Create new instance of event
Definition
new(table object, boolean doWashing)
Arguments
tableobjectobject
booleandoWashingdo washing
Return Values
tableinstanceinstance of event
Code
25function HPWPlaceableStateEvent:new(object, doWashing)
26 local self = HPWPlaceableStateEvent:emptyNew()
27 self.object = object;
28 self.doWashing = doWashing;
29
30 return self;
31end;

readStream

Description
Called on client side on join
Definition
readStream(integer streamId, integer connection)
Arguments
integerstreamIdstreamId
integerconnectionconnection
Code
37function HPWPlaceableStateEvent:readStream(streamId, connection)
38 self.object = readNetworkNodeObject(streamId);
39 self.doWashing = streamReadBool(streamId);
40 self:run(connection);
41end;

writeStream

Description
Called on server side on join
Definition
writeStream(integer streamId, integer connection)
Arguments
integerstreamIdstreamId
integerconnectionconnection
Code
47function HPWPlaceableStateEvent:writeStream(streamId, connection)
48 writeNetworkNodeObject(streamId, self.object);
49 streamWriteBool(streamId, self.doWashing);
50end;

run

Description
Run action on receiving side
Definition
run(integer connection)
Arguments
integerconnectionconnection
Code
55function HPWPlaceableStateEvent:run(connection)
56 if not connection:getIsServer() then
57 g_server:broadcastEvent(self, false, connection, self.object);
58 end;
59 self.object:setIsWashing(self.doWashing, false, true);
60end;

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 object, boolean doWashing, boolean noEventSend)
Arguments
tableobjectobject
booleandoWashingdo washing
booleannoEventSendno event send
Code
67function HPWPlaceableStateEvent.sendEvent(object, doWashing, noEventSend)
68 if doWashing ~= object.doWashing then
69 if noEventSend == nil or noEventSend == false then
70 if g_server ~= nil then
71 g_server:broadcastEvent(HPWPlaceableStateEvent:new(object, doWashing), nil, nil, object);
72 else
73 g_client:getServerConnection():sendEvent(HPWPlaceableStateEvent:new(object, doWashing));
74 end;
75 end;
76 end;
77end;