SHIP:Property:timer:enabled

From Serious Documentation
Revision as of 06:32, 29 November 2012 by Admin (talk | contribs) (Created page with "=== Node: {{Node|timer}} === {| class="wikitable" style="margin: 1em auto 1em auto;" ! scope="col" | Property ! scope="col" | Data Type ! scope="col" | Description |- |<onlyi...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Node: timer

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

When timer.enabled is set to true and the timer.value property is non-zero, the timer begins to count down, with the value property decrementing at 0.1Hz.

On a value transition from 1 to 0, the alarm property is set to true and at that point the timer.enabled property will be set by the timer to false and the timer will stop if either of the following two conditions are true:

  1. the autoreload is set to false
  2. the autoreload is set to {{Reserved|true} but the reload period is set to 0

Otherwise, the timer's value will be automatically reloaded from the period, the enabled property will remain true, and the timer will re-start the count down.