DebugPlugin
Defined in: DebugPlugin.ts:114
Debug overlay plugin. Mounts a private DebugScene through
SceneManager._mountDetached so it goes through the same scoped-DI
lifecycle as stacked scenes (the renderer’s beforeEnter hook creates
its render tree) while staying off the user-visible scene stack.
Implements
Section titled “Implements”Plugin
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new DebugPlugin(
config?):DebugPlugin
Defined in: DebugPlugin.ts:140
Parameters
Section titled “Parameters”config?
Section titled “config?”Returns
Section titled “Returns”DebugPlugin
Properties
Section titled “Properties”dependencies
Section titled “dependencies”
readonlydependencies: readonly ["renderer"]
Defined in: DebugPlugin.ts:117
Names of plugins this plugin depends on.
Implementation of
Section titled “Implementation of”Plugin.dependencies
readonlyname:"debug"="debug"
Defined in: DebugPlugin.ts:115
Unique plugin name.
Implementation of
Section titled “Implementation of”Plugin.name
version
Section titled “version”
readonlyversion:"3.0.0"="3.0.0"
Defined in: DebugPlugin.ts:116
Semantic version string.
Implementation of
Section titled “Implementation of”Plugin.version
Methods
Section titled “Methods”install()
Section titled “install()”install(
context):void
Defined in: DebugPlugin.ts:144
Install services into the engine context. Called in topological order.
Parameters
Section titled “Parameters”context
Section titled “context”EngineContext
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Plugin.install
onDestroy()
Section titled “onDestroy()”onDestroy():
void
Defined in: DebugPlugin.ts:265
Called when the engine is destroyed.
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Plugin.onDestroy
onStart()
Section titled “onStart()”onStart():
Promise<void>
Defined in: DebugPlugin.ts:186
Called after all plugins are installed and the engine has started.
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”Plugin.onStart
registerSystems()
Section titled “registerSystems()”registerSystems(
scheduler):void
Defined in: DebugPlugin.ts:180
Register systems with the scheduler. Called after install.
Parameters
Section titled “Parameters”scheduler
Section titled “scheduler”SystemScheduler
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Plugin.registerSystems