Scheduler Lua API: Difference between revisions

From Off Grid Wiki
Jump to navigation Jump to search
(Add scheduler lua api documentation)
 
(adding DocStart)
Line 1: Line 1:
{{OffGridDocStart}}
= Scheduler =
= Scheduler =
== Description ==
== Description ==

Revision as of 17:20, 22 June 2017

Template:OffGridDocStart

Scheduler

Description

The Scheduler api allows users to Schedule callback events based on specific time values

Functions

CallInSecsWorld

Scheduler.CallInSecsWorld(func, timeInSecs)

Expected parameter types

func Lua Type
timeInSecs number (optional)

Description: Schedule a lua function to be called in timeInSecs world time (1 sec real time = 3 secs world

Returns: The id of the scheduled event

CallInSecsReal

Scheduler.CallInSecsReal(func, timeInSecs)

Expected parameter types

func Lua Type
timeInSecs number (optional)

Description: Schedule a lua function to be called in timeInSecs real time

Returns: The id of the scheduled event


Docs last hacked together on: 09/05/2017 12:59