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

From Serious Documentation
Jump to: navigation, search
(Special Note on {{Prop|timer|value}} and Events)
(Special Note on {{Prop|timer|value}} and Events)
Line 10: Line 10:
 
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 {{Prop|timer|value}} and Events ====
+
==== Special Note on {{Node|timer}}.{{Prop|timer|value}} and Events ====
  
 
The {{Node|timer}} node's {{Prop|timer|value}} property may be read and written, but ''changes in this property never generate events''.
 
The {{Node|timer}} node's {{Prop|timer|value}} property may be read and written, 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.
 
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:36, 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

The timer node's value property may be read and written, 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.