Scheduler Lua API: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 4: | Line 4: | ||
The Scheduler api allows users to Schedule callback events based on specific time values | The Scheduler api allows users to Schedule callback events based on specific time values | ||
== Functions == | == Functions == | ||
=== | === CallInSecsReal === | ||
<syntaxhighlight source lang="lua">Scheduler. | <syntaxhighlight source lang="lua">Scheduler.CallInSecsReal(func, timeInSecs)</syntaxhighlight> | ||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 15: | Line 15: | ||
| timeInSecs || number | | timeInSecs || number | ||
|} | |} | ||
'''Description''': Schedule a lua function to be called in timeInSecs | '''Description''': Schedule a lua function to be called in timeInSecs real time | ||
'''Returns''': The id of the scheduled event | '''Returns''': The id of the scheduled event | ||
=== | === CallInSecs === | ||
<syntaxhighlight source lang="lua">Scheduler. | <syntaxhighlight source lang="lua">Scheduler.CallInSecs(func, timeInSecs)</syntaxhighlight> | ||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 30: | Line 30: | ||
| timeInSecs || number | | timeInSecs || number | ||
|} | |} | ||
'''Description''': Schedule a lua function to be called in timeInSecs | '''Description''': Schedule a lua function to be called in timeInSecs scaled time | ||
'''Returns''': The id of the scheduled event | '''Returns''': The id of the scheduled event | ||
=== | === CallAtTime === | ||
<syntaxhighlight source lang="lua">Scheduler. | <syntaxhighlight source lang="lua">Scheduler.CallAtTime(func, dateTimeString)</syntaxhighlight> | ||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 43: | Line 43: | ||
| func || Lua Type | | func || Lua Type | ||
|- | |- | ||
| | | dateTimeString || string | ||
|} | |} | ||
'''Description''': Schedule a lua function to be called | '''Description''': Schedule a lua function to be called at specific time (defined by a date/time string) | ||
'''Returns''': The id of the scheduled event | '''Returns''': The id of the scheduled event | ||
| 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