Class WebsocketDebuggerClient

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

Hierarchy (view full)

AbstractDebuggerClient
- WebsocketDebuggerClient

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:640

`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:506

launchHardReload

launchHardReload(): void
Returns void
Inherited from AbstractDebuggerClient.launchHardReload
- Defined in GDJS/Runtime/debugger-client/abstract-debugger-client.ts:982

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:576

onUncaughtException

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

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:755

sendInstanceChanges

sendInstanceChanges(changes): void
Parameters
- changes: {
      addedInstances: InstanceData[];
      isSendingBackSelectionForDefaultSize: boolean;
      objectNameToEdit: null | string;
      removedInstances: InstancePersistentUuidData[];
      selectedInstances: InstancePersistentUuidData[];
      updatedInstances: InstanceData[];
  }
  - addedInstances: InstanceData[]
  - isSendingBackSelectionForDefaultSize: boolean
  - objectNameToEdit: null | string
  - removedInstances: InstancePersistentUuidData[]
  - selectedInstances: InstancePersistentUuidData[]
  - updatedInstances: InstanceData[]
Returns void
Inherited from AbstractDebuggerClient.sendInstanceChanges
- Defined in GDJS/Runtime/debugger-client/abstract-debugger-client.ts:791

sendKeyboardShortcut

sendKeyboardShortcut(keyEventLike): void
Parameters
- keyEventLike: {
      altKey: boolean;
      ctrlKey: boolean;
      keyCode: number;
      metaKey: boolean;
      shiftKey: boolean;
  }
  - altKey: boolean
  - ctrlKey: boolean
  - keyCode: number
  - metaKey: boolean
  - shiftKey: boolean
Returns void
Inherited from AbstractDebuggerClient.sendKeyboardShortcut
- Defined in GDJS/Runtime/debugger-client/abstract-debugger-client.ts:910

sendOpenContextMenu

sendOpenContextMenu(cursorX, cursorY): void
Parameters
- cursorX: number
- cursorY: number
Returns void
Inherited from AbstractDebuggerClient.sendOpenContextMenu
- Defined in GDJS/Runtime/debugger-client/abstract-debugger-client.ts:812

sendPaste

sendPaste(): void
Returns void
Inherited from AbstractDebuggerClient.sendPaste
- Defined in GDJS/Runtime/debugger-client/abstract-debugger-client.ts:882

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:967

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:770

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:782

sendRedo

sendRedo(): void
Returns void
Inherited from AbstractDebuggerClient.sendRedo
- Defined in GDJS/Runtime/debugger-client/abstract-debugger-client.ts:854

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:682

sendRuntimeGameStatus

sendRuntimeGameStatus(): void
Returns void
Inherited from AbstractDebuggerClient.sendRuntimeGameStatus
- Defined in GDJS/Runtime/debugger-client/abstract-debugger-client.ts:665

sendSelectionAABB

sendSelectionAABB(messageId): void
Parameters
- messageId: number
Returns void
Inherited from AbstractDebuggerClient.sendSelectionAABB
- Defined in GDJS/Runtime/debugger-client/abstract-debugger-client.ts:930

sendUndo

sendUndo(): void
Returns void
Inherited from AbstractDebuggerClient.sendUndo
- Defined in GDJS/Runtime/debugger-client/abstract-debugger-client.ts:840

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:602

`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:238

Class WebsocketDebuggerClient

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WebsocketDebuggerClient

Properties

Private hasLoggedError

Methods

call

Parameters

Returns boolean

Static isErrorComingFromJavaScriptCode

Parameters

Returns boolean

launchHardReload

Returns void

log

Parameters

Returns void

onUncaughtException

Parameters

Returns void

sendCameraState

Parameters

Returns void

sendCopy

Returns void

sendCut

Returns void

sendHotReloaderLogs

Parameters

Returns void

sendInstanceChanges

Parameters

addedInstances: InstanceData[]

isSendingBackSelectionForDefaultSize: boolean

objectNameToEdit: null | string

removedInstances: InstancePersistentUuidData[]

selectedInstances: InstancePersistentUuidData[]

updatedInstances: InstanceData[]

Returns void

sendKeyboardShortcut

Parameters

altKey: boolean

ctrlKey: boolean

keyCode: number

metaKey: boolean

shiftKey: boolean

Returns void

sendOpenContextMenu

Parameters

Returns void

sendPaste

Returns void

sendProfilerOutput

Parameters

Returns void

sendProfilerStarted

Returns void

sendProfilerStopped

Returns void

sendRedo

Returns void

sendRuntimeGameDump

Returns void

sendRuntimeGameStatus

Returns void

sendSelectionAABB

Parameters

Returns void

sendUndo

Returns void

set

Parameters

Returns boolean

`Private` hasLoggedError

`Static` isErrorComingFromJavaScriptCode

`Protected` handleCommand