2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2022-02-14 14:18:53 +01:00
<class name= "ClassDB" inherits= "Object" version= "4.0" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2017-09-12 22:42:36 +02:00
<brief_description >
2017-09-13 00:18:26 +02:00
Class information repository.
2017-09-12 22:42:36 +02:00
</brief_description>
<description >
2017-09-13 00:18:26 +02:00
Provides access to metadata stored for every available class.
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
</tutorials>
<methods >
2021-06-18 00:03:09 +02:00
<method name= "can_instantiate" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "bool" />
<argument index= "0" name= "class" type= "StringName" />
2017-09-12 22:42:36 +02:00
<description >
2019-06-22 01:04:47 +02:00
Returns [code]true[/code] if you can instance objects from the specified [code]class[/code], [code]false[/code] in other case.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "class_exists" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "bool" />
<argument index= "0" name= "class" type= "StringName" />
2017-09-12 22:42:36 +02:00
<description >
2019-06-22 01:04:47 +02:00
Returns whether the specified [code]class[/code] is available or not.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "class_get_category" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "StringName" />
<argument index= "0" name= "class" type= "StringName" />
2017-09-12 22:42:36 +02:00
<description >
2017-12-07 20:17:08 +01:00
Returns a category associated with the class for use in documentation and the Asset Library. Debug mode required.
2017-09-12 22:42:36 +02:00
</description>
</method>
2021-09-11 14:31:11 +02:00
<method name= "class_get_enum_constants" qualifiers= "const" >
<return type= "PackedStringArray" />
<argument index= "0" name= "class" type= "StringName" />
<argument index= "1" name= "enum" type= "StringName" />
<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= "PackedStringArray" />
<argument index= "0" name= "class" type= "StringName" />
<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>
2017-09-12 22:42:36 +02:00
<method name= "class_get_integer_constant" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "int" />
<argument index= "0" name= "class" type= "StringName" />
<argument index= "1" name= "name" type= "StringName" />
2017-09-12 22:42:36 +02:00
<description >
2019-06-22 01:04:47 +02:00
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.
2017-09-12 22:42:36 +02:00
</description>
</method>
2021-09-11 14:31:11 +02:00
<method name= "class_get_integer_constant_enum" qualifiers= "const" >
<return type= "StringName" />
<argument index= "0" name= "class" type= "StringName" />
<argument index= "1" name= "name" type= "StringName" />
<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>
2017-09-12 22:42:36 +02:00
<method name= "class_get_integer_constant_list" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "PackedStringArray" />
<argument index= "0" name= "class" type= "StringName" />
<argument index= "1" name= "no_inheritance" type= "bool" default= "false" />
2017-09-12 22:42:36 +02:00
<description >
2019-06-22 01:04:47 +02:00
Returns an array with the names all the integer constants of [code]class[/code] or its ancestry.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "class_get_method_list" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "Array" />
<argument index= "0" name= "class" type= "StringName" />
<argument index= "1" name= "no_inheritance" type= "bool" default= "false" />
2017-09-12 22:42:36 +02:00
<description >
2019-06-22 01:04:47 +02:00
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].
2021-10-05 14:24:34 +02: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-12 22:42:36 +02:00
</description>
</method>
<method name= "class_get_property" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "Variant" />
<argument index= "0" name= "object" type= "Object" />
<argument index= "1" name= "property" type= "StringName" />
2017-09-12 22:42:36 +02:00
<description >
2019-06-22 01:04:47 +02:00
Returns the value of [code]property[/code] of [code]class[/code] or its ancestry.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "class_get_property_list" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "Array" />
<argument index= "0" name= "class" type= "StringName" />
<argument index= "1" name= "no_inheritance" type= "bool" default= "false" />
2017-09-12 22:42:36 +02:00
<description >
2019-06-22 01:04:47 +02:00
Returns an array with all the properties of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "class_get_signal" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "Dictionary" />
<argument index= "0" name= "class" type= "StringName" />
<argument index= "1" name= "signal" type= "StringName" />
2017-09-12 22:42:36 +02:00
<description >
2019-06-22 01:04:47 +02:00
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].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "class_get_signal_list" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "Array" />
<argument index= "0" name= "class" type= "StringName" />
<argument index= "1" name= "no_inheritance" type= "bool" default= "false" />
2017-09-12 22:42:36 +02:00
<description >
2019-06-22 01:04:47 +02:00
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].
2017-09-12 22:42:36 +02:00
</description>
</method>
2021-09-11 14:31:11 +02:00
<method name= "class_has_enum" qualifiers= "const" >
<return type= "bool" />
<argument index= "0" name= "class" type= "StringName" />
<argument index= "1" name= "name" type= "StringName" />
<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>
2017-09-12 22:42:36 +02:00
<method name= "class_has_integer_constant" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "bool" />
<argument index= "0" name= "class" type= "StringName" />
<argument index= "1" name= "name" type= "StringName" />
2017-09-12 22:42:36 +02:00
<description >
2019-06-22 01:04:47 +02:00
Returns whether [code]class[/code] or its ancestry has an integer constant called [code]name[/code] or not.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "class_has_method" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "bool" />
<argument index= "0" name= "class" type= "StringName" />
<argument index= "1" name= "method" type= "StringName" />
<argument index= "2" name= "no_inheritance" type= "bool" default= "false" />
2017-09-12 22:42:36 +02:00
<description >
2019-08-19 19:40:31 +02:00
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.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "class_has_signal" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "bool" />
<argument index= "0" name= "class" type= "StringName" />
<argument index= "1" name= "signal" type= "StringName" />
2017-09-12 22:42:36 +02:00
<description >
2019-06-22 01:04:47 +02:00
Returns whether [code]class[/code] or its ancestry has a signal called [code]signal[/code] or not.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "class_set_property" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "int" enum= "Error" />
<argument index= "0" name= "object" type= "Object" />
<argument index= "1" name= "property" type= "StringName" />
<argument index= "2" name= "value" type= "Variant" />
2017-09-12 22:42:36 +02:00
<description >
2019-06-22 01:04:47 +02:00
Sets [code]property[/code] value of [code]class[/code] to [code]value[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_class_list" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "PackedStringArray" />
2017-09-12 22:42:36 +02:00
<description >
2017-09-13 00:18:26 +02:00
Returns the names of all the classes available.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_inheriters_from_class" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "PackedStringArray" />
<argument index= "0" name= "class" type= "StringName" />
2017-09-12 22:42:36 +02:00
<description >
2019-06-22 01:04:47 +02:00
Returns the names of all the classes that directly or indirectly inherit from [code]class[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_parent_class" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "StringName" />
<argument index= "0" name= "class" type= "StringName" />
2017-09-12 22:42:36 +02:00
<description >
2019-06-22 01:04:47 +02:00
Returns the parent class of [code]class[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
2021-06-18 00:03:09 +02:00
<method name= "instantiate" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "Variant" />
<argument index= "0" name= "class" type= "StringName" />
2017-09-12 22:42:36 +02:00
<description >
2019-06-22 01:04:47 +02:00
Creates an instance of [code]class[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "is_class_enabled" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "bool" />
<argument index= "0" name= "class" type= "StringName" />
2017-09-12 22:42:36 +02:00
<description >
2019-08-19 19:40:31 +02:00
Returns whether this [code]class[/code] is enabled or not.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "is_parent_class" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "bool" />
<argument index= "0" name= "class" type= "StringName" />
<argument index= "1" name= "inherits" type= "StringName" />
2017-09-12 22:42:36 +02:00
<description >
2019-06-22 01:04:47 +02:00
Returns whether [code]inherits[/code] is an ancestor of [code]class[/code] or not.
2017-09-12 22:42:36 +02:00
</description>
</method>
</methods>
</class>