diff options
Diffstat (limited to 'doc/classes/ClassDB.xml')
| -rw-r--r-- | doc/classes/ClassDB.xml | 44 |
1 files changed, 22 insertions, 22 deletions
diff --git a/doc/classes/ClassDB.xml b/doc/classes/ClassDB.xml index 151b34c430..90ce52fdb0 100644 --- a/doc/classes/ClassDB.xml +++ b/doc/classes/ClassDB.xml @@ -13,14 +13,14 @@ <return type="bool" /> <param index="0" name="class" type="StringName" /> <description> - Returns [code]true[/code] if you can instance objects from the specified [code]class[/code], [code]false[/code] in other case. + Returns [code]true[/code] if you can instance objects from the specified [param class], [code]false[/code] in other case. </description> </method> <method name="class_exists" qualifiers="const"> <return type="bool" /> <param index="0" name="class" type="StringName" /> <description> - Returns whether the specified [code]class[/code] is available or not. + Returns whether the specified [param class] is available or not. </description> </method> <method name="class_get_enum_constants" qualifiers="const"> @@ -29,7 +29,7 @@ <param index="1" name="enum" type="StringName" /> <param 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. + Returns an array with all the keys in [param enum] of [param class] or its ancestry. </description> </method> <method name="class_get_enum_list" qualifiers="const"> @@ -37,7 +37,7 @@ <param index="0" name="class" type="StringName" /> <param index="1" name="no_inheritance" type="bool" default="false" /> <description> - Returns an array with all the enums of [code]class[/code] or its ancestry. + Returns an array with all the enums of [param class] or its ancestry. </description> </method> <method name="class_get_integer_constant" qualifiers="const"> @@ -45,7 +45,7 @@ <param index="0" name="class" type="StringName" /> <param index="1" name="name" type="StringName" /> <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. + 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. </description> </method> <method name="class_get_integer_constant_enum" qualifiers="const"> @@ -54,7 +54,7 @@ <param index="1" name="name" type="StringName" /> <param 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. + Returns which enum the integer constant [param name] of [param class] or its ancestry belongs to. </description> </method> <method name="class_get_integer_constant_list" qualifiers="const"> @@ -62,7 +62,7 @@ <param index="0" name="class" type="StringName" /> <param 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. + Returns an array with the names all the integer constants of [param class] or its ancestry. </description> </method> <method name="class_get_method_list" qualifiers="const"> @@ -70,7 +70,7 @@ <param index="0" name="class" type="StringName" /> <param 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]. + 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]. [b]Note:[/b] In exported release builds the debug info is not available, so the returned dictionaries will contain only method names. </description> </method> @@ -79,7 +79,7 @@ <param index="0" name="object" type="Object" /> <param index="1" name="property" type="StringName" /> <description> - Returns the value of [code]property[/code] of [code]class[/code] or its ancestry. + Returns the value of [param property] of [param object] or its ancestry. </description> </method> <method name="class_get_property_list" qualifiers="const"> @@ -87,7 +87,7 @@ <param index="0" name="class" type="StringName" /> <param 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]. + Returns an array with all the properties of [param class] or its ancestry if [param no_inheritance] is [code]false[/code]. </description> </method> <method name="class_get_signal" qualifiers="const"> @@ -95,7 +95,7 @@ <param index="0" name="class" type="StringName" /> <param index="1" name="signal" type="StringName" /> <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]. + 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]. </description> </method> <method name="class_get_signal_list" qualifiers="const"> @@ -103,7 +103,7 @@ <param index="0" name="class" type="StringName" /> <param 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]. + 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]. </description> </method> <method name="class_has_enum" qualifiers="const"> @@ -112,7 +112,7 @@ <param index="1" name="name" type="StringName" /> <param 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. + Returns whether [param class] or its ancestry has an enum called [param name] or not. </description> </method> <method name="class_has_integer_constant" qualifiers="const"> @@ -120,7 +120,7 @@ <param index="0" name="class" type="StringName" /> <param index="1" name="name" type="StringName" /> <description> - Returns whether [code]class[/code] or its ancestry has an integer constant called [code]name[/code] or not. + Returns whether [param class] or its ancestry has an integer constant called [param name] or not. </description> </method> <method name="class_has_method" qualifiers="const"> @@ -129,7 +129,7 @@ <param index="1" name="method" type="StringName" /> <param 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. + Returns whether [param class] (or its ancestry if [param no_inheritance] is [code]false[/code]) has a method called [param method] or not. </description> </method> <method name="class_has_signal" qualifiers="const"> @@ -137,7 +137,7 @@ <param index="0" name="class" type="StringName" /> <param index="1" name="signal" type="StringName" /> <description> - Returns whether [code]class[/code] or its ancestry has a signal called [code]signal[/code] or not. + Returns whether [param class] or its ancestry has a signal called [param signal] or not. </description> </method> <method name="class_set_property" qualifiers="const"> @@ -146,7 +146,7 @@ <param index="1" name="property" type="StringName" /> <param index="2" name="value" type="Variant" /> <description> - Sets [code]property[/code] value of [code]class[/code] to [code]value[/code]. + Sets [param property] value of [param object] to [param value]. </description> </method> <method name="get_class_list" qualifiers="const"> @@ -159,28 +159,28 @@ <return type="PackedStringArray" /> <param index="0" name="class" type="StringName" /> <description> - Returns the names of all the classes that directly or indirectly inherit from [code]class[/code]. + Returns the names of all the classes that directly or indirectly inherit from [param class]. </description> </method> <method name="get_parent_class" qualifiers="const"> <return type="StringName" /> <param index="0" name="class" type="StringName" /> <description> - Returns the parent class of [code]class[/code]. + Returns the parent class of [param class]. </description> </method> <method name="instantiate" qualifiers="const"> <return type="Variant" /> <param index="0" name="class" type="StringName" /> <description> - Creates an instance of [code]class[/code]. + Creates an instance of [param class]. </description> </method> <method name="is_class_enabled" qualifiers="const"> <return type="bool" /> <param index="0" name="class" type="StringName" /> <description> - Returns whether this [code]class[/code] is enabled or not. + Returns whether this [param class] is enabled or not. </description> </method> <method name="is_parent_class" qualifiers="const"> @@ -188,7 +188,7 @@ <param index="0" name="class" type="StringName" /> <param index="1" name="inherits" type="StringName" /> <description> - Returns whether [code]inherits[/code] is an ancestor of [code]class[/code] or not. + Returns whether [param inherits] is an ancestor of [param class] or not. </description> </method> </methods> |