Difference between revisions of "SHIP:Node:listener"

From Serious Documentation
Jump to: navigation, search
(Child Nodes)
(Properties)
Line 26: Line 26:
 
| listeningto|| a comma separated list of properties that, when any of them change, wake the listener
 
| listeningto|| a comma separated list of properties that, when any of them change, wake the listener
 
|-
 
|-
| condition|| An optional expression that results in a true/false or non-zero (true)/zero(false) result.
+
| condition|| An optional expression that results in a {{Reserved|true}}/{{Reserved|false}} or non-zero ({{Reserved|true}})/zero({{Reserved|false}}) result.
 
|-
 
|-
| enabled || Defaults to true, but can be set false to disable the listener.
+
| enabled || Defaults to {{Reserved|true}}, but can be set {{Reserved|false}} to disable the listener.
 
|}
 
|}
  
 
== Examples ==
 
== Examples ==

Revision as of 14:09, 27 November 2012

A listener nodes watch one or more properties (including variable values!) and, when an optional condition passes, invoke a script.

Parent Nodes

The following nodes are permitted to hold this node:

Child Nodes

The following nodes are permitted to exist within this node:

Properties

Property Name Description
name A unique variable name within the listener's node peers
listeningto a comma separated list of properties that, when any of them change, wake the listener
condition An optional expression that results in a true/false or non-zero (true)/zero(false) result.
enabled Defaults to true, but can be set false to disable the listener.

Examples