1681-engine / index / Engine
Class: Engine ​
Defined in: src/engine/Engine.ts:82
The top of the engine: a Pixi application, the Stage (world and screen layers, camera, tweens, timers, pointer), a fixed-step simulation loop and a stack of scenes.
const engine = await Engine.create({ parent: document.body, zoom: 3 });
await engine.scenes.replace(new MyLevel());Properties ​
app ​
readonly app: Application;Defined in: src/engine/Engine.ts:95
events ​
readonly events: EventBus<EngineEvents>;Defined in: src/engine/Engine.ts:86
loop ​
readonly loop: FixedLoop;Defined in: src/engine/Engine.ts:84
scenes ​
readonly scenes: SceneManager;Defined in: src/engine/Engine.ts:85
stage ​
readonly stage: Stage;Defined in: src/engine/Engine.ts:83
Accessors ​
paused ​
Get Signature ​
get paused(): boolean;Defined in: src/engine/Engine.ts:175
Returns ​
boolean
scene ​
Get Signature ​
get scene(): Scene | undefined;Defined in: src/engine/Engine.ts:133
The scene that updates now, if any.
Returns ​
Scene | undefined
Methods ​
destroy() ​
destroy(): Promise<void>;Defined in: src/engine/Engine.ts:186
Leaves every scene, removes the canvas and frees the renderer.
Returns ​
Promise<void>
pause() ​
pause(): void;Defined in: src/engine/Engine.ts:138
Stops simulating and drawing; the canvas keeps its last frame.
Returns ​
void
reportError() ​
reportError(where, error): void;Defined in: src/engine/Engine.ts:180
Reports a fault to events.error (and the console when nobody listens).
Parameters ​
| Parameter | Type |
|---|---|
where | string |
error | unknown |
Returns ​
void
resume() ​
resume(): void;Defined in: src/engine/Engine.ts:143
Returns ​
void
create() ​
static create(options): Promise<Engine>;Defined in: src/engine/Engine.ts:113
Parameters ​
| Parameter | Type |
|---|---|
options | EngineOptions |
Returns ​
Promise<Engine>