Struct 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<ClassDb>

pub fn get_class_list(&self) -> PackedStringArray

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

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

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

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

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

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

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

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

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

To set the default parameters, use Self::class_get_signal_list_ex and its builder methods. See the book for detailed usage instructions.

pub fn class_get_signal_list_ex<'a>( &'a self, class: impl AsArg<StringName> + 'a, ) -> ExClassGetSignalList<'a>

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

To set the default parameters, use Self::class_get_property_list_ex and its builder methods. See the book for detailed usage instructions.

pub fn class_get_property_list_ex<'a>( &'a self, class: impl AsArg<StringName> + 'a, ) -> ExClassGetPropertyList<'a>

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

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

pub fn class_get_property_default_value( &self, class: impl AsArg<StringName>, property: impl AsArg<StringName>, ) -> Variant

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

To set the default parameters, use Self::class_has_method_ex and its builder methods. See the book for detailed usage instructions.

pub fn class_has_method_ex<'a>( &'a self, class: impl AsArg<StringName> + 'a, method: impl AsArg<StringName> + 'a, ) -> ExClassHasMethod<'a>

pub fn class_get_method_argument_count( &self, class: impl AsArg<StringName>, method: impl AsArg<StringName>, ) -> i32

To set the default parameters, use Self::class_get_method_argument_count_ex and its builder methods. See the book for detailed usage instructions.

pub fn class_get_method_argument_count_ex<'a>( &'a self, class: impl AsArg<StringName> + 'a, method: impl AsArg<StringName> + 'a, ) -> ExClassGetMethodArgumentCount<'a>

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

To set the default parameters, use Self::class_get_method_list_ex and its builder methods. See the book for detailed usage instructions.

pub fn class_get_method_list_ex<'a>( &'a self, class: impl AsArg<StringName> + 'a, ) -> ExClassGetMethodList<'a>

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

To set the default parameters, use Self::class_get_integer_constant_list_ex and its builder methods. See the book for detailed usage instructions.

pub fn class_get_integer_constant_list_ex<'a>( &'a self, class: impl AsArg<StringName> + 'a, ) -> ExClassGetIntegerConstantList<'a>

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

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

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

To set the default parameters, use Self::class_has_enum_ex and its builder methods. See the book for detailed usage instructions.

pub fn class_has_enum_ex<'a>( &'a self, class: impl AsArg<StringName> + 'a, name: impl AsArg<StringName> + 'a, ) -> ExClassHasEnum<'a>

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

To set the default parameters, use Self::class_get_enum_list_ex and its builder methods. See the book for detailed usage instructions.

pub fn class_get_enum_list_ex<'a>( &'a self, class: impl AsArg<StringName> + 'a, ) -> ExClassGetEnumList<'a>

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

To set the default parameters, use Self::class_get_enum_constants_ex and its builder methods. See the book for detailed usage instructions.

pub fn class_get_enum_constants_ex<'a>( &'a self, class: impl AsArg<StringName> + 'a, enum_: impl AsArg<StringName> + 'a, ) -> ExClassGetEnumConstants<'a>

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

To set the default parameters, use Self::class_get_integer_constant_enum_ex and its builder methods. See the book for detailed usage instructions.

pub fn class_get_integer_constant_enum_ex<'a>( &'a self, class: impl AsArg<StringName> + 'a, name: impl AsArg<StringName> + 'a, ) -> ExClassGetIntegerConstantEnum<'a>

pub fn is_class_enum_bitfield( &self, class: impl AsArg<StringName>, enum_: impl AsArg<StringName>, ) -> bool

To set the default parameters, use Self::is_class_enum_bitfield_ex and its builder methods. See the book for detailed usage instructions.

pub fn is_class_enum_bitfield_ex<'a>( &'a self, class: impl AsArg<StringName> + 'a, enum_: impl AsArg<StringName> + 'a, ) -> ExIsClassEnumBitfield<'a>

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

Methods from Deref<Target = Object>

pub fn get_class(&self) -> GString

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

pub fn set(&mut self, property: impl AsArg<StringName>, value: &Variant)

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

pub fn set_indexed( &mut self, property_path: impl AsArg<NodePath>, value: &Variant, )

pub fn get_indexed(&self, property_path: impl AsArg<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: impl AsArg<StringName>) -> bool

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

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

pub fn get_script(&self) -> Variant

pub fn set_meta(&mut self, name: impl AsArg<StringName>, value: &Variant)

pub fn remove_meta(&mut self, name: impl AsArg<StringName>)

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

To set the default parameters, use Self::get_meta_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_meta_ex<'a>( &'a self, name: impl AsArg<StringName> + 'a, ) -> ExGetMeta<'a>

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

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

pub fn add_user_signal(&mut self, signal: impl AsArg<GString>)

To set the default parameters, use Self::add_user_signal_ex and its builder methods. See the book for detailed usage instructions.

pub fn add_user_signal_ex<'a>( &'a mut self, signal: impl AsArg<GString> + 'a, ) -> ExAddUserSignal<'a>

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

pub fn remove_user_signal(&mut self, signal: impl AsArg<StringName>)

pub fn emit_signal( &mut self, signal: impl AsArg<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: impl AsArg<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: impl AsArg<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: impl AsArg<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: impl AsArg<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: impl AsArg<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: impl AsArg<StringName>, value: &Variant, )

pub fn callv( &mut self, method: impl AsArg<StringName>, arg_array: &Array<Variant>, ) -> Variant

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

pub fn get_method_argument_count(&self, method: impl AsArg<StringName>) -> i32

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

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

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

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

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

To set the default parameters, use Self::connect_ex and its builder methods. See the book for detailed usage instructions.

pub fn connect_ex<'a>( &'a mut self, signal: impl AsArg<StringName> + 'a, callable: &'a Callable, ) -> ExConnect<'a>

pub fn disconnect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, )

pub fn is_connected( &self, signal: impl AsArg<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: impl AsArg<StringName>) -> GString

To set the default parameters, use Self::tr_ex and its builder methods. See the book for detailed usage instructions.

pub fn tr_ex<'a>(&'a self, message: impl AsArg<StringName> + 'a) -> ExTr<'a>

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

To set the default parameters, use Self::tr_n_ex and its builder methods. See the book for detailed usage instructions.

pub fn tr_n_ex<'a>( &'a self, message: impl AsArg<StringName> + 'a, plural_message: impl AsArg<StringName> + 'a, n: i32, ) -> ExTrN<'a>

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<(), Error>

Formats the value using the given formatter.

impl Deref for ClassDb

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &<ClassDb as Deref>::Target

Dereferences the value.

impl DerefMut for ClassDb

fn deref_mut(&mut self) -> &mut <ClassDb as Deref>::Target

Mutably dereferences the value.

impl GodotClass for ClassDb

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

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

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.

fn inherits<U>() -> bool

where U: GodotClass,

Returns whether Self inherits from U.

impl Inherits<Object> for ClassDb