:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorDebuggerSession.xml. .. _class_EditorDebuggerSession: EditorDebuggerSession ===================== **Inherits:** :ref:`RefCounted` **<** :ref:`Object` A class to interact with the editor debugger. .. rst-class:: classref-introduction-group Description ----------- This class cannot be directly instantiated and must be retrieved via an :ref:`EditorDebuggerPlugin`. You can add tabs to the session UI via :ref:`add_session_tab()`, send messages via :ref:`send_message()`, and toggle :ref:`EngineProfiler`\ s via :ref:`toggle_profiler()`. .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_session_tab`\ (\ control\: :ref:`Control`\ ) | +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_active`\ (\ ) | +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_breaked`\ (\ ) | +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_debuggable`\ (\ ) | +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_session_tab`\ (\ control\: :ref:`Control`\ ) | +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`send_message`\ (\ message\: :ref:`String`, data\: :ref:`Array` = []\ ) | +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_breakpoint`\ (\ path\: :ref:`String`, line\: :ref:`int`, enabled\: :ref:`bool`\ ) | +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`toggle_profiler`\ (\ profiler\: :ref:`String`, enable\: :ref:`bool`, data\: :ref:`Array` = []\ ) | +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_EditorDebuggerSession_signal_breaked: .. rst-class:: classref-signal **breaked**\ (\ can_debug\: :ref:`bool`\ ) :ref:`🔗` Emitted when the attached remote instance enters a break state. If ``can_debug`` is ``true``, the remote instance will enter the debug loop. .. rst-class:: classref-item-separator ---- .. _class_EditorDebuggerSession_signal_continued: .. rst-class:: classref-signal **continued**\ (\ ) :ref:`🔗` Emitted when the attached remote instance exits a break state. .. rst-class:: classref-item-separator ---- .. _class_EditorDebuggerSession_signal_started: .. rst-class:: classref-signal **started**\ (\ ) :ref:`🔗` Emitted when a remote instance is attached to this session (i.e. the session becomes active). .. rst-class:: classref-item-separator ---- .. _class_EditorDebuggerSession_signal_stopped: .. rst-class:: classref-signal **stopped**\ (\ ) :ref:`🔗` Emitted when a remote instance is detached from this session (i.e. the session becomes inactive). .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_EditorDebuggerSession_method_add_session_tab: .. rst-class:: classref-method |void| **add_session_tab**\ (\ control\: :ref:`Control`\ ) :ref:`🔗` 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. .. rst-class:: classref-item-separator ---- .. _class_EditorDebuggerSession_method_is_active: .. rst-class:: classref-method :ref:`bool` **is_active**\ (\ ) :ref:`🔗` Returns ``true`` if the debug session is currently attached to a remote instance. .. rst-class:: classref-item-separator ---- .. _class_EditorDebuggerSession_method_is_breaked: .. rst-class:: classref-method :ref:`bool` **is_breaked**\ (\ ) :ref:`🔗` Returns ``true`` if the attached remote instance is currently in the debug loop. .. rst-class:: classref-item-separator ---- .. _class_EditorDebuggerSession_method_is_debuggable: .. rst-class:: classref-method :ref:`bool` **is_debuggable**\ (\ ) :ref:`🔗` Returns ``true`` if the attached remote instance can be debugged. .. rst-class:: classref-item-separator ---- .. _class_EditorDebuggerSession_method_remove_session_tab: .. rst-class:: classref-method |void| **remove_session_tab**\ (\ control\: :ref:`Control`\ ) :ref:`🔗` Removes the given ``control`` from the debug session UI in the debugger bottom panel. .. rst-class:: classref-item-separator ---- .. _class_EditorDebuggerSession_method_send_message: .. rst-class:: classref-method |void| **send_message**\ (\ message\: :ref:`String`, data\: :ref:`Array` = []\ ) :ref:`🔗` Sends the given ``message`` to the attached remote instance, optionally passing additionally ``data``. See :ref:`EngineDebugger` for how to retrieve those messages. .. rst-class:: classref-item-separator ---- .. _class_EditorDebuggerSession_method_set_breakpoint: .. rst-class:: classref-method |void| **set_breakpoint**\ (\ path\: :ref:`String`, line\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` Enables or disables a specific breakpoint based on ``enabled``, updating the Editor Breakpoint Panel accordingly. .. rst-class:: classref-item-separator ---- .. _class_EditorDebuggerSession_method_toggle_profiler: .. rst-class:: classref-method |void| **toggle_profiler**\ (\ profiler\: :ref:`String`, enable\: :ref:`bool`, data\: :ref:`Array` = []\ ) :ref:`🔗` Toggle the given ``profiler`` on the attached remote instance, optionally passing additionally ``data``. See :ref:`EngineProfiler` for more details. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`