Difference between revisions of "SHIP:Node:listener"

From Serious Documentation
Jump to: navigation, search
Line 24: Line 24:
 
! scope="col" | Description
 
! scope="col" | Description
 
|-
 
|-
| name|| A unique variable name within the listener's node peers
+
| {{Prop|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
+
| {{Prop|listeningto}}|| a comma separated list of properties that, when any of them change, wake the listener
 
|-
 
|-
| condition|| An optional expression that results in a {{Reserved|true}}/{{Reserved|false}} or non-zero ({{Reserved|true}})/zero({{Reserved|false}}) result.
+
| {{Prop|condition}}|| An optional expression that results in a {{Reserved|true}}/{{Reserved|false}} or non-zero ({{Reserved|true}})/zero({{Reserved|false}}) result.
 
|-
 
|-
| enabled || Defaults to {{Reserved|true}}, but can be set {{Reserved|false}} to disable the listener.
+
| {{Prop|enabled}} || Defaults to {{Reserved|true}}, but can be set {{Reserved|false}} to disable the listener.
 
|}
 
|}
  
 
== Examples ==
 
== Examples ==

Revision as of 11:48, 28 November 2012

Node Home

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
Must specify a property (e.g. visible)[[SHIP:Property:name:{{{2}}}|{{{2}}}]] A unique variable name within the listener's node peers
Must specify a property (e.g. visible)[[SHIP:Property:listeningto:{{{2}}}|{{{2}}}]] a comma separated list of properties that, when any of them change, wake the listener
Must specify a property (e.g. visible)[[SHIP:Property:condition:{{{2}}}|{{{2}}}]] An optional expression that results in a true/false or non-zero (true)/zero(false) result.
Must specify a property (e.g. visible)[[SHIP:Property:enabled:{{{2}}}|{{{2}}}]] Defaults to true, but can be set false to disable the listener.

Examples