@@ -9,8 +9,8 @@ timer = {}
99timer .INVALID_TIMER_HANDLE = nil
1010--- You may cancel a timer from inside a timer callback.
1111--- Cancelling a timer that is already executed or cancelled is safe.
12- --- @param handle the timer handle returned by timer.delay ()
13- --- @return if the timer was active , false if the timer is already cancelled / complete
12+ --- @param handle hash the timer handle returned by timer.delay ()
13+ --- @return boolean if the timer was active, false if the timer is already cancelled / complete
1414function timer .cancel (handle ) end
1515
1616--- Adds a timer and returns a unique handle
@@ -19,10 +19,10 @@ function timer.cancel(handle) end
1919--- script update functions.
2020--- If you want a timer that triggers on each frame, set delay to 0.0f and repeat to true.
2121--- Timers created within a script will automatically die when the script is deleted.
22- --- @param delay time interval in seconds
23- --- @param _repeat true = repeat timer until cancel , false = one-shot timer
22+ --- @param delay number time interval in seconds
23+ --- @param _repeat boolean true = repeat timer until cancel , false = one-shot timer
2424--- @param callback function (self , handle , time_elapsed ) timer callback function
25- --- @return identifier for the create timer , returns timer.INVALID_TIMER_HANDLE if the timer can not be created
25+ --- @return hash handle identifier for the create timer, returns timer.INVALID_TIMER_HANDLE if the timer can not be created
2626function timer .delay (delay , _repeat , callback ) end
2727
2828
0 commit comments