Scheduler Lua API

From Off Grid Wiki
Revision as of 11:59, 9 May 2017 by Harry (talk | contribs) (Add scheduler lua api documentation)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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