Class DebugOverlayPlugin

Engine plugin that renders a debug overlay.

Implements

EnginePlugin

Index

Constructors

Properties

Methods

destroy init render update

Constructors

constructor

new DebugOverlayPlugin(): DebugOverlayPlugin
Returns DebugOverlayPlugin

Properties

`Readonly`name

name: "debugOverlay"

Plugin name.

Methods

destroy

destroy(_engine: Engine): void
Clean up the plugin.
Parameters
- _engine: Engine
Returns void
Implementation of EnginePlugin.destroy
- Defined in plugins/debugOverlayPlugin.ts:179

init

init(_engine: Engine): void
Initialize the plugin.
Parameters
- _engine: Engine
Returns void
Implementation of EnginePlugin.init
- Defined in plugins/debugOverlayPlugin.ts:35

render

render(_engine: Engine, _alpha: number): void
Render the debug overlay.
Parameters
- _engine: Engine
- _alpha: number
Returns void
Implementation of EnginePlugin.render
- Defined in plugins/debugOverlayPlugin.ts:54

update

update(engine: Engine, _dt: number): void
Update the plugin logic, checking for toggle input.
Parameters
- engine: Engine
- _dt: number
Returns void
Implementation of EnginePlugin.update
- Defined in plugins/debugOverlayPlugin.ts:40