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 (view full)

TreeNode
- OuterNode

Index

Constructors

Properties

_engine _id _isLoaded _parent

Accessors

engine id parent

Methods

add fixedStep load onCreate onFixedStep onLoad onStep onUnload remove step unload

Constructors

constructor

new OuterNode(parent): OuterNode
Calls onCreate method.
Parameters
- parent: Engine | TreeNode
Returns OuterNode
Overrides TreeNode.constructor
- Defined in src/core/OuterNode.ts:14

Properties

`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

get engine(): Engine
Get engine instance.

Returns Engine
Inherited from TreeNode.engine
- Defined in src/core/TreeNode.ts:41

id

get id(): string
Get the node's ID.

Returns string
Inherited from TreeNode.id
- Defined in src/core/TreeNode.ts:31

parent

get parent(): Engine | TreeNode
Get parent node.

Returns Engine | TreeNode
Inherited from TreeNode.parent
- Defined in src/core/TreeNode.ts:36

Methods

add

add(): number
Sealed
Implemented to throw an error as outer nodes cannot have children.

Returns number
Overrides TreeNode.add
- Defined in src/core/OuterNode.ts:24

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 method.

Returns void
Overrides TreeNode.fixedStep
- Defined in src/core/OuterNode.ts:67

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.

Returns void
Overrides TreeNode.load
- Defined in src/core/OuterNode.ts:44

`Protected`onCreate

onCreate(): void
Called by the node's constructor at instantiation, this method is to be implemented when needed.

Returns void
Overrides TreeNode.onCreate
- Defined in src/core/OuterNode.ts:88

`Protected`onFixedStep

onFixedStep(): void
Called by the parent node at each fixed step of the loop, this method is to be implemented when needed.

Returns void
Overrides TreeNode.onFixedStep
- Defined in src/core/OuterNode.ts:113

`Protected`onLoad

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.

Returns void
Overrides TreeNode.onLoad
- Defined in src/core/OuterNode.ts:98

`Protected`onStep

onStep(delta): void
Called by the parent node at each step of the loop, this method is to be implemented when needed.
Parameters
- delta: number
Returns void
Overrides TreeNode.onStep
- Defined in src/core/OuterNode.ts:106

`Protected`onUnload

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.

Returns void
Overrides TreeNode.onUnload
- Defined in src/core/OuterNode.ts:123

remove

remove(): TreeNode
Sealed
Implemented to throw an error as outer nodes cannot have children.

Returns TreeNode
Overrides TreeNode.remove
- Defined in src/core/OuterNode.ts:33

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.
Parameters
- delta: number
Returns void
Overrides TreeNode.step
- Defined in src/core/OuterNode.ts:56

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.

Returns void
Overrides TreeNode.unload
- Defined in src/core/OuterNode.ts:78