Scheduler Lua API: Difference between revisions

From Off Grid Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 8: Line 8:
'''Expected parameter types'''
'''Expected parameter types'''
{| class="wikitable"
{| class="wikitable"
|-
! Name !! Type
|-
|-
| func || Lua Type
| func || Lua Type
|-
|-
| timeInSecs || number (optional)
| 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 21: Line 23:
'''Expected parameter types'''
'''Expected parameter types'''
{| class="wikitable"
{| class="wikitable"
|-
! Name !! Type
|-
|-
| func || Lua Type
| func || Lua Type
|-
|-
| timeInSecs || number (optional)
| 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
Line 34: Line 38:
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''': 13/09/2017 14:00
'''Docs last hacked together on''': 10/11/2017 11:07
 
[[Catagory:Modding]][[Catagory:LuaAPI]]
[[Category:Modding]]
[[Category:LuaAPI]]

Revision as of 11:54, 10 November 2017

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


This file is auto generated, please don't edit manually!

Docs last hacked together on: 10/11/2017 11:07 Catagory:ModdingCatagory:LuaAPI