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

From Serious Documentation
Jump to: navigation, search
(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...")
 
 
(13 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
=== Node: {{Node|timer}} ===
 
=== Node: {{Node|timer}} ===
−
{| class="wikitable" style="margin: 1em auto 1em auto;"
+
{{PropTableStart|}}
−
! scope="col" | Property
 
−
! scope="col" | Data Type
 
−
! scope="col" | Description
 
 
|-
 
|-
 
|<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>
 
|}
 
|}
 +
See the {{Node|timer}} node reference for a detailed description of this property.
  
−
When {{Node|timer}}.{{Prop|timer|enabled}} is set to {{Reserved|true}} and the {{Node|timer}}.{{Prop|timer|value}} property is non-zero, the {{Node|timer}} begins to count down, with the {{Prop|timer|value}} property decrementing at 0.1Hz.
+
=== Special Note on {{Node|listener}}s and the {{Node|timer}} {{Prop|timer|enabled}} Property ===
  
−
On a {{Prop|timer|value}} transition from <code>1</code> to <code>0</code>, the {{Prop|timer|alarm}} property is set to {{Reserved|true}} and at that point the {{Node|timer}}.{{Prop|timer|enabled}} property will be set by the {{Node|timer}} to {{Reserved|false}} and the {{Node|timer}} will stop if ''either'' of the following two conditions are true:
+
Normally, any {{Reserved|false}} enabled property in any parent (or grandparent, or great-grandparent, etc.) of a {{Node|listener}} node will disable that {{Node|listener}}. For example, a {{Node|listener}} in a {{Node|box}} where the {{Node|box}}'s {{Prop|layoutarea|enabled}} property is {{Reserved|false}} will prevent the {{Node|listener}} from waking on events.
−
#the {{Prop|timer|autoreload}} is set to {{Reserved|false}}
 
−
#the {{Prop|timer|autoreload}} is set to {{Reserved|true} but the reload {{Prop|timer|period}} is set to <code>0</code>
 
  
−
Otherwise, the {{Node|timer}}'s {{Prop|timer|value}} will be automatically reloaded from the {{Prop|timer|period}}, the {{Prop|timer|enabled}} property will remain {{Reserved|true}}, and the {{Node|timer}} will re-start the count down.
+
Starting with SHIPEngine v4.0.202, {{Node|timer}} nodes' {{Prop|timer|enabled}} property does ''not'' block events from {{Node|listener}}s within them.
 +
 
 +
This exception is by design so that, for example, {{Prop|timer|alarm}}s can be listened for in a {{Node|listener}} held inside a {{Node|timer}} node.  Otherwise, when the {{Node|timer}} expired and the {{Prop|timer|enabled}} went {{Reserved|false}}, a contained {{Node|listener}} would immediately be disabled and the {{Node|timer}} {{Prop|timer|alarm}} would be unheard.

Latest revision as of 12:19, 31 January 2013

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=2567"