Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OuterNode

An outer node is a node of the tree that does not have child nodes.

In most cases those nodes will be used as component or system nodes.

Hierarchy

Index

Constructors

Properties

_id: string

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

_parent: Engine | TreeNode

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

engine: Engine

Engine instance of the node's graph.

isLoaded: boolean

Get wether the node is loaded.

Accessors

  • get id(): string

Methods

  • add(): number
  • fixedStep(): void
  • Called at parent nodes fixedStep or directly by the engine's step if this node is the rootNode.

    Calls the onFixedStep method.

    sealed

    Returns void

  • load(): void
  • Called at parent nodes loading or directly by the engine's loading if this node is the rootNode.

    Calls the onLoad method.

    sealed

    Returns void

  • onCreate(): void
  • onFixedStep(): void
  • onLoad(): void
  • Called by the parent node when loaded, this method is to be implemented when needed.

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

    virtual

    Returns void

  • onStep(): void
  • onUnload(): void
  • Called by the parent node at unload, this method is to be implemented when needed.

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

    virtual

    Returns void

  • step(): void
  • Called at parent nodes step or directly by the engine's step if this node is the rootNode.

    Calls the onStep method.

    sealed

    Returns void

  • unload(): void
  • Called at parent nodes unload or directly by the engine's unload if this node is the rootNode.

    Calls the onUnload method.

    sealed

    Returns void

Generated using TypeDoc