blob: 0773e176b3ee4d1032228cd1dcbaefc449bd46a8 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorDebuggerPlugin" inherits="Control" version="4.0">
<brief_description>
A base class to implement debugger plugins.
</brief_description>
<description>
All debugger plugin scripts must extend [EditorDebuggerPlugin]. It provides functions related to editor side of debugger.
You don't need to instantiate this class. That is handled by the debugger itself. [Control] nodes can be added as child nodes to provide a GUI front-end for the plugin.
Do not queue_free/reparent it's instance otherwise the instance becomes unusable.
</description>
<tutorials>
</tutorials>
<methods>
<method name="has_capture">
<return type="bool" />
<argument 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" />
<argument index="0" name="name" type="StringName" />
<argument index="1" name="callable" type="Callable" />
<description>
Registers a message capture with given [code]name[/code]. If [code]name[/code] 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" />
<argument index="0" name="message" type="String" />
<argument index="1" name="data" type="Array" />
<description>
Sends a message with given [code]message[/code] and [code]data[/code] array.
</description>
</method>
<method name="unregister_message_capture">
<return type="void" />
<argument index="0" name="name" type="StringName" />
<description>
Unregisters the message capture with given name.
</description>
</method>
</methods>
<signals>
<signal name="breaked">
<argument 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>
|