Scheduler Lua API

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

Name	Type
func	Lua Type
timeInSecs	number

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

Name	Type
func	Lua Type
timeInSecs	number

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

Returns: The id of the scheduled event

CallInSecs

Scheduler.CallInSecs(func, timeInSecs)

Expected parameter types

Name	Type
func	Lua Type
timeInSecs	number

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

Returns: The id of the scheduled event

This file is auto generated, please don't edit manually!

Docs last hacked together on: 15/11/2019 14:59