Scheduler Lua API

From Off Grid Wiki
Jump to navigation Jump to search

Scheduler

Description

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

Functions

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

CallAtTime

Scheduler.CallAtTime(func, dateTimeString)

Expected parameter types

Name Type
func Lua Type
dateTimeString string

Description: Schedule a lua function to be called at specific time (defined by a date/time string)

Returns: The id of the scheduled event


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

Docs last hacked together on: 23/07/2020 11:58