SHIP:Sail:getChildIndex

Function	Returns	Introduced	Description
getChildIndex	Integer	v4.0.211	Gets the index of a Node within its enclosing parent Node.

See Also:

• Sail Home
• Sail Functions
• Sail Node Functions
• getChild, getChildCount

Prototype

Integer getChildIndex(Node node);

Parameters/Return Value

Parameter	Data Type	Description
node	Node	The specified node you want the index of
Return	Integer	index of specified Node within parent Node

Detailed Description

The getChildIndex function returns the index of the specified node within its direct enclosing parent.

Nodes in SHIP may have 0 or more direct child nodes. For example, a group in the resources area may have N images within the group. These children, if present, are implicitly numbered 0..(N-1) where N is the total number of children of any type within the parent node.