Difference between revisions of "SHIP:Node:listener"

From Serious Documentation
Jump to: navigation, search
(Properties)
(Properties)
Line 33: Line 33:
 
|{{:SHIP:Property:listener:enabled}}
 
|{{:SHIP:Property:listener:enabled}}
 
|}
 
|}
 +
{{SHIP:RuntimePropertyNote}}
 +
 +
{{SHIP:TideTimePropertyNote}}
  
 
== Examples ==
 
== Examples ==

Revision as of 07:58, 29 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 Data Type 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

*available at SHIPEngine run time only and cannot be set in SHIPTide. Use a Sail script at shiplaunch time if this property needs to be set when the GUI starts to run.

**available only in SHIPTide; cannot be accessed from Sail scripts at run-time.

Examples