LUADOC - Farming Simulator 17

Printable Version

Script v1.4.4.0

Engine v7.0.0.2

Foundation Reference

HPWPlaceableTurnOnEvent

Description
Event for hpw turn on state
Functions

emptyNew

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

new

Description
Create new instance of event
Definition
new(table object, boolean isTurnedOn, table player)
Arguments
tableobjectobject
booleanisTurnedOnis turned on
tableplayerplayer
Return Values
tableinstanceinstance of event
Code
26function HPWPlaceableTurnOnEvent:new(object, isTurnedOn, player)
27 local self = HPWPlaceableTurnOnEvent:emptyNew()
28 self.object = object;
29 self.isTurnedOn = isTurnedOn;
30 self.player = player;
31
32 return self;
33end;

readStream

Description
Called on client side on join
Definition
readStream(integer streamId, integer connection)
Arguments
integerstreamIdstreamId
integerconnectionconnection
Code
39function HPWPlaceableTurnOnEvent:readStream(streamId, connection)
40 self.object = readNetworkNodeObject(streamId);
41 self.isTurnedOn = streamReadBool(streamId);
42 if self.isTurnedOn then
43 self.player = readNetworkNodeObject(streamId);
44 end;
45 self:run(connection);
46end;

writeStream

Description
Called on server side on join
Definition
writeStream(integer streamId, integer connection)
Arguments
integerstreamIdstreamId
integerconnectionconnection
Code
52function HPWPlaceableTurnOnEvent:writeStream(streamId, connection)
53 writeNetworkNodeObject(streamId, self.object);
54 streamWriteBool(streamId, self.isTurnedOn);
55 if self.isTurnedOn then
56 writeNetworkNodeObject(streamId, self.player);
57 end;
58end;

run

Description
Run action on receiving side
Definition
run(integer connection)
Arguments
integerconnectionconnection
Code
63function HPWPlaceableTurnOnEvent:run(connection)
64 if not connection:getIsServer() then
65 g_server:broadcastEvent(self, false, connection, self.object);
66 end;
67 self.object:setIsTurnedOn(self.isTurnedOn, self.player, true);
68end;

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 isTurnedOn, table player, boolean noEventSend)
Arguments
tableobjectobject
booleanisTurnedOnis turned on
tableplayerplayer
booleannoEventSendno event send
Code
76function HPWPlaceableTurnOnEvent.sendEvent(object, isTurnedOn, player, noEventSend)
77 if isTurnedOn ~= object.isTurnedOn then
78 if noEventSend == nil or noEventSend == false then
79 if g_server ~= nil then
80 g_server:broadcastEvent(HPWPlaceableTurnOnEvent:new(object, isTurnedOn, player), nil, nil, object);
81 else
82 g_client:getServerConnection():sendEvent(HPWPlaceableTurnOnEvent:new(object, isTurnedOn, player));
83 end;
84 end;
85 end;
86end;