Index · Object → RefCounted → EditorDebuggerSession

EditorDebuggerSession

A class to interact with the editor debugger.

Class Description

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

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

Methods

func add_session_tab(control: Control) -> void

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.

func is_active() -> bool

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

func is_breaked() -> bool

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

func is_debuggable() -> bool

Returns true if the attached remote instance can be debugged.

func remove_session_tab(control: Control) -> void

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

func send_message(message: String, data: Array = []) -> void

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

func set_breakpoint(path: String, line: int, enabled: bool) -> void

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

func toggle_profiler(profiler: String, enable: bool, data: Array = []) -> void

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

Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

signal breaked(can_debug: 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 continued()

Emitted when the attached remote instance exits a break state.

signal started()

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

signal stopped()

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

Inherited from Object (2)