KAPLAY Docs, Debug

An interface for debugging the game.

group Debug

paused

: boolean

Pause the whole game.

: boolean

Draw bounding boxes of all objects with area() component, hover to inspect their states.

: number

Global time scale.

: boolean

Show the debug log or not.

(): number

Current frames per second.

(): number

Total number of frames elapsed.

since v3000.0

(): number

Number of draw calls made last frame.

(): void

Step to the next frame. Useful with pausing.

(): void

Clear the debug log.

(msg: any): void

Log some text to on screen debug log.

(msg: any): void

Log an error message to on screen debug log.

: Recording | null

The recording handle if currently in recording mode.

since v2000.1

(): number

Get total number of objects.

since v3001.0