LUADOC - Farming Simulator 17

Printable Version

Script v1.4.4.0

Engine v7.0.0.2

Foundation Reference

WoodHarvesterCutTreeEvent

Description
Event for cut tree
Functions

emptyNew

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

new

Description
Create new instance of event
Definition
new(table object, float length)
Arguments
tableobjectobject
floatlengthlength
Code
24function WoodHarvesterCutTreeEvent:new(object, length)
25 local self = WoodHarvesterCutTreeEvent:emptyNew()
26 self.object = object;
27 self.length = length;
28 return self;
29end;

readStream

Description
Called on client side on join
Definition
readStream(integer streamId, integer connection)
Arguments
integerstreamIdstreamId
integerconnectionconnection
Code
35function WoodHarvesterCutTreeEvent:readStream(streamId, connection)
36 self.object = readNetworkNodeObject(streamId);
37 self.length = streamReadFloat32(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 WoodHarvesterCutTreeEvent:writeStream(streamId, connection)
46 writeNetworkNodeObject(streamId, self.object);
47 streamWriteFloat32(streamId, self.length);
48end;

run

Description
Run action on receiving side
Definition
run(integer connection)
Arguments
integerconnectionconnection
Code
53function WoodHarvesterCutTreeEvent:run(connection)
54 if not connection:getIsServer() then
55 g_server:broadcastEvent(WoodHarvesterCutTreeEvent:new(self.object, self.length), nil, connection, self.object);
56 end;
57 self.object:cutTree(self.length, true);
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 object, float length, boolean noEventSend)
Arguments
tableobjectobject
floatlengthlength
booleannoEventSendno event send
Code
65function WoodHarvesterCutTreeEvent.sendEvent(object, length, noEventSend)
66 if noEventSend == nil or noEventSend == false then
67 if g_server ~= nil then
68 g_server:broadcastEvent(WoodHarvesterCutTreeEvent:new(object, length), nil, nil, object);
69 else
70 g_client:getServerConnection():sendEvent(WoodHarvesterCutTreeEvent:new(object, length));
71 end;
72 end;
73end;