Difference between revisions of "SHIP:Node:listener"

From Serious Documentation
Jump to: navigation, search
(Created page with "<onlyinclude>A listener nodes watch one or more properties (including variable values!) and, when an optional condition passes, invoke a script.</onlyin...")
 
Line 2: Line 2:
 
== Parent Nodes ==
 
== Parent Nodes ==
 
The following nodes are permitted to hold this node:
 
The following nodes are permitted to hold this node:
* [[SHIP:Node:linkset|linkset]]
 
 
== Child Nodes ==
 
The following nodes are permitted to exist within this node:
 
 
* [[SHIP:Node:box|box]]
 
* [[SHIP:Node:box|box]]
 
* [[SHIP:Node:display|display]]
 
* [[SHIP:Node:display|display]]
Line 12: Line 8:
 
* [[SHIP:Node:page|page]]
 
* [[SHIP:Node:page|page]]
 
* [[SHIP:Node:text|text]]
 
* [[SHIP:Node:text|text]]
 +
* [[SHIP:Node:variable|variable]]
 +
 +
== Child Nodes ==
 +
The following nodes are permitted to exist within this node:
 +
* [[SHIP:Node:script|script]]
 +
* [[SHIP:Node:const|const]]
 
* [[SHIP:Node:variable|variable]]
 
* [[SHIP:Node:variable|variable]]
  

Revision as of 16:18, 25 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 its 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