Difference between revisions of "SHIP:Node:group"

From Serious Documentation
Jump to: navigation, search
(Child Nodes)
(Properties)
Line 28: Line 28:
 
{| class="wikitable" style="margin: 1em auto 1em auto;"  
 
{| class="wikitable" style="margin: 1em auto 1em auto;"  
 
! scope="col" | Property Name
 
! scope="col" | Property Name
 +
! scope="col" | Data Type
 
! scope="col" | Description
 
! scope="col" | Description
 
|-
 
|-
| name|| A unique name within the node's peers
+
| {{Prop|name}}||{{DataType|name}}|| A unique name within the node's peers
 
|-
 
|-
| enabled || Defaults to {{Reserved|true}}, but can be set {{Reserved|false}} to disable any {{Node|listener}}s below the {{Node|group}}.
+
| {{Prop|enabled}} || {{DataType|Boolean}}||Defaults to {{Reserved|true}}, but can be set {{Reserved|false}} to disable any {{Node|listener}}s below the {{Node|group}}.
 
|}
 
|}
  

Revision as of 05:05, 28 November 2012

Node Home

A group node encloses other nodes. It is a non-visual and light wrapper that helps to isolate name spaces of nodes and organize your layout and resources and has no inherent functionality other than the ability to disable listeners inside it.

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
Must specify a property (e.g. visible)[[SHIP:Property:name:{{{2}}}|{{{2}}}]] name A unique name within the node's peers
Must specify a property (e.g. visible)[[SHIP:Property:enabled:{{{2}}}|{{{2}}}]] Boolean Defaults to true, but can be set false to disable any listeners below the group.

Examples

The group node is convenient for wrapping a set of nodes, such as constants, to give them a name space.

ToDo