Options
All
  • Public
  • Public/Protected
  • All
Menu

The base class describing a debugger client, that can be used to inspect a runtime game (dump its state) or alter it.

Hierarchy

Index

Methods

  • call(path: string[], args: any[]): 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?

  • log(group: string, message: string, type: "info" | "warning" | "error", internal: boolean): void
  • Send a message (a log) to debugger server.

    Parameters

    • group: string
    • message: string
    • type: "info" | "warning" | "error"
    • internal: boolean

    Returns void

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

    Returns void

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

    Returns void

  • Send logs from the hot reloader to the server.

    Parameters

    Returns void

  • Send profiling results.

    Parameters

    • framesAverageMeasures: FrameMeasure

      The measures made for each frames.

    • stats: ProfilerStats

      Other measures done during the profiler run.

    Returns void

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

    Returns void

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

    Returns void

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

    Returns void

  • set(path: string[], newValue: any): 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?

  • handleCommand(data: any): 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

Constructors

Generated using TypeDoc