Timer API documentation

Version: stable

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.

FUNCTION
timer.cancel()	cancel a timer
timer.delay()	create a timer

CONSTANT
timer.INVALID_TIMER_HANDLE	Indicates an invalid timer handle

Functions

timer.cancel()

timer.cancel(handle)

You may cancel a timer from inside a timer callback. Cancelling a timer that is already executed or cancelled is safe.

PARAMETERS

handle

the timer handle returned by timer.delay()

RETURNS

true	if the timer was active, false if the timer is already cancelled / complete

---

timer.delay()

timer.delay(delay,repeat,callback)

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.

PARAMETERS

delay	time interval in seconds
repeat	true = repeat timer until cancel, false = one-shot timer
callback	function(self, handle, time_elapsed) timer callback function self object The current object handle number The handle of the timer time_elapsed number The elapsed time - on first trigger it is time since timer.delay call, otherwise time since last trigger

RETURNS

handle

identifier for the create timer, returns timer.INVALID_TIMER_HANDLE if the timer can not be created

---

Constants

timer.INVALID_TIMER_HANDLE

Indicates an invalid timer handle

---