Class GameEngineWindow

GameEngineWindow

Description

Singleton class that represents the game engine window.

Index

Constructors

Accessors

injectionContainer root

Methods

addGameComponent dispose getEngineComponent

Constructors

constructor

new GameEngineWindow(logicTicker: Ticker): GameEngineWindow
Creates an instance of GameEngineWindow.
Parameters
- logicTicker: Ticker
  The ticker that will be used to update the game logic.
Returns GameEngineWindow
- Defined in Core/GameEngineWindow.ts:21

Accessors

injectionContainer

get injectionContainer(): DependencyContainer
Returns DependencyContainer
Description
Dependency injection container for the game engine window. Can be used to store engine-wide dependencies and global logic components.
- Defined in Core/GameEngineWindow.ts:40

root

get root(): RootGameObject
Returns RootGameObject
Description
Root GameObject of the game engine window, it will serve to be like a singleton that will contain all the other GameObjects.
- Defined in Core/GameEngineWindow.ts:32

Methods

addGameComponent

addGameComponent(component: GameEngineComponent): void
Parameters
- component: GameEngineComponent
Returns void
Description
Adds a GameEngineComponent to the game engine window unless it is already attached.
- Defined in Core/GameEngineWindow.ts:48

dispose

dispose(): void
Returns void
Description
Disposes of the GameEngineWindow and all of its components.
- Defined in Core/GameEngineWindow.ts:71

getEngineComponent

getEngineComponent<T extends GameEngineComponent>(
componentClass: new (...args: any[]) => T,
): null | T
Type Parameters
- T extends GameEngineComponent
Parameters
- componentClass: new (...args: any[]) => T
Returns null | T
Description
Returns a GameEngineComponent of the specified type.
- Defined in Core/GameEngineWindow.ts:60