Difference between revisions of "SHIP:Data Types:Node"

From Serious Documentation
Jump to: navigation, search
Line 6: Line 6:
 
<onlyinclude>{{DataTypeTableStart|}}
 
<onlyinclude>{{DataTypeTableStart|}}
 
|{{DataType|Reference}}||Reference to a [[SHIP:Node|node]] or one of its properties.
 
|{{DataType|Reference}}||Reference to a [[SHIP:Node|node]] or one of its properties.
|}
+
|}</onlyinclude>
 
Properties and parameters that are of type {{DataType|Reference}} must receive a value that is known at SHIPTide time, not a value that is dynamically assigned at run time. For example, the following statement will fail:
 
Properties and parameters that are of type {{DataType|Reference}} must receive a value that is known at SHIPTide time, not a value that is dynamically assigned at run time. For example, the following statement will fail:
<code>
+
<code>[[SHIP:Sail:getChildIndex|getChildIndex]]([[SHIP:Sail:getChild|getChild]](myParent, index));    // fails instead of returning index</code>
[[SHIP:Sail:getChildIndex|getChildIndex]]([[SHIP:Sail:getChild|getChild]](myParent, index));    // fails instead of returning index
 
</code>
 
  
The above code is illegal since [[SHIP:Sail:getChildIndex|getChildIndex]] expects a {{DataType|Reference}} to a [[SHIP:Node|node]] but [[SHIP:Sail:getChild|getChild]] returns the [[SHIP:Node|node]] itself.</onlyinclude>
+
The above code is illegal since [[SHIP:Sail:getChildIndex|getChildIndex]] expects a {{DataType|Reference}} to a [[SHIP:Node|node]] but [[SHIP:Sail:getChild|getChild]] returns the [[SHIP:Node|node]] itself.

Revision as of 06:16, 19 April 2014

See Also

Reference

Data Type Description
Reference Reference to a node or one of its properties.

Properties and parameters that are of type Reference must receive a value that is known at SHIPTide time, not a value that is dynamically assigned at run time. For example, the following statement will fail:

getChildIndex(getChild(myParent, index));    // fails instead of returning index

The above code is illegal since getChildIndex expects a Reference to a node but getChild returns the node itself.