2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-07-06 16:08:05 +08:00
<class name= "ClassDB" inherits= "Object" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2017-09-13 04:42:36 +08:00
<brief_description >
2023-04-28 07:35:33 +08:00
A class information repository.
2017-09-13 04:42:36 +08:00
</brief_description>
<description >
2017-09-13 06:18:26 +08:00
Provides access to metadata stored for every available class.
2017-09-13 04:42:36 +08:00
</description>
<tutorials >
</tutorials>
<methods >
2021-06-18 06:03:09 +08:00
<method name= "can_instantiate" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "class" type= "StringName" />
2017-09-13 04:42:36 +08:00
<description >
2022-10-20 10:09:17 +08:00
Returns [code]true[/code] if objects can be instantiated from the specified [param class], otherwise returns [code]false[/code].
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "class_exists" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "class" type= "StringName" />
2017-09-13 04:42:36 +08:00
<description >
2022-08-13 01:13:27 +08:00
Returns whether the specified [param class] is available or not.
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-09-11 20:31:11 +08:00
<method name= "class_get_enum_constants" qualifiers= "const" >
<return type= "PackedStringArray" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "class" type= "StringName" />
<param index= "1" name= "enum" type= "StringName" />
<param index= "2" name= "no_inheritance" type= "bool" default= "false" />
2021-09-11 20:31:11 +08:00
<description >
2022-08-13 01:13:27 +08:00
Returns an array with all the keys in [param enum] of [param class] or its ancestry.
2021-09-11 20:31:11 +08:00
</description>
</method>
<method name= "class_get_enum_list" qualifiers= "const" >
<return type= "PackedStringArray" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "class" type= "StringName" />
<param index= "1" name= "no_inheritance" type= "bool" default= "false" />
2021-09-11 20:31:11 +08:00
<description >
2022-08-13 01:13:27 +08:00
Returns an array with all the enums of [param class] or its ancestry.
2021-09-11 20:31:11 +08:00
</description>
</method>
2017-09-13 04:42:36 +08:00
<method name= "class_get_integer_constant" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "int" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "class" type= "StringName" />
<param index= "1" name= "name" type= "StringName" />
2017-09-13 04:42:36 +08:00
<description >
2022-08-13 01:13:27 +08:00
Returns the value of the integer constant [param name] of [param class] or its ancestry. Always returns 0 when the constant could not be found.
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-09-11 20:31:11 +08:00
<method name= "class_get_integer_constant_enum" qualifiers= "const" >
<return type= "StringName" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "class" type= "StringName" />
<param index= "1" name= "name" type= "StringName" />
<param index= "2" name= "no_inheritance" type= "bool" default= "false" />
2021-09-11 20:31:11 +08:00
<description >
2022-08-13 01:13:27 +08:00
Returns which enum the integer constant [param name] of [param class] or its ancestry belongs to.
2021-09-11 20:31:11 +08:00
</description>
</method>
2017-09-13 04:42:36 +08:00
<method name= "class_get_integer_constant_list" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "PackedStringArray" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "class" type= "StringName" />
<param index= "1" name= "no_inheritance" type= "bool" default= "false" />
2017-09-13 04:42:36 +08:00
<description >
2022-08-13 01:13:27 +08:00
Returns an array with the names all the integer constants of [param class] or its ancestry.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "class_get_method_list" qualifiers= "const" >
2022-08-05 09:41:48 +08:00
<return type= "Dictionary[]" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "class" type= "StringName" />
<param index= "1" name= "no_inheritance" type= "bool" default= "false" />
2017-09-13 04:42:36 +08:00
<description >
2022-08-13 01:13:27 +08:00
Returns an array with all the methods of [param class] or its ancestry if [param no_inheritance] 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].
2021-10-05 20:24:34 +08:00
[b]Note:[/b] In exported release builds the debug info is not available, so the returned dictionaries will contain only method names.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "class_get_property" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "Variant" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "object" type= "Object" />
<param index= "1" name= "property" type= "StringName" />
2017-09-13 04:42:36 +08:00
<description >
2022-08-13 01:13:27 +08:00
Returns the value of [param property] of [param object] or its ancestry.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "class_get_property_list" qualifiers= "const" >
2022-08-05 09:41:48 +08:00
<return type= "Dictionary[]" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "class" type= "StringName" />
<param index= "1" name= "no_inheritance" type= "bool" default= "false" />
2017-09-13 04:42:36 +08:00
<description >
2022-08-13 01:13:27 +08:00
Returns an array with all the properties of [param class] or its ancestry if [param no_inheritance] is [code]false[/code].
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "class_get_signal" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "Dictionary" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "class" type= "StringName" />
<param index= "1" name= "signal" type= "StringName" />
2017-09-13 04:42:36 +08:00
<description >
2022-08-13 01:13:27 +08:00
Returns the [param signal] data of [param class] 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].
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "class_get_signal_list" qualifiers= "const" >
2022-08-05 09:41:48 +08:00
<return type= "Dictionary[]" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "class" type= "StringName" />
<param index= "1" name= "no_inheritance" type= "bool" default= "false" />
2017-09-13 04:42:36 +08:00
<description >
2022-08-13 01:13:27 +08:00
Returns an array with all the signals of [param class] or its ancestry if [param no_inheritance] is [code]false[/code]. Every element of the array is a [Dictionary] as described in [method class_get_signal].
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-09-11 20:31:11 +08:00
<method name= "class_has_enum" qualifiers= "const" >
<return type= "bool" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "class" type= "StringName" />
<param index= "1" name= "name" type= "StringName" />
<param index= "2" name= "no_inheritance" type= "bool" default= "false" />
2021-09-11 20:31:11 +08:00
<description >
2022-08-13 01:13:27 +08:00
Returns whether [param class] or its ancestry has an enum called [param name] or not.
2021-09-11 20:31:11 +08:00
</description>
</method>
2017-09-13 04:42:36 +08:00
<method name= "class_has_integer_constant" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "class" type= "StringName" />
<param index= "1" name= "name" type= "StringName" />
2017-09-13 04:42:36 +08:00
<description >
2022-08-13 01:13:27 +08:00
Returns whether [param class] or its ancestry has an integer constant called [param name] or not.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "class_has_method" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "class" type= "StringName" />
<param index= "1" name= "method" type= "StringName" />
<param index= "2" name= "no_inheritance" type= "bool" default= "false" />
2017-09-13 04:42:36 +08:00
<description >
2022-08-13 01:13:27 +08:00
Returns whether [param class] (or its ancestry if [param no_inheritance] is [code]false[/code]) has a method called [param method] or not.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "class_has_signal" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "class" type= "StringName" />
<param index= "1" name= "signal" type= "StringName" />
2017-09-13 04:42:36 +08:00
<description >
2022-08-13 01:13:27 +08:00
Returns whether [param class] or its ancestry has a signal called [param signal] or not.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "class_set_property" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "int" enum= "Error" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "object" type= "Object" />
<param index= "1" name= "property" type= "StringName" />
<param index= "2" name= "value" type= "Variant" />
2017-09-13 04:42:36 +08:00
<description >
2022-08-13 01:13:27 +08:00
Sets [param property] value of [param object] to [param value].
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "get_class_list" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "PackedStringArray" />
2017-09-13 04:42:36 +08:00
<description >
2017-09-13 06:18:26 +08:00
Returns the names of all the classes available.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "get_inheriters_from_class" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "PackedStringArray" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "class" type= "StringName" />
2017-09-13 04:42:36 +08:00
<description >
2022-08-13 01:13:27 +08:00
Returns the names of all the classes that directly or indirectly inherit from [param class].
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "get_parent_class" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "StringName" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "class" type= "StringName" />
2017-09-13 04:42:36 +08:00
<description >
2022-08-13 01:13:27 +08:00
Returns the parent class of [param class].
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-06-18 06:03:09 +08:00
<method name= "instantiate" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "Variant" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "class" type= "StringName" />
2017-09-13 04:42:36 +08:00
<description >
2022-08-13 01:13:27 +08:00
Creates an instance of [param class].
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "is_class_enabled" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "class" type= "StringName" />
2017-09-13 04:42:36 +08:00
<description >
2022-08-13 01:13:27 +08:00
Returns whether this [param class] is enabled or not.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "is_parent_class" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "class" type= "StringName" />
<param index= "1" name= "inherits" type= "StringName" />
2017-09-13 04:42:36 +08:00
<description >
2022-08-13 01:13:27 +08:00
Returns whether [param inherits] is an ancestor of [param class] or not.
2017-09-13 04:42:36 +08:00
</description>
</method>
</methods>
</class>