SHIP:Property:timer:enabled

From Serious Documentation
Revision as of 06:54, 29 November 2012 by Admin (talk | contribs) (Node: {{Node|timer}})
Jump to: navigation, search

Node: timer

Property Data Type Description
enabled Boolean If true (default if unset) this timer is enabled.

The timer enabled property enables the timer to count down from its current value to zero. The timer is paused and does not count down when enabled is false.

The timer node can self-set the enabled property to false on various conditions, but can never self-set the property to true. The enabled property can only be set true in SHIPTide at GUI design time and in a Sail script at run-time.

If (value > 0) and enabled is set to true either in a Sail script at run-time or in SHIPTide then the timer begins to count down, with the value property decrementing at 0.1Hz.

When (value == 0), the enabled property may be self-set to false and the timer halted if any of the following conditions are true:

Otherwise the enabled property remains true, the timer reloads the count value from the period, and the timerrestarts counting down from the new reloaded value.