Class WebsocketDebuggerClient

This debugger client connects to a websocket server, exchanging and receiving messages with this server.

Hierarchy (view full)

AbstractDebuggerClient
- WebsocketDebuggerClient

Index

Constructors

Properties

Methods

call isErrorComingFromJavaScriptCode log onUncaughtException sendGamePaused sendGameResumed sendHotReloaderLogs sendProfilerOutput sendProfilerStarted sendProfilerStopped sendRuntimeGameDump set handleCommand

Constructors

constructor

new WebsocketDebuggerClient(runtimeGame): WebsocketDebuggerClient
Parameters
- runtimeGame: RuntimeGame
Returns WebsocketDebuggerClient
Overrides AbstractDebuggerClient.constructor
- Defined in GDJS/Runtime/debugger-client/websocket-debugger-client.ts:11

Properties

`Private` hasLoggedError

hasLoggedError: boolean = false

Methods

call

call(path, args): boolean
Call a method, specified by a path starting from the RuntimeGame instance.
Parameters
- path: string[]
  The path to the method, starting from RuntimeGame.
- args: any[]
  The arguments to pass the method.
Returns boolean
Was the operation successful?
Inherited from AbstractDebuggerClient.call
- Defined in GDJS/Runtime/debugger-client/abstract-debugger-client.ts:413

`Static` isErrorComingFromJavaScriptCode

isErrorComingFromJavaScriptCode(exception): boolean
Parameters
- exception: null | Error
Returns boolean
Inherited from AbstractDebuggerClient.isErrorComingFromJavaScriptCode
- Defined in GDJS/Runtime/debugger-client/abstract-debugger-client.ts:282

log

log(group, message, type, internal): void
Send a message (a log) to debugger server.
Parameters
- group: string
- message: string
- type: "error" | "info" | "warning"
- internal: boolean
Returns void
Inherited from AbstractDebuggerClient.log
- Defined in GDJS/Runtime/debugger-client/abstract-debugger-client.ts:349

onUncaughtException

onUncaughtException(exception): void
Parameters
- exception: Error
Returns void
Inherited from AbstractDebuggerClient.onUncaughtException
- Defined in GDJS/Runtime/debugger-client/abstract-debugger-client.ts:332

sendGamePaused

sendGamePaused(): void
Callback called when the game is paused.

Returns void
Inherited from AbstractDebuggerClient.sendGamePaused
- Defined in GDJS/Runtime/debugger-client/abstract-debugger-client.ts:550

sendGameResumed

sendGameResumed(): void
Callback called when the game is resumed.

Returns void
Inherited from AbstractDebuggerClient.sendGameResumed
- Defined in GDJS/Runtime/debugger-client/abstract-debugger-client.ts:562

sendHotReloaderLogs

sendHotReloaderLogs(logs): void
Send logs from the hot reloader to the server.
Parameters
- logs: HotReloaderLog[]
  The hot reloader logs.
Returns void
Inherited from AbstractDebuggerClient.sendHotReloaderLogs
- Defined in GDJS/Runtime/debugger-client/abstract-debugger-client.ts:514

sendProfilerOutput

sendProfilerOutput(framesAverageMeasures, stats): void
Send profiling results.
Parameters
- framesAverageMeasures: FrameMeasure
  The measures made for each frames.
- stats: ProfilerStats
  Other measures done during the profiler run.
Returns void
Inherited from AbstractDebuggerClient.sendProfilerOutput
- Defined in GDJS/Runtime/debugger-client/abstract-debugger-client.ts:576

sendProfilerStarted

sendProfilerStarted(): void
Callback called when profiling is starting.

Returns void
Inherited from AbstractDebuggerClient.sendProfilerStarted
- Defined in GDJS/Runtime/debugger-client/abstract-debugger-client.ts:526

sendProfilerStopped

sendProfilerStopped(): void
Callback called when profiling is ending.

Returns void
Inherited from AbstractDebuggerClient.sendProfilerStopped
- Defined in GDJS/Runtime/debugger-client/abstract-debugger-client.ts:538

sendRuntimeGameDump

sendRuntimeGameDump(): void
Dump all the relevant data from the RuntimeGame instance and send it to the server.

Returns void
Inherited from AbstractDebuggerClient.sendRuntimeGameDump
- Defined in GDJS/Runtime/debugger-client/abstract-debugger-client.ts:441

set

set(path, newValue): boolean
Update a value, specified by a path starting from the RuntimeGame instance.
Parameters
- path: string[]
  The path to the variable, starting from RuntimeGame.
- newValue: any
  The new value.
Returns boolean
Was the operation successful?
Inherited from AbstractDebuggerClient.set
- Defined in GDJS/Runtime/debugger-client/abstract-debugger-client.ts:375

`Protected` handleCommand

handleCommand(data): void
Should be called by derived class to handle a command received from the debugger server.
Parameters
- data: any
  An object containing the command to do.
Returns void
Inherited from AbstractDebuggerClient.handleCommand
- Defined in GDJS/Runtime/debugger-client/abstract-debugger-client.ts:233