- Reference
- Script reference
- Timing and scheduling
GetTimer
Get the current state of a timer
Description#
GetTimer( timerno, mode=0 )Return the current state of a timer.
Parameters#
timerno | Timer number 0-3 |
mode | mode - see below |
mode is one of:
TIMER_REMAIN | Returns remaining time on the timer in milliseconds (default) |
TIMER_TIMEOUT | Returns the initial timeout set for this timer |
TIMER_PARAM | Returns the user parameter value |
TIMER_REPEAT | Returns the number of remaining repeats |
Return value#
Returns the timer parameter requested
Example usage#
new x;
SetTimer(1, 100, 1234); // set up timer 1
x = GetTimer(1, TIMER_PARAM); // returns 1234Last updated Nov 19, 2019