Scheduler Lua API: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 53: | Line 53: | ||
This file is auto generated, please don't edit manually! | This file is auto generated, please don't edit manually! | ||
'''Docs last hacked together on''': | '''Docs last hacked together on''': 13/10/2021 15:55 | ||
[[Category:Modding]][[Category:LuaAPI]] | [[Category:Modding]][[Category:LuaAPI]] |
Revision as of 08:53, 14 October 2021
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: 13/10/2021 15:55