Class RootGameObject

A RootGameObject is a special type of GameObject that is the root of a tree of GameObjects. It contains additional information about the global game world instance.

Hierarchy (View Summary)

GameObject
- RootGameObject

Constructors

constructor

new RootGameObject(gameEngineWindow: GameEngineWindow): RootGameObject
Parameters
- gameEngineWindow: GameEngineWindow
Returns RootGameObject
Overrides GameObject.constructor
- Defined in Core/RootGameObject.ts:14

Properties

`Readonly`gameWindowInstance

gameWindowInstance: GameEngineWindow

The global game window instance.

name

name: string

The name of this GameObject

`Readonly`onBehaviorAdded

onBehaviorAdded: Event<Behavior> = ...

Event that is triggered when a behavior is added to this GameObject. The behavior is passed as an argument.

`Readonly`onBehaviorListChanged

onBehaviorListChanged: Event<void> = ...

Event that is triggered when the list of behaviors attached to this GameObject changes.

`Readonly`onBehaviorRemoved

onBehaviorRemoved: Event<Behavior> = ...

Event that is triggered when a behavior is removed from this GameObject. The behavior is passed as an argument.

`Readonly`onChildAdded

onChildAdded: Event<GameObject> = ...

Event that is triggered when a child is added to this GameObject. The child is passed as an argument.

`Readonly`onChildRemoved

onChildRemoved: Event<GameObject> = ...

Event that is triggered when a child is removed from this GameObject. The child is passed as an argument.

`Readonly`transform

transform: Transform = ...

The position, rotation, and scale of this GameObject.

Accessors

children

get children(): GameObject[]
Get only first-level children of this GameObject.

Returns GameObject[]
Inherited from GameObject.children
- Defined in Core/GameObject.ts:70

parent

get parent(): null | GameObject
Get the parent of this GameObject or null if it's root or not already attached to a tree.

Returns null | GameObject
Inherited from GameObject.parent
- Defined in Core/GameObject.ts:46
set parent(value: null | GameObject): void
Protected
Set the parent of this GameObject. This should only be used internally by the engine.
Parameters
- value: null | GameObject
Returns void
Inherited from GameObject.parent
- Defined in Core/GameObject.ts:55

root

get root(): null | RootGameObject
Get the root of the tree this GameObject is attached to.

Returns null | RootGameObject
Inherited from GameObject.root
- Defined in Core/GameObject.ts:77

Methods

addBehavior

addBehavior(behavior: Behavior): void
Attach a behavior to this GameObject. It will be updated every frame.
Parameters
- behavior: Behavior
Returns void
Inherited from GameObject.addBehavior
- Defined in Core/GameObject.ts:151

addChild

addChild(gameObject: GameObject): void
Add a child to this GameObject.
Parameters
- gameObject: GameObject
Returns void
Inherited from GameObject.addChild
- Defined in Core/GameObject.ts:128

destroy

destroy(): void
Detach all behaviors and children from this GameObject. Remove this GameObject from its parent.

Returns void
Inherited from GameObject.destroy
- Defined in Core/GameObject.ts:206

fillDependencies

fillDependencies(target: any): void
Fill dependencies in a target object using this GameObject's container and its parents (depending on decorators). If an Inject() decorator is found, the dependency will be resolved from this GameObject's container. (Recursively if specified) If a InjectGlobal() decorator is found, the dependency will be resolved from the engine's container.
Parameters
- target: any
  The target object to fill dependencies for.
Returns void
Inherited from GameObject.fillDependencies
- Defined in Core/GameObject.ts:229

getAllBehaviors

getAllBehaviors(): Behavior[]
Get all behaviors attached to this GameObject.

Returns Behavior[]
Inherited from GameObject.getAllBehaviors
- Defined in Core/GameObject.ts:198

getAllChildren

getAllChildren(): GameObject[]
Returns all children of this GameObject, including children of children, and so on. All the hierarchy. Does not include the GameObject itself.

Returns GameObject[]
Inherited from GameObject.getAllChildren
- Defined in Core/GameObject.ts:116

getBehaviors

getBehaviors<T extends Behavior>(BehaviorClass: new (...args: any[]) => T): T[]
Get all behaviors of a specific type attached to this GameObject.
Type Parameters
- T extends Behavior
Parameters
- BehaviorClass: new (...args: any[]) => T
Returns T[]
Inherited from GameObject.getBehaviors
- Defined in Core/GameObject.ts:189

getFirstBehavior

getFirstBehavior<T extends Behavior>(
BehaviorClass: new (...args: any[]) => T,
): null | T
Get the first behavior of a specific type attached to this GameObject or null if none is found.
Type Parameters
- T extends Behavior
Parameters
- BehaviorClass: new (...args: any[]) => T
Returns null | T
Inherited from GameObject.getFirstBehavior
- Defined in Core/GameObject.ts:178

`Protected`onDisable

onDisable(): void
Protected
When the GameObject is detached from the tree. (After destroy / cleanup)

Returns void
Inherited from GameObject.onDisable
- Defined in Core/GameObject.ts:294

`Protected`onEnable

onEnable(): void
Protected
When the GameObject is attached to the tree.

Returns void
Inherited from GameObject.onEnable
- Defined in Core/GameObject.ts:286

`Protected`onParentChange

onParentChange(): void
Protected
Called when parent changed

Returns void
Inherited from GameObject.onParentChange
- Defined in Core/GameObject.ts:280

removeBehavior

removeBehavior(behavior: Behavior): void
Remove a behavior from this GameObject. It will no longer be updated.
Parameters
- behavior: Behavior
Returns void
Inherited from GameObject.removeBehavior
- Defined in Core/GameObject.ts:165

removeChild

removeChild(gameObject: GameObject): void
Remove a child from this GameObject.
Parameters
- gameObject: GameObject
Returns void
Inherited from GameObject.removeChild
- Defined in Core/GameObject.ts:139

Class RootGameObject

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns RootGameObject

Properties

ReadonlygameWindowInstance

name

ReadonlyonBehaviorAdded

ReadonlyonBehaviorListChanged

ReadonlyonBehaviorRemoved

ReadonlyonChildAdded

ReadonlyonChildRemoved

Readonlytransform

Accessors

children

Returns GameObject[]

parent

Returns null | GameObject

Parameters

Returns void

root

Returns null | RootGameObject

Methods

addBehavior

Parameters

Returns void

addChild

Parameters

Returns void

destroy

Returns void

fillDependencies

Parameters

Returns void

getAllBehaviors

Returns Behavior[]

getAllChildren

Returns GameObject[]

getBehaviors

Type Parameters

Parameters

Returns T[]

getFirstBehavior

Type Parameters

Parameters

Returns null | T

ProtectedonDisable

Returns void

ProtectedonEnable

Returns void

ProtectedonParentChange

Returns void

removeBehavior

Parameters

Returns void

removeChild

Parameters

Returns void

Settings

On This Page

`Readonly`gameWindowInstance

`Readonly`onBehaviorAdded

`Readonly`onBehaviorListChanged

`Readonly`onBehaviorRemoved

`Readonly`onChildAdded

`Readonly`onChildRemoved

`Readonly`transform

`Protected`onDisable

`Protected`onEnable

`Protected`onParentChange