Inheritance #

Table of contents

ClassDB #

is_instantiable, core, not_builtin_classes, singleton

A class information repository.

Provides access to metadata stored for every available class.

Members #

Methods #

const func can_instantiate(class: StringName) -> bool#

Returns true if objects can be instantiated from the specified class, otherwise returns false.

vararg func class_call_static(method: StringName) -> Variant#

Calls a static method on a class.

const func class_exists(class: StringName) -> bool#

Returns whether the specified class is available or not.

const func class_get_api_type(class: StringName) -> intClassDB.APIType#

Returns the API type of class. See APIType.

const func class_get_enum_constants(no_inheritance: bool = false) -> PackedStringArray#

Returns an array with all the keys in enum of class or its ancestry.

const func class_get_enum_list(no_inheritance: bool = false) -> PackedStringArray#

Returns an array with all the enums of class or its ancestry.

const func class_get_integer_constant(name: StringName) -> int#

Returns the value of the integer constant name of class or its ancestry. Always returns 0 when the constant could not be found.

const func class_get_integer_constant_enum(no_inheritance: bool = false) -> StringName#

Returns which enum the integer constant name of class or its ancestry belongs to.

const func class_get_integer_constant_list(no_inheritance: bool = false) -> PackedStringArray#

Returns an array with the names all the integer constants of class or its ancestry.

const func class_get_method_argument_count(no_inheritance: bool = false) -> int#

Returns the number of arguments of the method method of class or its ancestry if no_inheritance is false.

const func class_get_method_list(no_inheritance: bool = false) -> Dictionary[]#

Returns an array with all the methods of class or its ancestry if no_inheritance is false. Every element of the array is a Dictionary with the following keys: args, default_args, flags, id, name, return: (class_name, hint, hint_string, name, type, usage).

Note: In exported release builds the debug info is not available, so the returned dictionaries will contain only method names.

const func class_get_property(property: StringName) -> Variant#

Returns the value of property of object or its ancestry.

const func class_get_property_default_value(property: StringName) -> Variant#

Returns the default value of property of class or its ancestor classes.

func class_get_property_getter(property: StringName) -> StringName#

Returns the getter method name of property of class.

const func class_get_property_list(no_inheritance: bool = false) -> Dictionary[]#

Returns an array with all the properties of class or its ancestry if no_inheritance is false.

func class_get_property_setter(property: StringName) -> StringName#

Returns the setter method name of property of class.

const func class_get_signal(signal: StringName) -> Dictionary#

Returns the signal data of class or its ancestry. The returned value is a Dictionary with the following keys: args, default_args, flags, id, name, return: (class_name, hint, hint_string, name, type, usage).

const func class_get_signal_list(no_inheritance: bool = false) -> Dictionary[]#

Returns an array with all the signals of class or its ancestry if no_inheritance is false. Every element of the array is a Dictionary as described in class_get_signal.

const func class_has_enum(no_inheritance: bool = false) -> bool#

Returns whether class or its ancestry has an enum called name or not.

const func class_has_integer_constant(name: StringName) -> bool#

Returns whether class or its ancestry has an integer constant called name or not.

const func class_has_method(no_inheritance: bool = false) -> bool#

Returns whether class (or its ancestry if no_inheritance is false) has a method called method or not.

const func class_has_signal(signal: StringName) -> bool#

Returns whether class or its ancestry has a signal called signal or not.

const func class_set_property(value: Variant) -> intError#

Sets property value of object to value.

const func get_class_list() -> PackedStringArray#

Returns the names of all the classes available.

const func get_inheriters_from_class(class: StringName) -> PackedStringArray#

Returns the names of all the classes that directly or indirectly inherit from class.

const func get_parent_class(class: StringName) -> StringName#

Returns the parent class of class.

const func instantiate(class: StringName) -> Variant#

Creates an instance of class.

const func is_class_enabled(class: StringName) -> bool#

Returns whether this class is enabled or not.

const func is_class_enum_bitfield(no_inheritance: bool = false) -> bool#

Returns whether class (or its ancestor classes if no_inheritance is false) has an enum called enum that is a bitfield.

const func is_parent_class(inherits: StringName) -> bool#

Returns whether inherits is an ancestor of class or not.

Annotations #

Constants #

const API_CORE = 0 enum APIType#

Native Core class type.

const API_EDITOR = 1 enum APIType#

Native Editor class type.

const API_EXTENSION = 2 enum APIType#

GDExtension class type.

const API_EDITOR_EXTENSION = 3 enum APIType#

GDExtension Editor class type.

const API_NONE = 4 enum APIType#

Unknown class type.

Constructors #

Enums #

APIType#

enum APIType { API_CORE = 0, API_EDITOR = 1, API_EXTENSION = 2, API_EDITOR_EXTENSION = 3, API_NONE = 4, }

Operators #

Signals #

Theme Items #

Tutorials #