AbstractDebuggerClient

AbstractDebuggerClient

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

Constructor

new AbstractDebuggerClient()

Source:

Methods

call(path, args)

Call a method, specified by a path starting from the RuntimeGame instance.

Parameters:
Name Type Description
path

The path to the method, starting from RuntimeGame.

args

The arguments to pass the method.

Returns:
Type Description

Was the operation successful?

Source:

handleCommand(data)

Should be called by derived class to handle a command received from the debugger server.

Parameters:
Name Type Description
data

An object containing the command to do.

Source:

log()

Send a message (a log) to debugger server.

Source:

sendHotReloaderLogs(logs)

Send logs from the hot reloader to the server.

Parameters:
Name Type Description
logs

The hot reloader logs.

Source:

sendProfilerOutput(framesAverageMeasures, stats)

Send profiling results.

Parameters:
Name Type Description
framesAverageMeasures

The measures made for each frames.

stats

Other measures done during the profiler run.

Source:

sendProfilerStarted()

Callback called when profiling is starting.

Source:

sendProfilerStopped()

Callback called when profiling is ending.

Source:

sendRuntimeGameDump()

Dump all the relevant data from the RuntimeGame instance and send it to the server.

Source:

set(path, newValue)

Update a value, specified by a path starting from the RuntimeGame instance.

Parameters:
Name Type Description
path

The path to the variable, starting from RuntimeGame.

newValue

The new value.

Returns:
Type Description

Was the operation successful?

Source: