Scheduler Lua API: Difference between revisions

From Off Grid Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(2 intermediate revisions by one other user 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 ==
=== CallInSecsWorld ===
=== CallInSecsReal ===
<syntaxhighlight source lang="lua">Scheduler.CallInSecsWorld(func, timeInSecs)</syntaxhighlight>
<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 world time (1 sec real time = 3 secs world
'''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


=== CallInSecsReal ===
=== CallInSecs ===
<syntaxhighlight source lang="lua">Scheduler.CallInSecsReal(func, timeInSecs)</syntaxhighlight>
<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 real time
'''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
'''Returns''': The id of the scheduled event


=== CallInSecs ===
=== CallAtTime ===
<syntaxhighlight source lang="lua">Scheduler.CallInSecs(func, timeInSecs)</syntaxhighlight>
<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
|-
|-
| timeInSecs || number
| dateTimeString || string
|}
|}
'''Description''': Schedule a lua function to be called in timeInSecs scaled time
'''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 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''': 15/11/2019 14:59
'''Docs last hacked together on''': 29/08/2023 16:24
[[Category:Modding]][[Category:LuaAPI]]
[[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