mirror of
https://gitlab.com/OpenMW/openmw.git
synced 2025-01-01 03:21:41 +00:00
60 lines
2.1 KiB
Lua
60 lines
2.1 KiB
Lua
-------------------------------------------------------------------------------
|
|
-- `openmw.async` contains timers and coroutine utils. All functions require
|
|
-- the package itself as a first argument.
|
|
-- @module async
|
|
-- @usage local async = require('openmw.async')
|
|
|
|
|
|
|
|
-------------------------------------------------------------------------------
|
|
-- Register a function as a timer callback.
|
|
-- @function [parent=#async] registerTimerCallback
|
|
-- @param self
|
|
-- @param #string name
|
|
-- @param #function func
|
|
-- @return #TimerCallback
|
|
|
|
-------------------------------------------------------------------------------
|
|
-- Calls callback(arg) in `delay` seconds.
|
|
-- Callback must be registered in advance.
|
|
-- @function [parent=#async] newTimerInSeconds
|
|
-- @param self
|
|
-- @param #number delay
|
|
-- @param #TimerCallback callback A callback returned by `registerTimerCallback`
|
|
-- @param arg An argument for `callback`; can be `nil`.
|
|
|
|
-------------------------------------------------------------------------------
|
|
-- Calls callback(arg) in `delay` game hours.
|
|
-- Callback must be registered in advance.
|
|
-- @function [parent=#async] newTimerInHours
|
|
-- @param self
|
|
-- @param #number delay
|
|
-- @param #TimerCallback callback A callback returned by `registerTimerCallback`
|
|
-- @param arg An argument for `callback`; can be `nil`.
|
|
|
|
-------------------------------------------------------------------------------
|
|
-- Calls `func()` in `delay` seconds.
|
|
-- The timer will be lost if the game is saved and loaded.
|
|
-- @function [parent=#async] newUnsavableTimerInSeconds
|
|
-- @param self
|
|
-- @param #number delay
|
|
-- @param #function func
|
|
|
|
-------------------------------------------------------------------------------
|
|
-- Calls `func()` in `delay` game hours.
|
|
-- The timer will be lost if the game is saved and loaded.
|
|
-- @function [parent=#async] newUnsavableTimerInHours
|
|
-- @param self
|
|
-- @param #number delay
|
|
-- @param #function func
|
|
|
|
-------------------------------------------------------------------------------
|
|
-- Wraps Lua function with `Callback` object that can be used in async API calls.
|
|
-- @function [parent=#async] callback
|
|
-- @param self
|
|
-- @param #function func
|
|
-- @return #Callback
|
|
|
|
return nil
|
|
|