Struct godot_core::classes::ClassDb

#[repr(C)]
pub struct ClassDb { /* private fields */ }

Godot class ClassDB.

Inherits Object.

Related symbols:

• class_db: sidecar module with related enum/flag types
• IClassDb: virtual methods

See also Godot docs for ClassDB.

Singleton

This class is a singleton. You can get the one instance using ClassDb::singleton().

Implementations

impl ClassDb

pub fn singleton() -> Gd<Self>

pub fn get_class_list(&self) -> PackedStringArray

pub fn get_inheriters_from_class(&self, class: StringName) -> PackedStringArray

pub fn get_parent_class(&self, class: StringName) -> StringName

pub fn class_exists(&self, class: StringName) -> bool

pub fn is_parent_class(&self, class: StringName, inherits: StringName) -> bool

pub fn can_instantiate(&self, class: StringName) -> bool

pub fn instantiate(&self, class: StringName) -> Variant

pub fn class_has_signal(&self, class: StringName, signal: StringName) -> bool

pub fn class_get_signal( &self, class: StringName, signal: StringName, ) -> Dictionary

pub fn class_get_signal_list(&self, class: StringName) -> Array<Dictionary>

pub fn class_get_signal_list_ex( &self, class: StringName, ) -> ExClassGetSignalList<'_>

pub fn class_get_property_list(&self, class: StringName) -> Array<Dictionary>

pub fn class_get_property_list_ex( &self, class: StringName, ) -> ExClassGetPropertyList<'_>

pub fn class_get_property( &self, object: Gd<Object>, property: StringName, ) -> Variant

pub fn class_set_property( &self, object: Gd<Object>, property: StringName, value: Variant, ) -> Error

pub fn class_has_method(&self, class: StringName, method: StringName) -> bool

pub fn class_has_method_ex( &self, class: StringName, method: StringName, ) -> ExClassHasMethod<'_>

pub fn class_get_method_list(&self, class: StringName) -> Array<Dictionary>

pub fn class_get_method_list_ex( &self, class: StringName, ) -> ExClassGetMethodList<'_>

pub fn class_get_integer_constant_list( &self, class: StringName, ) -> PackedStringArray

pub fn class_get_integer_constant_list_ex( &self, class: StringName, ) -> ExClassGetIntegerConstantList<'_>

pub fn class_has_integer_constant( &self, class: StringName, name: StringName, ) -> bool

pub fn class_get_integer_constant( &self, class: StringName, name: StringName, ) -> i64

pub fn class_has_enum(&self, class: StringName, name: StringName) -> bool

pub fn class_has_enum_ex( &self, class: StringName, name: StringName, ) -> ExClassHasEnum<'_>

pub fn class_get_enum_list(&self, class: StringName) -> PackedStringArray

pub fn class_get_enum_list_ex( &self, class: StringName, ) -> ExClassGetEnumList<'_>

pub fn class_get_enum_constants( &self, class: StringName, enum_: StringName, ) -> PackedStringArray

pub fn class_get_enum_constants_ex( &self, class: StringName, enum_: StringName, ) -> ExClassGetEnumConstants<'_>

pub fn class_get_integer_constant_enum( &self, class: StringName, name: StringName, ) -> StringName

pub fn class_get_integer_constant_enum_ex( &self, class: StringName, name: StringName, ) -> ExClassGetIntegerConstantEnum<'_>

pub fn is_class_enabled(&self, class: StringName) -> bool

Methods from Deref<Target = Object>

pub fn get_class(&self) -> GString

pub fn is_class(&self, class: GString) -> bool

pub fn set(&mut self, property: StringName, value: Variant)

pub fn get(&self, property: StringName) -> Variant

pub fn set_indexed(&mut self, property_path: NodePath, value: Variant)

pub fn get_indexed(&self, property_path: NodePath) -> Variant

pub fn get_property_list(&self) -> Array<Dictionary>

pub fn get_method_list(&self) -> Array<Dictionary>

pub fn property_can_revert(&self, property: StringName) -> bool

pub fn property_get_revert(&self, property: StringName) -> Variant

pub fn set_script(&mut self, script: Variant)

pub fn get_script(&self) -> Variant

pub fn set_meta(&mut self, name: StringName, value: Variant)

pub fn remove_meta(&mut self, name: StringName)

pub fn get_meta(&self, name: StringName) -> Variant

pub fn get_meta_ex(&self, name: StringName) -> ExGetMeta<'_>

pub fn has_meta(&self, name: StringName) -> bool

pub fn get_meta_list(&self) -> Array<StringName>

pub fn add_user_signal(&mut self, signal: GString)

pub fn add_user_signal_ex(&mut self, signal: GString) -> ExAddUserSignal<'_>

pub fn has_user_signal(&self, signal: StringName) -> bool

pub fn emit_signal(&mut self, signal: StringName, varargs: &[Variant]) -> Error

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_emit_signal( &mut self, signal: StringName, varargs: &[Variant], ) -> Result<Error, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call(&mut self, method: StringName, varargs: &[Variant]) -> Variant

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call( &mut self, method: StringName, varargs: &[Variant], ) -> Result<Variant, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call_deferred( &mut self, method: StringName, varargs: &[Variant], ) -> Variant

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call_deferred( &mut self, method: StringName, varargs: &[Variant], ) -> Result<Variant, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn set_deferred(&mut self, property: StringName, value: Variant)

pub fn callv(&mut self, method: StringName, arg_array: VariantArray) -> Variant

pub fn has_method(&self, method: StringName) -> bool

pub fn has_signal(&self, signal: StringName) -> bool

pub fn get_signal_list(&self) -> Array<Dictionary>

pub fn get_signal_connection_list( &self, signal: StringName, ) -> Array<Dictionary>

pub fn get_incoming_connections(&self) -> Array<Dictionary>

pub fn connect(&mut self, signal: StringName, callable: Callable) -> Error

pub fn connect_ex( &mut self, signal: StringName, callable: Callable, ) -> ExConnect<'_>

pub fn disconnect(&mut self, signal: StringName, callable: Callable)

pub fn is_connected(&self, signal: StringName, callable: Callable) -> bool

pub fn set_block_signals(&mut self, enable: bool)

pub fn is_blocking_signals(&self) -> bool

pub fn notify_property_list_changed(&mut self)

pub fn set_message_translation(&mut self, enable: bool)

pub fn can_translate_messages(&self) -> bool

pub fn tr(&self, message: StringName) -> GString

pub fn tr_ex(&self, message: StringName) -> ExTr<'_>

pub fn tr_n( &self, message: StringName, plural_message: StringName, n: i32, ) -> GString

pub fn tr_n_ex( &self, message: StringName, plural_message: StringName, n: i32, ) -> ExTrN<'_>

pub fn is_queued_for_deletion(&self) -> bool

pub fn cancel_free(&mut self)

pub fn notify(&mut self, what: ObjectNotification)

⚠️ Sends a Godot notification to all classes inherited by the object.

Triggers calls to on_notification(), and depending on the notification, also to Godot’s lifecycle callbacks such as ready().

Starts from the highest ancestor (the Object class) and goes down the hierarchy. See also Godot docs for Object::notification().

Panics

If you call this method on a user-defined object while holding a GdRef or GdMut guard on the instance, you will encounter a panic. The reason is that the receiving virtual method on_notification() acquires a GdMut lock dynamically, which must be exclusive.

pub fn notify_reversed(&mut self, what: ObjectNotification)

⚠️ Like Self::notify(), but starts at the most-derived class and goes up the hierarchy.

See docs of that method, including the panics.

Trait Implementations

impl Bounds for ClassDb

type Memory = MemManual

Defines the memory strategy of the static type.

type Declarer = DeclEngine

Whether this class is a core Godot class provided by the engine, or declared by the user as a Rust struct.

impl Debug for ClassDb

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for ClassDb

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for ClassDb

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl GodotClass for ClassDb

type Base = Object

The immediate superclass of T. This is always a Godot engine class.

fn class_name() -> ClassName

The name of the class, under which it is registered in Godot.

const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene

Initialization level, during which this class should be initialized with Godot.

fn inherits<U: GodotClass>() -> bool

Returns whether Self inherits from U.

impl Inherits<Object> for ClassDb