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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
<?xml version="1.0" encoding="UTF-8" ?>
<class name="ClassDB" inherits="Object" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
Class information repository.
</brief_description>
<description>
Provides access to metadata stored for every available class.
</description>
<tutorials>
</tutorials>
<methods>
<method name="can_instance" qualifiers="const">
<return type="bool" />
<argument index="0" name="class" type="String" />
<description>
Returns [code]true[/code] if you can instance objects from the specified [code]class[/code], [code]false[/code] in other case.
</description>
</method>
<method name="class_exists" qualifiers="const">
<return type="bool" />
<argument index="0" name="class" type="String" />
<description>
Returns whether the specified [code]class[/code] is available or not.
</description>
</method>
<method name="class_get_category" qualifiers="const">
<return type="String" />
<argument index="0" name="class" type="String" />
<description>
Returns a category associated with the class for use in documentation and the Asset Library. Debug mode required.
</description>
</method>
<method name="class_get_enum_constants" qualifiers="const">
<return type="PoolStringArray" />
<argument index="0" name="class" type="String" />
<argument index="1" name="enum" type="String" />
<argument index="2" name="no_inheritance" type="bool" default="false" />
<description>
Returns an array with all the keys in [code]enum[/code] of [code]class[/code] or its ancestry.
</description>
</method>
<method name="class_get_enum_list" qualifiers="const">
<return type="PoolStringArray" />
<argument index="0" name="class" type="String" />
<argument index="1" name="no_inheritance" type="bool" default="false" />
<description>
Returns an array with all the enums of [code]class[/code] or its ancestry.
</description>
</method>
<method name="class_get_integer_constant" qualifiers="const">
<return type="int" />
<argument index="0" name="class" type="String" />
<argument index="1" name="name" type="String" />
<description>
Returns the value of the integer constant [code]name[/code] of [code]class[/code] or its ancestry. Always returns 0 when the constant could not be found.
</description>
</method>
<method name="class_get_integer_constant_enum" qualifiers="const">
<return type="String" />
<argument index="0" name="class" type="String" />
<argument index="1" name="name" type="String" />
<argument index="2" name="no_inheritance" type="bool" default="false" />
<description>
Returns which enum the integer constant [code]name[/code] of [code]class[/code] or its ancestry belongs to.
</description>
</method>
<method name="class_get_integer_constant_list" qualifiers="const">
<return type="PoolStringArray" />
<argument index="0" name="class" type="String" />
<argument index="1" name="no_inheritance" type="bool" default="false" />
<description>
Returns an array with the names all the integer constants of [code]class[/code] or its ancestry.
</description>
</method>
<method name="class_get_method_list" qualifiers="const">
<return type="Array" />
<argument index="0" name="class" type="String" />
<argument index="1" name="no_inheritance" type="bool" default="false" />
<description>
Returns an array with all the methods of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code]. Every element of the array is a [Dictionary] with the following keys: [code]args[/code], [code]default_args[/code], [code]flags[/code], [code]id[/code], [code]name[/code], [code]return: (class_name, hint, hint_string, name, type, usage)[/code].
[b]Note:[/b] In exported release builds the debug info is not available, so the returned dictionaries will contain only method names.
</description>
</method>
<method name="class_get_property" qualifiers="const">
<return type="Variant" />
<argument index="0" name="object" type="Object" />
<argument index="1" name="property" type="String" />
<description>
Returns the value of [code]property[/code] of [code]class[/code] or its ancestry.
</description>
</method>
<method name="class_get_property_list" qualifiers="const">
<return type="Array" />
<argument index="0" name="class" type="String" />
<argument index="1" name="no_inheritance" type="bool" default="false" />
<description>
Returns an array with all the properties of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code].
</description>
</method>
<method name="class_get_signal" qualifiers="const">
<return type="Dictionary" />
<argument index="0" name="class" type="String" />
<argument index="1" name="signal" type="String" />
<description>
Returns the [code]signal[/code] data of [code]class[/code] or its ancestry. The returned value is a [Dictionary] with the following keys: [code]args[/code], [code]default_args[/code], [code]flags[/code], [code]id[/code], [code]name[/code], [code]return: (class_name, hint, hint_string, name, type, usage)[/code].
</description>
</method>
<method name="class_get_signal_list" qualifiers="const">
<return type="Array" />
<argument index="0" name="class" type="String" />
<argument index="1" name="no_inheritance" type="bool" default="false" />
<description>
Returns an array with all the signals of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code]. Every element of the array is a [Dictionary] as described in [method class_get_signal].
</description>
</method>
<method name="class_has_enum" qualifiers="const">
<return type="bool" />
<argument index="0" name="class" type="String" />
<argument index="1" name="name" type="String" />
<argument index="2" name="no_inheritance" type="bool" default="false" />
<description>
Returns whether [code]class[/code] or its ancestry has an enum called [code]name[/code] or not.
</description>
</method>
<method name="class_has_integer_constant" qualifiers="const">
<return type="bool" />
<argument index="0" name="class" type="String" />
<argument index="1" name="name" type="String" />
<description>
Returns whether [code]class[/code] or its ancestry has an integer constant called [code]name[/code] or not.
</description>
</method>
<method name="class_has_method" qualifiers="const">
<return type="bool" />
<argument index="0" name="class" type="String" />
<argument index="1" name="method" type="String" />
<argument index="2" name="no_inheritance" type="bool" default="false" />
<description>
Returns whether [code]class[/code] (or its ancestry if [code]no_inheritance[/code] is [code]false[/code]) has a method called [code]method[/code] or not.
</description>
</method>
<method name="class_has_signal" qualifiers="const">
<return type="bool" />
<argument index="0" name="class" type="String" />
<argument index="1" name="signal" type="String" />
<description>
Returns whether [code]class[/code] or its ancestry has a signal called [code]signal[/code] or not.
</description>
</method>
<method name="class_set_property" qualifiers="const">
<return type="int" enum="Error" />
<argument index="0" name="object" type="Object" />
<argument index="1" name="property" type="String" />
<argument index="2" name="value" type="Variant" />
<description>
Sets [code]property[/code] value of [code]class[/code] to [code]value[/code].
</description>
</method>
<method name="get_class_list" qualifiers="const">
<return type="PoolStringArray" />
<description>
Returns the names of all the classes available.
</description>
</method>
<method name="get_inheriters_from_class" qualifiers="const">
<return type="PoolStringArray" />
<argument index="0" name="class" type="String" />
<description>
Returns the names of all the classes that directly or indirectly inherit from [code]class[/code].
</description>
</method>
<method name="get_parent_class" qualifiers="const">
<return type="String" />
<argument index="0" name="class" type="String" />
<description>
Returns the parent class of [code]class[/code].
</description>
</method>
<method name="instance" qualifiers="const">
<return type="Variant" />
<argument index="0" name="class" type="String" />
<description>
Creates an instance of [code]class[/code].
</description>
</method>
<method name="is_class_enabled" qualifiers="const">
<return type="bool" />
<argument index="0" name="class" type="String" />
<description>
Returns whether this [code]class[/code] is enabled or not.
</description>
</method>
<method name="is_parent_class" qualifiers="const">
<return type="bool" />
<argument index="0" name="class" type="String" />
<argument index="1" name="inherits" type="String" />
<description>
Returns whether [code]inherits[/code] is an ancestor of [code]class[/code] or not.
</description>
</method>
</methods>
<constants>
</constants>
</class>
|
