Tree

Inherits: Class

Methods

ChildrenIterator

function Tree:ChildrenIterator(node)
  -> fun():number, table, number

Iterates over all the children of a node.

Parameters:

Name	Type	Description
node	number	The node

Returns:

Type	Description
fun():number	Iterator with fields: child
table
number

DepthFirstIterator

function Tree:DepthFirstIterator(rootNode)
  -> fun():number, table

Iterates over the tree in depth-first order.

Parameters:

Name	Type	Description
rootNode	number	The rootNode to iterate from (defaults to the tree's root node)

Returns:

Type	Description
fun():number	Iterator with fields: node
table

Dump

function Tree:Dump(rootNode)

Prints out the tree for debugging.

Parameters:

Name	Type	Description
rootNode	number	The root node to dump from

GetChildren

function Tree:GetChildren(node)
  -> ...number

Gets all the children of a node.

Parameters:

Name	Type	Description
node	number	The node

Returns:

Type	Description
...number

GetData

function Tree:GetData(node, fieldName)
  -> ...any

Gets the data stored for the specified node.

Parameters:

Name	Type	Description
node	number	The node
fieldName	string	The name of the field to get

Returns:

Type	Description
...any

GetDepth

function Tree:GetDepth(node)
  -> number

Gets the depth of a node in the tree.

Parameters:

Name	Type	Description
node	number

Returns:

Type	Description
number

GetNumChildren

function Tree:GetNumChildren(node)
  -> number

Gets the number of children.

Parameters:

Name	Type	Description
node	number	The node

Returns:

Type	Description
number

GetParent

function Tree:GetParent(node)
  -> number?

Gets the parent node.

Parameters:

Name	Type	Description
node	number

Returns:

Type	Description
number?

GetRoot

function Tree:GetRoot()
  -> number

Gets the root node.

Returns:

Type	Description
number

Insert

function Tree:Insert(parent, ...)
  -> number

Inserts a node into the tree

Parameters:

Name	Type	Description
parent	number	The parent node
...	any	The data fields for the node

Returns:

Type	Description
number

MoveUp

function Tree:MoveUp(node)

Moves a node up in the tree, replacing its parent.

Parameters:

Name	Type	Description
node	number	The node to move up

RemoveAllChildren

function Tree:RemoveAllChildren(node)

Removes all children for a given node.

Parameters:

Name	Type	Description
node	number

SetChildren

function Tree:SetChildren(node, ...)

Sets the children for a given node.

Parameters:

Name	Type	Description
node	number	The node
...	number	The new children

SetData

function Tree:SetData(node, fieldName, value)

Sets a data field for a node.

Parameters:

Name	Type	Description
node	number	The node
fieldName	string	The name of the field to set
value	any	The data field value

Wipe

function Tree:Wipe()

Wipes the tree.

_MoveHelper

function Tree:_MoveHelper(newParent, oldParent, node)

Parameters:

Name	Type	Description
newParent	``
oldParent	``
node	``

_Remove

function Tree:_Remove(node)

Parameters:

Name	Type	Description
node	``

Functions

Create

function Tree.Create(...)
  -> Tree

Creates a new tree object.

Parameters:

Name	Type	Description
...	string	The data field names, in order

Returns:

Type	Description
Tree