Event: Alarm(alarm ID)

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

alarm(alarm ID)

First defined in: FKiSS1
The alarm events are called when the timer for a specified alarm reaches zero.
Every alarm event must have a unique ID, different from every other alarm.

alarm ID

In FKiSS1 to FKiSS3, alarm ID must be a positive integer such as 0 or 250.
In FKiSS4, alarm ID may also be a symbolic name. This name must begin with a letter and may contain additional letters or numbers up to a total length of 32 characters. It is possible for an alarm ID to be identical to a label ID or variable but it is better to avoid such ambiguity.

Remarks

When thinking of alarms, it might be simplest to think of them as individual alarm clocks. You have a whole shelf full of alarm clocks and each one has its own unique ID. At any time, more than one of them may be set to go off but no single alarm has more than one alarm time so, if an alarm is already counting down, any timer action relating to that alarm will override the previous setting for that alarm.

Example:

;@ alarm(5)
;@   sound("bells.wav")
;@ alarm(StartBlinking)
;@   unmap("eyes1.cel") map("eyes2.cel")
;@   timer(Blink2, 100)