Struct Object 

pub struct Object { /* private fields */ }

Godot class Object.

This is the base class for all other classes at the root of the hierarchy. Every instance of Object can be stored in a Gd smart pointer.

Related symbols:

• object: sidecar module with related enum/flag types
• IObject: virtual methods
• SignalsOfObject: signal collection
• ObjectNotification: notification type

See also Godot docs for Object.

Construction

This class is manually managed. You can create a new instance using Object::new_alloc().

Do not forget to call free() or hand over ownership to Godot.

Godot docs

An advanced [Variant][crate::builtin::Variant] type. All classes in the engine inherit from Object. Each class may define new properties, methods or signals, which are available to all inheriting classes. For example, a [Sprite2D][crate::classes::Sprite2D] instance is able to call add_child because it inherits from Node.

You can create new instances, using Object.new() in GDScript, or new GodotObject in C#.

To delete an Object instance, call free. This is necessary for most classes inheriting Object, because they do not manage memory on their own, and will otherwise cause memory leaks when no longer in use. There are a few classes that perform memory management. For example, RefCounted (and by extension Resource) deletes itself when no longer referenced, and Node deletes its children when freed.

Objects can have a Script attached to them. Once the Script is instantiated, it effectively acts as an extension to the base class, allowing it to define and inherit new properties, methods and signals.

Inside a Script, get_property_list may be overridden to customize properties in several ways. This allows them to be available to the editor, display as lists of options, sub-divide into groups, save on disk, etc. Scripting languages offer easier ways to customize properties, such as with the [annotation @GDScript.@export] annotation.

Godot is very dynamic. An object’s script, and therefore its properties, methods and signals, can be changed at run-time. Because of this, there can be occasions where, for example, a property required by a method may not exist. To prevent run-time errors, see methods such as set, get, call, has_method, has_signal, etc. Note that these methods are much slower than direct references.

In GDScript, you can also check if a given property, method, or signal name exists in an object with the in operator:

var node = Node.new()
print("name" in node)         # Prints true
print("get_parent" in node)   # Prints true
print("tree_entered" in node) # Prints true
print("unknown" in node)      # Prints false

Notifications are int constants commonly sent and received by objects. For example, on every rendered frame, the SceneTree notifies nodes inside the tree with a [constant Node.NOTIFICATION_PROCESS]. The nodes receive it and may call process to update. To make use of notifications, see notify and on_notification.

Lastly, every object can also contain metadata (data about data). set_meta can be useful to store information that the object itself does not depend on. To keep your code clean, making excessive use of metadata is discouraged.

Note: Unlike references to a RefCounted, references to an object stored in a variable can become invalid without being set to null. To check if an object has been deleted, do not compare it against null. Instead, use is_instance_valid. It’s also recommended to inherit from RefCounted for classes storing data instead of Object.

Note: The script is not exposed like most properties. To set or get an object’s Script in code, use [method set_script] and [method get_script], respectively.

Note: In a boolean context, an Object will evaluate to false if it is equal to null or it has been freed. Otherwise, an Object will always evaluate to true. See also is_instance_valid.

Implementations

impl Object

pub fn get_script(&self) -> Option<Gd<Script>>

pub fn set_script(&mut self, script: impl AsArg<Option<Gd<Script>>>)

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

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

impl 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<VarDictionary>

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

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_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<'ex>( &'ex self, name: impl AsArg<StringName> + 'ex, ) -> ExGetMeta<'ex>

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<'ex>( &'ex mut self, signal: impl AsArg<GString> + 'ex, ) -> ExAddUserSignal<'ex>

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: &AnyArray, ) -> 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<VarDictionary>

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

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

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 has_connections(&self, signal: impl AsArg<StringName>) -> 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<'ex>(&'ex self, message: impl AsArg<StringName> + 'ex) -> ExTr<'ex>

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<'ex>( &'ex self, message: impl AsArg<StringName> + 'ex, plural_message: impl AsArg<StringName> + 'ex, n: i32, ) -> ExTrN<'ex>

pub fn get_translation_domain(&self) -> StringName

pub fn set_translation_domain(&mut self, domain: impl AsArg<StringName>)

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 Object

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 Object

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

Formats the value using the given formatter.

impl GodotClass for Object

const INIT_LEVEL: InitLevel = crate::init::InitLevel::Core

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

type Base = NoBase

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

fn class_id() -> ClassId

Globally unique class ID, linked to the name under which the class is registered in Godot.

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

Returns whether Self inherits from Base.

impl Inherits<Object> for ArrayMesh

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for CanvasItem

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for ClassDb

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for EditorExportPlugin

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for EditorPlugin

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for Engine

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for FileAccess

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for GDScript

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for HttpRequest

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for Input

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for InputEvent

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for InputEventAction

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for MainLoop

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for Mesh

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for Node

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for Node2D

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for Node3D

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for Os

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for PackedScene

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for PrimitiveMesh

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for RefCounted

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for RenderingServer

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for Resource

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for ResourceFormatLoader

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for ResourceLoader

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for ResourceSaver

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for SceneTree

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for Script

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for ScriptExtension

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for ScriptLanguage

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for ScriptLanguageExtension

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for Time

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for Viewport

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for Window

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl WithSignals for Object

type SignalCollection<'c, C: WithSignals> = SignalsOfObject<'c, C>

The associated struct listing all signals of this class.

impl GodotDefault for Object