Document new async methods for timers

This commit is contained in:
nox7
2026-09-18 13:54:43 -05:00
committed by Cole Green
parent c992c8cb0c
commit f64ceb52ad
+17
View File
@@ -33,6 +33,15 @@
-- @param #TimerCallback callback A callback returned by `registerTimerCallback`
-- @param arg An argument for `callback`; can be `nil`.
---
-- Calls callback(arg) in `delay` real time seconds.
-- The callback must be registered in advance.
-- @function [parent=#async] newRealTimeTimer
-- @param self
-- @param #number delay In seconds
-- @param #TimerCallback callback A callback returned by `registerTimerCallback`
-- @param arg An argument for `callback`; can be `nil`.
---
-- Calls `func()` in `delay` simulation seconds.
-- The timer will be lost if the game is saved and loaded.
@@ -49,6 +58,14 @@
-- @param #number delay
-- @param #function func
---
-- Calls `func()` in `delay` real time seconds.
-- The timer will be lost if the game is saved and loaded.
-- @function [parent=#async] newUnsavableRealTimeTimer
-- @param self
-- @param #number delay In seconds
-- @param #function func
---
-- Wraps a Lua function with a `Callback` object that can be used in async API calls.
-- @function [parent=#async] callback