blob: 4a112fcd1842d7f8c596cde642bc930c9b062e93 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
|
---Timer API documentation
---Timers allow you to set a delay and a callback to be called when the timer completes.
---The timers created with this API are updated with the collection timer where they
---are created. If you pause or speed up the collection (using set_time_step) it will
---also affect the new timer.
---@class timer
timer = {}
---Indicates an invalid timer handle
timer.INVALID_TIMER_HANDLE = nil
---You may cancel a timer from inside a timer callback.
---Cancelling a timer that is already executed or cancelled is safe.
---@param handle hash # the timer handle returned by timer.delay()
---@return boolean # if the timer was active, false if the timer is already cancelled / complete
function timer.cancel(handle) end
---Adds a timer and returns a unique handle
---You may create more timers from inside a timer callback.
---Using a delay of 0 will result in a timer that triggers at the next frame just before
---script update functions.
---If you want a timer that triggers on each frame, set delay to 0.0f and repeat to true.
---Timers created within a script will automatically die when the script is deleted.
---@param delay number # time interval in seconds
---@param _repeat boolean # true = repeat timer until cancel, false = one-shot timer
---@param callback fun(self: object, handle: number, time_elapsed: number) # timer callback function
---@return hash # handle identifier for the create timer, returns timer.INVALID_TIMER_HANDLE if the timer can not be created
function timer.delay(delay, _repeat, callback) end
---Manual triggering a callback for a timer.
---@param handle hash # the timer handle returned by timer.delay()
---@return boolean # if the timer was active, false if the timer is already cancelled / complete
function timer.trigger(handle) end
return timer
|
