Class GameEngine

Main game engine class. Contains all the systems and components to run the game engine with minimum setup

Index

Constructors

Properties

animationSystem hierarchySystem imageLoader inputSystem physicsSystem renderer renderSystem soundSystem

Accessors

Methods

createScene removeScene run

Constructors

constructor

new GameEngine(config): GameEngine
Parameters
- config: GameEngineOptions
  The configuration to use for this instance of GameEngine
Returns GameEngine
- Defined in engine/GameEngine.ts:67

Properties

`Readonly`animationSystem

animationSystem: AnimationSystem

`Readonly`hierarchySystem

hierarchySystem: HierarchySystem

`Readonly`imageLoader

imageLoader: ImageLoader

`Readonly`inputSystem

inputSystem: InputSystem

`Readonly`physicsSystem

physicsSystem: PhysicsSystem

`Readonly`renderer

renderer: Renderer

`Readonly`renderSystem

renderSystem: RenderSystem

`Readonly`soundSystem

soundSystem: SoundSystem

Accessors

scenes

get scenes(): Scene[]
The list of scenes to render

Returns Scene[]
- Defined in engine/GameEngine.ts:60

Methods

createScene

createScene(shouldDraw?): Scene
This factory method creates a new Scene ensuring all the systems are linked to it The scene is automatically set to be drawn if it is the first scene created All the other scenes are instead kept hidden
Parameters
- shouldDraw: boolean = false
  Should the scene be drawn or hidden. Defaults to false
Returns Scene
newly created scene
- Defined in engine/GameEngine.ts:103

removeScene

removeScene(sceneId): void
Removes a scene from the engine. Also hides the scene if it is currently drawn
Parameters
- sceneId: string
  The id of the scene to remove
Returns void
- Defined in engine/GameEngine.ts:127

run

run(): void
Starts the main loop of the engine

Returns void
- Defined in engine/GameEngine.ts:89