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

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...")
 
(→‎Special Note on {{Node|timer}}.{{Prop|timer|value}} and Events)
 
(6 intermediate revisions by the same user not shown)
Line 7: Line 7:
 
|<onlyinclude>{{Prop|timer|value}}||{{DataType|Integer}}|| Remaining count-down value, in 10ths of a second, of the timer</onlyinclude>
 
|<onlyinclude>{{Prop|timer|value}}||{{DataType|Integer}}|| Remaining count-down value, in 10ths of a second, of the timer</onlyinclude>
 
|}
 
|}
 +
 
See the {{Node|timer}} node reference for more information on this property.
 
See the {{Node|timer}} node reference for more information on this property.
 +
 +
==== Special Note on {{Node|timer}}.{{Prop|timer|value}} and Events ====
 +
 +
''Changes in a {{Node|timer}}'s {{Prop|timer|value}}  property do not generate events''.
 +
 +
The {{Node|timer}} node's {{Prop|timer|value}} property may be read, written, and will self-count-down when the {{Node|timer}} is running.  However, changes in this property (whether externally applied or self-generated) never cause events. This is a notable exception to nearly every other property in [[SHIP]] and is by design.  This prevents large numbers of events, one every tenth of a second for every timer.

Latest revision as of 16:39, 3 December 2012

Node: timer

Property Data Type Description
value Integer Remaining count-down value, in 10ths of a second, of the timer

See the timer node reference for more information on this property.

Special Note on timer.value and Events

Changes in a timer's value property do not generate events.

The timer node's value property may be read, written, and will self-count-down when the timer is running. However, changes in this property (whether externally applied or self-generated) never cause events. This is a notable exception to nearly every other property in SHIP and is by design. This prevents large numbers of events, one every tenth of a second for every timer.

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