Scheduler Lua API: Difference between revisions
Jump to navigation
Jump to search
m (Rich moved page Lua Apis/Scheduler Lua API to Scheduler Lua API without leaving a redirect: removing sub-pages) |
No edit summary |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
<!-- This file is auto generated, please don't edit manually! --> | |||
= Scheduler = | = Scheduler = | ||
== Description == | == Description == | ||
| Line 7: | Line 8: | ||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |||
! Name !! Type | |||
|- | |- | ||
| func || Lua Type | | func || Lua Type | ||
|- | |- | ||
| timeInSecs || number | | timeInSecs || number | ||
|} | |} | ||
'''Description''': Schedule a lua function to be called in timeInSecs world time (1 sec real time = 3 secs world | '''Description''': Schedule a lua function to be called in timeInSecs world time (1 sec real time = 3 secs world | ||
| Line 20: | Line 23: | ||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |||
! Name !! Type | |||
|- | |- | ||
| func || Lua Type | | func || Lua Type | ||
|- | |- | ||
| timeInSecs || number | | timeInSecs || number | ||
|} | |} | ||
'''Description''': Schedule a lua function to be called in timeInSecs real time | '''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.CallInSecs(func, timeInSecs)</syntaxhighlight> | |||
'''Expected parameter types''' | |||
{| class="wikitable" | |||
|- | |||
! 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''': 09/ | '''Docs last hacked together on''': 06/09/2018 14:53 | ||
[[Category:Modding]][[Category:LuaAPI]] | |||
Revision as of 14:18, 6 September 2018
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: 06/09/2018 14:53