Scheduler Lua API: Difference between revisions
m (Rich moved page Scheduler Lua API to Lua Apis/Scheduler Lua API without leaving a redirect) |
No edit summary |
||
(10 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
<!-- This file is auto generated, please don't edit manually! --> | |||
= Scheduler = | = Scheduler = | ||
== Description == | == Description == | ||
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" | ||
|- | |||
! Name !! Type | |||
|- | |- | ||
| func || Lua Type | | func || Lua Type | ||
|- | |- | ||
| timeInSecs || number | | timeInSecs || number | ||
|} | |} | ||
'''Description''': Schedule a lua function to be called in | '''Description''': Schedule a lua function to be called after timeInSecs in real time (counting time even if the game is paused, in a menu, or in conversation etc) | ||
'''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''' | |||
{| class="wikitable" | |||
|- | |||
! Name !! Type | |||
|- | |||
| func || Lua Type | |||
|- | |||
| timeInSecs || number | |||
|} | |||
'''Description''': Schedule a lua function to be called after timeInSecs in game time (time doens't count when the game is paused) | |||
'''Returns''': The id of the scheduled event | |||
=== CallAtTime === | |||
<syntaxhighlight source lang="lua">Scheduler.CallAtTime(func, dateTimeString)</syntaxhighlight> | |||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |||
! Name !! Type | |||
|- | |- | ||
| 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 formatted as dd/MM/yyyy/HH:mm) | ||
'''Returns''': The id of the scheduled event | '''Returns''': The id of the scheduled event | ||
Line 32: | Line 51: | ||
'''Docs last hacked together on''': | This file is auto generated, please don't edit manually! | ||
'''Docs last hacked together on''': 29/08/2023 16:24 | |||
[[Category:Modding]][[Category:LuaAPI]] |
Latest revision as of 14:23, 29 August 2023
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 after timeInSecs in real time (counting time even if the game is paused, in a menu, or in conversation etc)
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 after timeInSecs in game time (time doens't count when the game is paused)
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 formatted as dd/MM/yyyy/HH:mm)
Returns: The id of the scheduled event
This file is auto generated, please don't edit manually!
Docs last hacked together on: 29/08/2023 16:24