Interface EnginePlugin

Lifecycle hooks for extending the engine.

interface EnginePlugin {
    name: string;
    destroy?(engine: Engine): void;
    init?(engine: Engine): void;
    render?(engine: Engine, alpha: number): void;
    update?(engine: Engine, dt: number): void;
}

Implemented by

DebugOverlayPlugin

Index

Properties

Methods

destroy? init? render? update?

Properties

name

name: string

Unique plugin identifier.

Methods

`Optional`destroy

destroy?(engine: Engine): void
Called when the engine is destroyed.
Parameters
- engine: Engine
Returns void
- Defined in core/engine.ts:22

`Optional`init

init?(engine: Engine): void
Called once when the plugin is registered.
Parameters
- engine: Engine
Returns void
- Defined in core/engine.ts:16

`Optional`render

render?(engine: Engine, alpha: number): void
Called each frame during the render phase.
Parameters
- engine: Engine
- alpha: number
Returns void
- Defined in core/engine.ts:20

`Optional`update

update?(engine: Engine, dt: number): void
Called each frame during the update phase.
Parameters
- engine: Engine
- dt: number
Returns void
- Defined in core/engine.ts:18