NodeReference Class

A node reference is a node that refers to an external .node file on the disk, which is obtained by exporting a node from the world.

The .node file usually contains a pre-fabricated node (or a hierarchy of nodes) with all the materials and properties libraries that are required for its rendering. All changes that are made for the node reference via UnigineEditor are saved into this file.

The node reference should be used instead of the node if there a lot of identical objects repeated in the world: it will enable to avoid manual editing each object if you need to make the same changes in all of these objects.

Unlike regular nodes, reference nodes are loaded into the world faster because of the internal cache usage.

See Also

NodeReference Class

Members

---

static NodeReference(string name)

Constructor. Creates a new object that references a node from a given file.

Arguments

• string name - Path to a *.node file.

NodeReference cast(Node node)

Casts a NodeReference out of the Node instance.

Arguments

• Node node - Node instance.

Return value

NodeReference instance.

string getNodeName()

Returns the name of the currently referenced file.

Return value

Path to the referenced *.node file.

Node getReference()

Returns the node stored by the reference.

Return value

Node instance.

Node detachReference()

Releases the internal node of ownership so it is no longer owned by the node reference (made orphan). After being released the node should be appended to one of the scripts not to cause a memory leak.

Return value

Root node of the internal hierarchy.

int type()

Returns the type of the node.

Return value

NodeReference type identifier.