Debug
Defined in: packages/threeplay/src/plugins/debug/types.ts:16
The debug object (k.debug). Without a render overlay (headless) only the data API works.
Methods
Section titled “Methods”clearLog()
Section titled “clearLog()”clearLog():
void
Defined in: packages/threeplay/src/plugins/debug/types.ts:36
Clears on-screen messages.
Returns
Section titled “Returns”void
error()
Section titled “error()”error(…
msg):void
Defined in: packages/threeplay/src/plugins/debug/types.ts:34
Like log, in red, and through console.error.
Parameters
Section titled “Parameters”…unknown[]
Returns
Section titled “Returns”void
fps():
number
Defined in: packages/threeplay/src/plugins/debug/types.ts:28
Frames per second (smoothed).
Returns
Section titled “Returns”number
hovered()
Section titled “hovered()”hovered():
GameObj|null
Defined in: packages/threeplay/src/plugins/debug/types.ts:38
The object under the mouse (nearest visible hit), or null (also when there is no input or render).
Returns
Section titled “Returns”GameObj | null
log(…
msg):void
Defined in: packages/threeplay/src/plugins/debug/types.ts:32
Prints a message on screen (it fades after ~4 s) and in the console.
Parameters
Section titled “Parameters”…unknown[]
Returns
Section titled “Returns”void
objectCount()
Section titled “objectCount()”objectCount():
number
Defined in: packages/threeplay/src/plugins/debug/types.ts:30
Number of live objects.
Returns
Section titled “Returns”number
Properties
Section titled “Properties”inspect
Section titled “inspect”inspect:
boolean
Defined in: packages/threeplay/src/plugins/debug/types.ts:22
Shows the inspector: FPS, object count, renderer info and the components
of the object under the mouse, plus colliders (physics) or bounding boxes.
Setting it emits the debugInspect hook. The debugKey toggles it.
paused
Section titled “paused”paused:
boolean
Defined in: packages/threeplay/src/plugins/debug/types.ts:24
Pauses the game (rendering continues).
timeScale
Section titled “timeScale”timeScale:
number
Defined in: packages/threeplay/src/plugins/debug/types.ts:26
Game speed multiplier.