Struct gdnative::api::Object[−][src]

pub struct Object { /* fields omitted */ }

The base class of most Godot classes.

Official documentation

See the documentation of this class in the Godot engine's official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.

Memory management

Non reference counted objects such as the ones of this type are usually owned by the engine.

Object is a reference-only type. Persistent references can only exist in the unsafe Ref<Object> form.

In the cases where Rust code owns an object of this type, for example if the object was just created on the Rust side and not passed to the engine yet, ownership should be either given to the engine or the object must be manually destroyed using Ref::free, or Ref::queue_free if it is a Node.

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

`impl Object`[src]

Constants

`pub const CONNECT_DEFERRED: i64`[src]

`pub const CONNECT_ONESHOT: i64`[src]

`pub const CONNECT_PERSIST: i64`[src]

`pub const CONNECT_REFERENCE_COUNTED: i64`[src]

`pub const NOTIFICATION_POSTINITIALIZE: i64`[src]

`pub const NOTIFICATION_PREDELETE: i64`[src]

`impl Object`[src]

`pub fn new() -> Ref<Object, Unique>`[src]

Creates a new instance of this object.

Because this type is not reference counted, the lifetime of the returned object is not automatically managed.

Immediately after creation, the object is owned by the caller, and can be passed to the engine (in which case the engine will be responsible for destroying the object) or destroyed manually using Ref::free, or preferably Ref::queue_free if it is a Node.

`pub fn add_user_signal( &self, signal: impl Into<GodotString>, arguments: VariantArray<Shared> )`[src]

Adds a user-defined signal. Arguments are optional, but can be added as an [Array] of dictionaries, each containing name: String and type: int (see [enum Variant.Type]) entries.

Default Arguments

arguments - [ ]

`pub unsafe fn call( &self, method: impl Into<GodotString>, varargs: &[Variant] ) -> Variant`[src]

Sample code is GDScript unless otherwise noted.

Calls the method on the object and returns the result. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:

call("set", "position", Vector2(42.0, 0.0))

Note: In C#, the method name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined methods where you should use the same convention as in the C# source (typically PascalCase).

Safety

This function bypasses Rust's static type checks (aliasing, thread boundaries, calls to free(), ...).

`pub unsafe fn call_deferred( &self, method: impl Into<GodotString>, varargs: &[Variant] ) -> Variant`[src]

Sample code is GDScript unless otherwise noted.

Calls the method on the object during idle time. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:

call_deferred("set", "position", Vector2(42.0, 0.0))

Note: In C#, the method name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined methods where you should use the same convention as in the C# source (typically PascalCase).

Safety

This function bypasses Rust's static type checks (aliasing, thread boundaries, calls to free(), ...).

`pub unsafe fn callv( &self, method: impl Into<GodotString>, arg_array: VariantArray<Shared> ) -> Variant`[src]

Sample code is GDScript unless otherwise noted.

Calls the method on the object and returns the result. Contrarily to [method call], this method does not support a variable number of arguments but expects all parameters to be via a single [Array].

callv("set", [ "position", Vector2(42.0, 0.0) ])

Safety

This function bypasses Rust's static type checks (aliasing, thread boundaries, calls to free(), ...).

`pub fn can_translate_messages(&self) -> bool`[src]

Returns true if the object can translate strings. See [method set_message_translation] and [method tr].

`pub fn connect( &self, signal: impl Into<GodotString>, target: impl AsArg<Object>, method: impl Into<GodotString>, binds: VariantArray<Shared>, flags: i64 ) -> Result<(), GodotError>`[src]

Sample code is GDScript unless otherwise noted.

Connects a signal to a method on a target object. Pass optional binds to the call as an [Array] of parameters. These parameters will be passed to the method after any parameter used in the call to [method emit_signal]. Use flags to set deferred or one-shot connections. See [enum ConnectFlags] constants. A signal can only be connected once to a method. It will throw an error if already connected, unless the signal was connected with [constant CONNECT_REFERENCE_COUNTED]. To avoid this, first, use [method is_connected] to check for existing connections. If the target is destroyed in the game's lifecycle, the connection will be lost. Examples:

connect("pressed", self, "_on_Button_pressed") # BaseButton signal
connect("text_entered", self, "_on_LineEdit_text_entered") # LineEdit signal
connect("hit", self, "_on_Player_hit", [ weapon_type, damage ]) # User-defined signal

An example of the relationship between binds passed to [method connect] and parameters used when calling [method emit_signal]:

connect("hit", self, "_on_Player_hit", [ weapon_type, damage ]) # weapon_type and damage are passed last
emit_signal("hit", "Dark lord", 5) # "Dark lord" and 5 are passed first
func _on_Player_hit(hit_by, level, weapon_type, damage):
    print("Hit by %s (lvl %d) with weapon %s for %d damage" % [hit_by, level, weapon_type, damage])

Default Arguments

binds - [ ]
flags - 0

`pub fn disconnect( &self, signal: impl Into<GodotString>, target: impl AsArg<Object>, method: impl Into<GodotString> )`[src]

Disconnects a signal from a method on the given target. If you try to disconnect a connection that does not exist, the method will throw an error. Use [method is_connected] to ensure that the connection exists.

`pub fn emit_signal( &self, signal: impl Into<GodotString>, varargs: &[Variant] ) -> Variant`[src]

Sample code is GDScript unless otherwise noted.

Emits the given signal. The signal must exist, so it should be a built-in signal of this class or one of its parent classes, or a user-defined signal. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:

emit_signal("hit", weapon_type, damage)
emit_signal("game_over")

`pub fn get(&self, property: impl Into<GodotString>) -> Variant`[src]

Returns the Variant value of the given property. If the property doesn't exist, this will return null. Note: In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).

`pub fn get_class(&self) -> GodotString`[src]

Returns the object's class as a String.

`pub fn get_incoming_connections(&self) -> VariantArray<Shared>`[src]

Returns an [Array] of dictionaries with information about signals that are connected to the object. Each Dictionary contains three String entries:

source is a reference to the signal emitter.
signal_name is the name of the connected signal.
method_name is the name of the method to which the signal is connected.

`pub fn get_indexed(&self, property: impl Into<NodePath>) -> Variant`[src]

Gets the object's property indexed by the given NodePath. The node path should be relative to the current object and can use the colon character (:) to access nested properties. Examples: "position:x" or "material:next_pass:blend_mode".

`pub fn get_instance_id(&self) -> i64`[src]

Returns the object's unique instance ID. This ID can be saved in EncodedObjectAsID, and can be used to retrieve the object instance with [method @GDScript.instance_from_id].

`pub fn get_meta(&self, name: impl Into<GodotString>) -> Variant`[src]

Returns the object's metadata entry for the given name.

`pub fn get_meta_list(&self) -> TypedArray<GodotString>`[src]

Returns the object's metadata as a [PoolStringArray].

`pub fn get_method_list(&self) -> VariantArray<Shared>`[src]

Returns the object's methods and their signatures as an [Array].

`pub fn get_property_list(&self) -> VariantArray<Shared>`[src]

Returns the object's property list as an [Array] of dictionaries. Each property's Dictionary contain at least name: String and type: int (see [enum Variant.Type]) entries. Optionally, it can also include hint: int (see [enum PropertyHint]), hint_string: String, and usage: int (see [enum PropertyUsageFlags]).

`pub fn get_script(&self) -> Option<Ref<Reference, Shared>>`[src]

Returns the object's Script instance, or null if none is assigned.

`pub fn get_signal_connection_list( &self, signal: impl Into<GodotString> ) -> VariantArray<Shared>`[src]

Returns an [Array] of connections for the given signal.

`pub fn get_signal_list(&self) -> VariantArray<Shared>`[src]

Returns the list of signals as an [Array] of dictionaries.

`pub fn has_meta(&self, name: impl Into<GodotString>) -> bool`[src]

Returns true if a metadata entry is found with the given name.

`pub fn has_method(&self, method: impl Into<GodotString>) -> bool`[src]

Returns true if the object contains the given method.

`pub fn has_signal(&self, signal: impl Into<GodotString>) -> bool`[src]

Returns true if the given signal exists.

`pub fn has_user_signal(&self, signal: impl Into<GodotString>) -> bool`[src]

Returns true if the given user-defined signal exists. Only signals added using [method add_user_signal] are taken into account.

`pub fn is_blocking_signals(&self) -> bool`[src]

Returns true if signal emission blocking is enabled.

`pub fn is_class(&self, class: impl Into<GodotString>) -> bool`[src]

Returns true if the object inherits from the given class.

`pub fn is_connected( &self, signal: impl Into<GodotString>, target: impl AsArg<Object>, method: impl Into<GodotString> ) -> bool`[src]

Returns true if a connection exists for a given signal, target, and method.

`pub fn is_queued_for_deletion(&self) -> bool`[src]

Returns true if the [method Node.queue_free] method was called for the object.

`pub fn notification(&self, what: i64, reversed: bool)`[src]

Send a given notification to the object, which will also trigger a call to the [method _notification] method of all classes that the object inherits from. If reversed is true, [method _notification] is called first on the object's own class, and then up to its successive parent classes. If reversed is false, [method _notification] is called first on the highest ancestor (Object itself), and then down to its successive inheriting classes.

Default Arguments

reversed - false

`pub fn property_list_changed_notify(&self)`[src]

Notify the editor that the property list has changed, so that editor plugins can take the new values into account. Does nothing on export builds.

`pub fn remove_meta(&self, name: impl Into<GodotString>)`[src]

Removes a given entry from the object's metadata. See also [method set_meta].

`pub fn set(&self, property: impl Into<GodotString>, value: impl OwnedToVariant)`[src]

Assigns a new value to the given property. If the property does not exist, nothing will happen. Note: In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).

`pub fn set_block_signals(&self, enable: bool)`[src]

If set to true, signal emission is blocked.

`pub fn set_deferred( &self, property: impl Into<GodotString>, value: impl OwnedToVariant )`[src]

Assigns a new value to the given property, after the current frame's physics step. This is equivalent to calling [method set] via [method call_deferred], i.e. call_deferred("set", property, value). Note: In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).

`pub fn set_indexed( &self, property: impl Into<NodePath>, value: impl OwnedToVariant )`[src]

Sample code is GDScript unless otherwise noted.

Assigns a new value to the property identified by the NodePath. The node path should be relative to the current object and can use the colon character (:) to access nested properties. Example:

set_indexed("position", Vector2(42, 0))
set_indexed("position:y", -10)
print(position) # (42, -10)

`pub fn set_message_translation(&self, enable: bool)`[src]

Defines whether the object can translate strings (with calls to [method tr]). Enabled by default.

`pub fn set_meta(&self, name: impl Into<GodotString>, value: impl OwnedToVariant)`[src]

Adds, changes or removes a given entry in the object's metadata. Metadata are serialized and can take any Variant value. To remove a given entry from the object's metadata, use [method remove_meta]. Metadata is also removed if its value is set to null. This means you can also use set_meta("name", null) to remove metadata for "name".

`pub fn set_script(&self, script: impl AsArg<Reference>)`[src]

Assigns a script to the object. Each object can have a single script assigned to it, which are used to extend its functionality. If the object already had a script, the previous script instance will be freed and its variables and state will be lost. The new script's [method _init] method will be called.

`pub fn to_string(&self) -> GodotString`[src]

Returns a String representing the object. If not overridden, defaults to "[ClassName:RID]". Override the method [method _to_string] to customize the String representation.

`pub fn tr(&self, message: impl Into<GodotString>) -> GodotString`[src]

Translates a message using translation catalogs configured in the Project Settings. Only works if message translation is enabled (which it is by default), otherwise it returns the message unchanged. See [method set_message_translation].

Trait Implementations

`impl Debug for Object`[src]

`pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>`[src]

`impl GodotObject for Object`[src]

`type RefKind = ManuallyManaged`

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information. Read more