: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/EditorDebuggerPlugin.xml. .. _class_EditorDebuggerPlugin: EditorDebuggerPlugin ==================== **Inherits:** :ref:`RefCounted` **<** :ref:`Object` A base class to implement debugger plugins. .. rst-class:: classref-introduction-group Description ----------- **EditorDebuggerPlugin** provides functions related to the editor side of the debugger. To interact with the debugger, an instance of this class must be added to the editor via :ref:`EditorPlugin.add_debugger_plugin()`. Once added, the :ref:`_setup_session()` callback will be called for every :ref:`EditorDebuggerSession` available to the plugin, and when new ones are created (the sessions may be inactive during this stage). You can retrieve the available :ref:`EditorDebuggerSession`\ s via :ref:`get_sessions()` or get a specific one via :ref:`get_session()`. .. tabs:: .. code-tab:: gdscript @tool extends EditorPlugin class ExampleEditorDebugger extends EditorDebuggerPlugin: func _has_capture(capture): # Return true if you wish to handle messages with the prefix "my_plugin:". return capture == "my_plugin" func _capture(message, data, session_id): if message == "my_plugin:ping": get_session(session_id).send_message("my_plugin:echo", data) return true return false func _setup_session(session_id): # Add a new tab in the debugger session UI containing a label. var label = Label.new() label.name = "Example plugin" # Will be used as the tab title. label.text = "Example plugin" var session = get_session(session_id) # Listens to the session started and stopped signals. session.started.connect(func (): print("Session started")) session.stopped.connect(func (): print("Session stopped")) session.add_session_tab(label) var debugger = ExampleEditorDebugger.new() func _enter_tree(): add_debugger_plugin(debugger) func _exit_tree(): remove_debugger_plugin(debugger) To connect on the running game side, use the :ref:`EngineDebugger` singleton: .. tabs:: .. code-tab:: gdscript extends Node func _ready(): EngineDebugger.register_message_capture("my_plugin", _capture) EngineDebugger.send_message("my_plugin:ping", ["test"]) func _capture(message, data): # Note that the "my_plugin:" prefix is not used here. if message == "echo": prints("Echo received:", data) return true return false \ **Note:** While the game is running, :ref:`@GlobalScope.print()` and similar functions *called in the editor* do not print anything, the Output Log prints only game messages. .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_breakpoint_set_in_tree`\ (\ script\: :ref:`Script`, line\: :ref:`int`, enabled\: :ref:`bool`\ ) |virtual| | +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_breakpoints_cleared_in_tree`\ (\ ) |virtual| | +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_capture`\ (\ message\: :ref:`String`, data\: :ref:`Array`, session_id\: :ref:`int`\ ) |virtual| | +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_goto_script_line`\ (\ script\: :ref:`Script`, line\: :ref:`int`\ ) |virtual| | +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_has_capture`\ (\ capture\: :ref:`String`\ ) |virtual| |const| | +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_setup_session`\ (\ session_id\: :ref:`int`\ ) |virtual| | +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`EditorDebuggerSession` | :ref:`get_session`\ (\ id\: :ref:`int`\ ) | +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_sessions`\ (\ ) | +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_EditorDebuggerPlugin_private_method__breakpoint_set_in_tree: .. rst-class:: classref-method |void| **_breakpoint_set_in_tree**\ (\ script\: :ref:`Script`, line\: :ref:`int`, enabled\: :ref:`bool`\ ) |virtual| :ref:`🔗` Override this method to be notified when a breakpoint is set in the editor. .. rst-class:: classref-item-separator ---- .. _class_EditorDebuggerPlugin_private_method__breakpoints_cleared_in_tree: .. rst-class:: classref-method |void| **_breakpoints_cleared_in_tree**\ (\ ) |virtual| :ref:`🔗` Override this method to be notified when all breakpoints are cleared in the editor. .. rst-class:: classref-item-separator ---- .. _class_EditorDebuggerPlugin_private_method__capture: .. rst-class:: classref-method :ref:`bool` **_capture**\ (\ message\: :ref:`String`, data\: :ref:`Array`, session_id\: :ref:`int`\ ) |virtual| :ref:`🔗` Override this method to process incoming messages. The ``session_id`` is the ID of the :ref:`EditorDebuggerSession` that received the ``message``. Use :ref:`get_session()` to retrieve the session. This method should return ``true`` if the message is recognized. .. rst-class:: classref-item-separator ---- .. _class_EditorDebuggerPlugin_private_method__goto_script_line: .. rst-class:: classref-method |void| **_goto_script_line**\ (\ script\: :ref:`Script`, line\: :ref:`int`\ ) |virtual| :ref:`🔗` Override this method to be notified when a breakpoint line has been clicked in the debugger breakpoint panel. .. rst-class:: classref-item-separator ---- .. _class_EditorDebuggerPlugin_private_method__has_capture: .. rst-class:: classref-method :ref:`bool` **_has_capture**\ (\ capture\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` Override this method to enable receiving messages from the debugger. If ``capture`` is "my_message" then messages starting with "my_message:" will be passed to the :ref:`_capture()` method. .. rst-class:: classref-item-separator ---- .. _class_EditorDebuggerPlugin_private_method__setup_session: .. rst-class:: classref-method |void| **_setup_session**\ (\ session_id\: :ref:`int`\ ) |virtual| :ref:`🔗` Override this method to be notified whenever a new :ref:`EditorDebuggerSession` is created. Note that the session may be inactive during this stage. .. rst-class:: classref-item-separator ---- .. _class_EditorDebuggerPlugin_method_get_session: .. rst-class:: classref-method :ref:`EditorDebuggerSession` **get_session**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Returns the :ref:`EditorDebuggerSession` with the given ``id``. .. rst-class:: classref-item-separator ---- .. _class_EditorDebuggerPlugin_method_get_sessions: .. rst-class:: classref-method :ref:`Array` **get_sessions**\ (\ ) :ref:`🔗` Returns an array of :ref:`EditorDebuggerSession` currently available to this debugger plugin. \ **Note:** Sessions in the array may be inactive, check their state via :ref:`EditorDebuggerSession.is_active()`. .. |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.)`