mirror of
https://github.com/godotengine/godot.git
synced 2024-12-09 10:09:20 +08:00
89 lines
3.2 KiB
XML
89 lines
3.2 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="EditorDebuggerPlugin" inherits="Control" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<brief_description>
|
|
A base class to implement debugger plugins.
|
|
</brief_description>
|
|
<description>
|
|
[EditorDebuggerPlugin] provides functions related to the editor side of the debugger.
|
|
You don't need to instantiate this class; that is automatically handled by the debugger. [Control] nodes can be added as child nodes to provide a GUI for the plugin.
|
|
Do not free or reparent this node, otherwise it becomes unusable.
|
|
To use [EditorDebuggerPlugin], register it using the [method EditorPlugin.add_debugger_plugin] method first.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="has_capture">
|
|
<return type="bool" />
|
|
<param index="0" name="name" type="StringName" />
|
|
<description>
|
|
Returns [code]true[/code] if a message capture with given name is present otherwise [code]false[/code].
|
|
</description>
|
|
</method>
|
|
<method name="is_breaked">
|
|
<return type="bool" />
|
|
<description>
|
|
Returns [code]true[/code] if the game is in break state otherwise [code]false[/code].
|
|
</description>
|
|
</method>
|
|
<method name="is_debuggable">
|
|
<return type="bool" />
|
|
<description>
|
|
Returns [code]true[/code] if the game can be debugged otherwise [code]false[/code].
|
|
</description>
|
|
</method>
|
|
<method name="is_session_active">
|
|
<return type="bool" />
|
|
<description>
|
|
Returns [code]true[/code] if there is an instance of the game running with the attached debugger otherwise [code]false[/code].
|
|
</description>
|
|
</method>
|
|
<method name="register_message_capture">
|
|
<return type="void" />
|
|
<param index="0" name="name" type="StringName" />
|
|
<param index="1" name="callable" type="Callable" />
|
|
<description>
|
|
Registers a message capture with given [param name]. If [param name] is "my_message" then messages starting with "my_message:" will be called with the given callable.
|
|
Callable must accept a message string and a data array as argument. If the message and data are valid then callable must return [code]true[/code] otherwise [code]false[/code].
|
|
</description>
|
|
</method>
|
|
<method name="send_message">
|
|
<return type="void" />
|
|
<param index="0" name="message" type="String" />
|
|
<param index="1" name="data" type="Array" />
|
|
<description>
|
|
Sends a message with given [param message] and [param data] array.
|
|
</description>
|
|
</method>
|
|
<method name="unregister_message_capture">
|
|
<return type="void" />
|
|
<param index="0" name="name" type="StringName" />
|
|
<description>
|
|
Unregisters the message capture with given name.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<signals>
|
|
<signal name="breaked">
|
|
<param index="0" name="can_debug" type="bool" />
|
|
<description>
|
|
Emitted when the game enters a break state.
|
|
</description>
|
|
</signal>
|
|
<signal name="continued">
|
|
<description>
|
|
Emitted when the game exists a break state.
|
|
</description>
|
|
</signal>
|
|
<signal name="started">
|
|
<description>
|
|
Emitted when the debugging starts.
|
|
</description>
|
|
</signal>
|
|
<signal name="stopped">
|
|
<description>
|
|
Emitted when the debugging stops.
|
|
</description>
|
|
</signal>
|
|
</signals>
|
|
</class>
|