Skip to content

DebugConfig

Defined in: DebugPlugin.ts:26

Configuration for the DebugPlugin.

optional flags?: Record<string, boolean>

Defined in: DebugPlugin.ts:40

Initial flag overrides, keyed by “contributorName.flagName”.


optional manualClock?: boolean

Defined in: DebugPlugin.ts:30

When true, stop the renderer ticker and advance simulation manually via window.__yage__.clock.


optional maxGraphics?: number

Defined in: DebugPlugin.ts:34

Max pooled Graphics objects. Default: 256


optional maxHudLines?: number

Defined in: DebugPlugin.ts:36

Max HUD text lines. Default: 32


optional startEnabled?: boolean

Defined in: DebugPlugin.ts:38

Whether the overlay starts enabled. Default: false


optional stepKey?: string

Defined in: DebugPlugin.ts:32

Key code to advance one fixed-timestep frame while manual clock mode is active. Default: “Period”


optional toggleKey?: string

Defined in: DebugPlugin.ts:28

Key code to toggle debug overlay. Default: “Backquote”