Class InnerNode

An inner node is a node of the tree that has child nodes.

In most cases those nodes will be used as entity nodes and will be composed of component nodes. But those can be used for any other purpose (utility, scene orchestrating, etc.).

Hierarchy (view full)

Constructors

constructor

Properties

_children _engine _id _isLoaded _parent

Accessors

engine id parent

Methods

add fixedStep load onCreate onFixedStep onLoad onStep onUnload remove step unload

Constructors

constructor

Properties

Protected_children

_children: TreeNode[]

Node's children nodes.

Protected_engine

_engine: Engine

Engine instance of the node's graph.

Protected_id

_id: string

Node's ID, generate it with nanoid if applicable.

Protected_isLoaded

_isLoaded: boolean

Get wether the node is loaded.

Protected_parent

_parent: Engine | TreeNode

Node's parent node, if root node, the parent node is replaced by the engine instance.

Accessors

engine

id

parent

Methods

add

  • add(node): number
  • Sealed

    Adds a child node to this node children and loads it.

    Parameters

    Returns number

    New children array length.

fixedStep

  • fixedStep(): void
  • Sealed

    Called at parent nodes fixedStep or directly by the engine's step if this node is the rootNode.

    Calls the onFixedStep and children's fixedStep methods.

    Returns void

load

  • load(): void
  • Sealed

    Called at parent nodes loading or directly by the engine's loading if this node is the rootNode.

    Calls the onLoad method and children's load methods.

    Returns void

ProtectedonCreate

ProtectedonFixedStep

ProtectedonLoad

  • onLoad(): void

  • Called by the parent node when loaded, this function is to be implemented when needed.

    If this node is the engine's root node, this function will be called by the engine instead.

    Returns void

ProtectedonStep

  • onStep(delta): void

  • Called by the parent node at each step of the loop, this function is to be implemented when needed.

    Parameters

    • delta: number

    Returns void

ProtectedonUnload

  • onUnload(): void

  • Called by the parent node at unload, this function is to be implemented when needed.

    If this node is the engine's root node, this function will be called by the engine instead.

    Returns void

remove

step

  • step(delta): void
  • Sealed

    Called at parent nodes step or directly by the engine's step if this node is the rootNode.

    Calls the onStep method and children's step methods.

    Parameters

    • delta: number

    Returns void

unload

  • unload(): void
  • Sealed

    Called at parent nodes unload or directly by the engine's unload if this node is the rootNode.

    Calls the onUnload method and children's unload methods.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods