Scheduler Lua API: Difference between revisions

From Off Grid Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 31: Line 31:
|}
|}
'''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
=== 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
'''Returns''': The id of the scheduled event
Line 38: 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''': 10/11/2017 11:07
'''Docs last hacked together on''': 06/09/2018 14:53
[[Category:Modding]][[Category:LuaAPI]]
[[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