Class Engine

Main game engine responsible for bootstrapping scenes and systems, managing the game loop, and controlling lifecycle actions (play, pause, stop).

Index

Constructors

Methods

pause play stop

Constructors

constructor

new Engine(options: EngineOptions): Engine
Creates a new engine instance.
Parameters
- options: EngineOptions
  Configuration, available systems, components, and asset kinds, and optional shared resources.
  - assets: AssetConstructor[]
  - components: ComponentConstructor[]
  - config: Config
  - Optionalresources?: Record<string, unknown>
  - systems: SystemConstructor[]
Returns Engine

Methods

pause

pause(): void

Pauses the engine by stopping the game loop. The world and scene state remain in memory so it can be resumed with play.

Returns void

play

play(): Promise<void>

Starts the engine. If the engine was already initialized, this resumes the game loop and re-attaches window listeners. Otherwise, it bootstraps the world, loads the start scene, creates the game loop, and begins execution.

Returns Promise<void>
A promise that resolves once the engine is fully started.

Throws
Error If startSceneId is not provided in the config.

Throws
Error If any component is missing componentName.

Throws
Error If any system is missing systemName.

Throws
Error If any asset class is missing assetName.

stop

stop(): void

Stops the engine completely by stopping the game loop and destroying the world.

Returns void