Class EditorDebuggerSession

A class to interact with the editor debugger.

Inheritance

RefCounted

Object

EditorDebuggerSession

Remarks

This class cannot be directly instantiated and must be retrieved via a EditorDebuggerPlugin.

You can add tabs to the session UI via EditorDebuggerSession.add_session_tab, send messages via EditorDebuggerSession.send_message, and toggle EngineProfilers via EditorDebuggerSession.toggle_profiler.

Methods

add_session_tab(Control)

Adds the given control to the debug session UI in the debugger bottom panel. The control's node name will be used as the tab title.

void add_session_tab(Control control)

Parameters

control Control

is_active

Returns true if the debug session is currently attached to a remote instance.

bool is_active

is_breaked

Returns true if the attached remote instance is currently in the debug loop.

bool is_breaked

is_debuggable

Returns true if the attached remote instance can be debugged.

bool is_debuggable

remove_session_tab(Control)

Removes the given control from the debug session UI in the debugger bottom panel.

void remove_session_tab(Control control)

Parameters

control Control

send_message(String, Array)

Sends the given message to the attached remote instance, optionally passing additionally data. See EngineDebugger for how to retrieve those messages.

void send_message(String message, Array data)

Parameters

message String

data Array

set_breakpoint(String, int, bool)

Enables or disables a specific breakpoint based on enabled, updating the Editor Breakpoint Panel accordingly.

void set_breakpoint(String path, int line, bool enabled)

Parameters

path String

line int

enabled bool

toggle_profiler(String, bool, Array)

Toggle the given profiler on the attached remote instance, optionally passing additionally data. See EngineProfiler for more details.

void toggle_profiler(String profiler, bool enable, Array data)

Parameters

profiler String

enable bool

data Array

Events

breaked(bool)

Emitted when the attached remote instance enters a break state. If can_debug is true, the remote instance will enter the debug loop.

signal breaked(bool can_debug)

Parameters

can_debug bool

continued

Emitted when the attached remote instance exits a break state.

signal continued

started

Emitted when a remote instance is attached to this session (i.e. the session becomes active).

signal started

stopped

Emitted when a remote instance is detached from this session (i.e. the session becomes inactive).

signal stopped