Skip to content

Commit 336ba21

Browse files
committed
Document ClassDB not storing information on user-defined classes
1 parent 42224bb commit 336ba21

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

doc/classes/ClassDB.xml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
A class information repository.
55
</brief_description>
66
<description>
7-
Provides access to metadata stored for every available class.
7+
Provides access to metadata stored for every available engine class.
8+
[b]Note:[/b] Script-defined classes with [code]class_name[/code] are not part of [ClassDB], so they will not return reflection data such as a method or property list. However, [GDExtension]-defined classes [i]are[/i] part of [ClassDB], so they will return reflection data.
89
</description>
910
<tutorials>
1011
</tutorials>
@@ -200,14 +201,15 @@
200201
<method name="get_class_list" qualifiers="const">
201202
<return type="PackedStringArray" />
202203
<description>
203-
Returns the names of all the classes available.
204+
Returns the names of all engine classes available.
205+
[b]Note:[/b] Script-defined classes with [code]class_name[/code] are not included in this list. Use [method ProjectSettings.get_global_class_list] to get a list of script-defined classes instead.
204206
</description>
205207
</method>
206208
<method name="get_inheriters_from_class" qualifiers="const">
207209
<return type="PackedStringArray" />
208210
<param index="0" name="class" type="StringName" />
209211
<description>
210-
Returns the names of all the classes that directly or indirectly inherit from [param class].
212+
Returns the names of all engine classes that directly or indirectly inherit from [param class].
211213
</description>
212214
</method>
213215
<method name="get_parent_class" qualifiers="const">

0 commit comments

Comments
 (0)