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

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.

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 Ptr::free, or Ptr::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 Ptr::free, or preferably Ptr::queue_free if it is a Node.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Trait Implementations

`impl Debug for Object`[src]

`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