Skip to content
ClassDebugger & Diagnostics@public

FlxDebugger ​

DOM overlay debugger with Console, Log, Watch, Perf, VCR, and Vis panels. Mounts as a fixed bottom bar. Fully keyboard/screen-reader accessible.

ts
export declare class FlxDebugger

Constructors ​

ts
constructor(options?: FlxDebuggerOptions)

Constructs a new instance of the FlxDebugger class

ParameterTypeDescription
optionsFlxDebuggerOptions-

Properties ​

PropertyModifiersTypeDescription
consolereadonlyFlxConsole-
diagnosticsreadonlyFlxDiagnostics-
visiblereadonlyboolean-

Methods ​

captureDiagnostics() ​

ts
captureDiagnostics(): FlxDebuggerDiagnosticSnapshot

Returns: FlxDebuggerDiagnosticSnapshot

destroy() ​

ts
destroy(): void

Returns: void

exportDiagnostics() ​

ts
exportDiagnostics(pretty?: boolean): string

Parameters:

ParameterTypeDescription
prettyboolean-

Returns: string

hide() ​

ts
hide(): void

Returns: void

setVCRCallbacks() ​

ts
setVCRCallbacks(callbacks: FlxDebuggerVCRCallbacks): void

Wire up VCR panel callbacks.

Parameters:

ParameterTypeDescription
callbacksFlxDebuggerVCRCallbacks-

Returns: void

show() ​

ts
show(): void

Returns: void

subscribeToChannel() ​

ts
subscribeToChannel(channel: DebugChannel, log: FlxLog, watch: FlxWatch): void

Subscribe to a DebugChannel to receive step-complete, log, and watch events.

Parameters:

ParameterTypeDescription
channelDebugChannel-
logFlxLog-
watchFlxWatch-

Returns: void

toggle() ​

ts
toggle(): void

Returns: void

Released under the MIT License.