Difference between revisions of "SHIP:Property:timer:enabled"

From Serious Documentation
Jump to: navigation, search
(→‎Node: {{Node|timer}})
(→‎Node: {{Node|timer}})
Line 7: Line 7:
 
|<onlyinclude>{{Prop|timer|enabled}}||{{DataType|Boolean}}|| If {{Reserved|true}} (default if unset) this {{Node|timer}} is enabled.</onlyinclude>
 
|<onlyinclude>{{Prop|timer|enabled}}||{{DataType|Boolean}}|| If {{Reserved|true}} (default if unset) this {{Node|timer}} is enabled.</onlyinclude>
 
|}
 
|}
−
The {{Node|timer}} {{Prop|timer|enabled}} property enables the {{Node|timer}} to count down from its current {{Prop|timer|value}} to zero.  The {{Node|timer}} is paused and does not count down when {{Prop|timer|enabled}} is {{Reserved|false}}. If ({{Prop|timer|value}} &gt; <code>0</code>) and {{Prop|timer|enabled}} is set to {{Reserved|true}} either in a [[SHIP:Sail|Sail]] script at run-time or in [[SHIPTide]] then the {{Node|timer}} begins to count down, with the {{Prop|timer|value}} property decrementing at 0.1Hz.
+
See the {{Node|timer}} node reference for a detailed description of this property.
−
 
 
−
The {{Prop|timer|enabled}} property can be set to {{Reserved|true}} or {{Reserved|false}} in [[SHIPTide]] at GUI design time and in a [[SHIP:Sail|Sail]] script at run-time. The {{Node|timer}} node can only self-set the {{Prop|timer|enabled}} property to {{Reserved|false}}, and will do so only when '''both''' the following conditions are true:
 
−
*the {{Prop|timer|oneshot}} property is {{Reserved|true}}, and,
 
−
*the count {{Prop|timer|value}} transitions from <code>1</code> to <code>0</code>.
 
−
 
 
−
Therefore, in free running mode (i.e. {{Prop|timer|oneshot}} is {{Reserved|false}}) the {{Node|timer}} {{Prop|timer|enabled}} property will never self-set to {{Reserved|false}}.
 
  
 
=== Special Note on {{Node|listener}}s and the {{Node|timer}} {{Prop|timer|enabled}} Property ===
 
=== Special Note on {{Node|listener}}s and the {{Node|timer}} {{Prop|timer|enabled}} Property ===

Revision as of 08:00, 30 November 2012

Node: timer

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

See the timer node reference for a detailed description of this property.

Special Note on listeners and the timer enabled Property

Normally, any false enabled property in any parent (or grandparent, or great-grandparent, etc.) of a listener node will disable that listener. For example, a listener in a box where the box's enabled property is false will prevent the listener from waking on events.

Starting with SHIPEngine v4.0.202, timer nodes' enabled property does not block events from listeners within them.

This exception is by design so that, for example, alarms can be listened for in a listener held inside a timer node. Otherwise, when the timer expired and the enabled went false, a contained listener would immediately be disabled and the timer alarm would be unheard.

Retrieved from "https://techref.myserious.com/index.php?title=SHIP:Property:timer:enabled&oldid=1137"