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

From Serious Documentation
Jump to: navigation, search
(Special Note on {{Node|timer}}.{{Prop|timer|value}} and Events)
(Special Note on {{Node|timer}}.{{Prop|timer|value}} and Events)
Line 14: Line 14:
 
''Changes in a {{Node|timer}}'s {{Prop|timer|value}}  property do not generate 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 and written and will self-count-down when the {{Node|timer}} is running, but changes in this property never generate 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.
+
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.

Revision as of 16:38, 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.