LUADOC - Farming Simulator 17

Printable Version

Script v1.4.4.0

Engine v7.0.0.2

Foundation Reference

PlantLimitToFieldEvent

Description
Event for limit to field state
Functions

emptyNew

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

new

Description
Create new instance of event
Definition
new(table object, boolean plantLimitToField)
Arguments
tableobjectobject
booleanplantLimitToFieldplant is limited to field
Code
24function PlantLimitToFieldEvent:new(object, plantLimitToField)
25 local self = PlantLimitToFieldEvent:emptyNew()
26 self.object = object;
27 self.plantLimitToField = plantLimitToField;
28 return self;
29end;

readStream

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

run

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