Action: Timer(alarm ID, delay)

Related Actions: randomtimer, lettimer, iffixed, ifmapped, ifmoved, ifnotfixed, ifnotmapped, ifnotmoved, exitevent
Related Events: alarm
See also: FKiSS, Events, Actions

timer(alarm ID, delay)

First defined in: FKiSS1
The timer action sets the timer for an alarm. If a timer for that alarm is already counting down, the new delay time will replace it, resetting the alarm's timer.
Setting delay to zero will cancel the timer for that alarm, preventing the alarm from being activated.

alarm ID

In FKiSS1 to FKiSS2.1, alarm ID must be an alarm ID number.
In FKiSS3, alarm ID may be an alarm ID number or a variable representing an alarm ID number.
In FKiSS4, alarm ID may be an alarm ID (number or symbolic name) or a variable representing an alarm ID number.

delay

In FKiSS1 to FKiSS2.1, delay must be a number representing the delay time in milliseconds.
In FKiSS3, delay may be a number or a variable representing the delay time in milliseconds.

Example:

;@ timer(5, 1000)       ; Set alarm 5 to go off in 1 second.
;@ timer(A, D)          ; Set alarm whose ID is in variable A to go off in the number of milliseconds stored in variable D.
;@ timer(MyAlarm, 1000) ; Set alarm "MyAlarm" to go off in 1 second.
;@ timer(17, 0)         ; cancels the timer for alarm 17.