Difference between revisions of "SHIP:Node:listener"

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

Revision as of 07:19, 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
SHIP:Property:listener:name
listeningto** Reference:property List Comma separated list of one or more node properties that, when changed, wake the listener
condition** NumRetExp (optional) If this expression evaluates to be non-zero or true the attached script is allowed to run.
SHIP:Property:listener:enabled

Examples
Retrieved from "https://techref.myserious.com/index.php?title=SHIP:Node:listener&oldid=923"