Clone
6
API
Aleksander Wilczyński edited this page 2024-09-15 23:13:27 +02:00

API docs

Utils

RandomUUID

DEPRECATED

SEE GenerateUID

local id = RandomUUID(); 
id; -- xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx

Coroutine Functions

  • EXECUTE INSIDE OF COROUTINE

Sync (_)

  • fn (function) - Coroutine function.
  • Returns any - Returns output from fn
local output = _(Func());
output; -- output from Func

Examples:

_(VdReady()); -- wait for VirtualDispatcherReady event
local output = _(Split());
output.newTrainset; -- New trainset (TrainsetInfo)

Split

  • trainset? (string) - Trainset name

See OnTrainsetsSplit

Examples:

_(Split());
local output = _(Split());
_(Split('trainsetName'))

Join

  • trainset? (string) - Trainset name

See OnTrainsetsJoined

Examples:

_(Split());
local output = _(Split());
_(Split('trainsetName'))

Trigger

  • name (string) - Signal or track
  • dist (number) - Distance
  • dir? (number) - Direction (only applies to track!)
  • check? (function) - Check function

See CreateSignalTrigger, CreateTrackTrigger

Examples:

_(Trigger('KZ_O', 500, function(trainset)
	return trainset.name == 'pieknypociag'
end))

_(Trigger('t121', 500, 1, function(trainset)
	return trainset.name == 'brzydkipociag'
end))

Route

  • a (string) - Signal A
  • b (string) - Signal B
  • t (VDOrderType) - Order Type

Examples:

_(Route("KO_Tm43", "KO_N4", VDOrderType.ManeuverRoute));
_(Route("KO_M4", "KO_E14", VDOrderType.TrainRoute));