blob: 0e1bf99afc45724a57432b0407a8dba260946254 (
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
88
89
90
91
92
93
94
95
96
|
<?xml version="1.0" encoding="UTF-8" ?>
<class name="EngineDebugger" inherits="Object" version="4.0">
<brief_description>
Exposes the internal debugger.
</brief_description>
<description>
[EngineDebugger] handles the communication between the editor and the running game. It is active in the running game. Messages can be sent/received through it. It also manages the profilers.
</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 capture with the given name is present otherwise [code]false[/code].
</description>
</method>
<method name="has_profiler">
<return type="bool" />
<argument index="0" name="name" type="StringName" />
<description>
Returns [code]true[/code] if a profiler with the given name is present otherwise [code]false[/code].
</description>
</method>
<method name="is_active">
<return type="bool" />
<description>
Returns [code]true[/code] if the debugger is active otherwise [code]false[/code].
</description>
</method>
<method name="is_profiling">
<return type="bool" />
<argument index="0" name="name" type="StringName" />
<description>
Returns [code]true[/code] if a profiler with the given name is present and active otherwise [code]false[/code].
</description>
</method>
<method name="profiler_add_frame_data">
<return type="void" />
<argument index="0" name="name" type="StringName" />
<argument index="1" name="data" type="Array" />
<description>
Calls the [code]add[/code] callable of the profiler with given [code]name[/code] and [code]data[/code].
</description>
</method>
<method name="profiler_enable">
<return type="void" />
<argument index="0" name="name" type="StringName" />
<argument index="1" name="enable" type="bool" />
<argument index="2" name="arguments" type="Array" default="[]" />
<description>
Calls the [code]toggle[/code] callable of the profiler with given [code]name[/code] and [code]arguments[/code]. Enables/Disables the same profiler depending on [code]enable[/code] argument.
</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="register_profiler">
<return type="void" />
<argument index="0" name="name" type="StringName" />
<argument index="1" name="profiler" type="EngineProfiler" />
<description>
Registers a profiler with the given [code]name[/code]. See [EngineProfiler] for more informations.
</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 [code]name[/code].
</description>
</method>
<method name="unregister_profiler">
<return type="void" />
<argument index="0" name="name" type="StringName" />
<description>
Unregisters a profiler with given [code]name[/code].
</description>
</method>
</methods>
</class>
|