From Serious Documentation
Jump to: navigation, search

Node Home

Node Type Description
script Run-time algorithms, written in SHIPSail.

script nodes hold run-time algorithms/code written in the SHIPSail language. Scripts are event handler algorithms that can set properties, get properties, do math operations, and much more.

script nodes can exist only in the layout area.


The following nodes are permitted to have scripts as descendants:

Node Type Description
box A generic rectangular container, available as a reusable resource or layout element.
display Contains the visual GUI layout for a specific LCD display/touch set.
group Lightweight node that encloses other nodes for pure organizational benefit, or to create an array of nodes.
layout Top of the Layout Area within a SHIP GUI, which completely describes how the GUI is visually organized.
listener Monitors one or more properties (including variable values!) for changes, and on changes invokes a script.
page Visual layout area for a specific GUI "page", or "screen"
text Defines a text resource or a visual text representation.
timer Generates delays and timed alarm events.
variable Run-time value accessible by scripts and able to generate events on change.

script nodes are only permitted directly underneath these nodes.


scripts have no permitted descendants.


Property Name Data Type Description
name** String The name used to identify this node in SHIPTide.

*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.