SHIP:Node:listener

Node Home

Node Type	Description
listener	Monitors one or more properties (including variable values!) for changes, and on changes invokes a script.

listener nodes are the heart of the event system. With the listeningto property, a listener can monitor one or more properties (including variable values) in SHIP. When any of these properties change, the listener is awoken. It tests the (optional) condition, and if the condition passes (or does not exist) it then runs any enclosed script nodes.

listener nodes can exist only in the layout area.

Parent Nodes

The following nodes are permitted to hold this node:

• box
• constant
• display
• group
• label
• layout
• page
• variable

Child Nodes

The following nodes are permitted to exist within this node:

• script
• constant
• variable

Properties

Property Name	Data Type	Description
name**	String	The name used to identify this node in SHIPTide.
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.