Struct gdnative_bindings::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 an unsafe pointer, and all of its methods are unsafe.

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 Object::free.

Methods

impl Object

Constants

pub const NOTIFICATION_POSTINITIALIZE: i64

pub const CONNECT_DEFERRED: i64

pub const CONNECT_ONESHOT: i64

pub const CONNECT_REFERENCE_COUNTED: i64

pub const NOTIFICATION_PREDELETE: i64

pub const CONNECT_PERSIST: i64

impl Object

pub fn new() -> Object

Constructor.

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 Object::free.

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn _get(&mut self, property: GodotString) -> Variant

pub unsafe fn _get_property_list(&mut self) -> VariantArray

pub unsafe fn _init(&mut self)

pub unsafe fn _notification(&mut self, what: i64)

pub unsafe fn _set(&mut self, property: GodotString, value: Variant) -> bool

pub unsafe fn add_user_signal(
    &mut self,
    signal: GodotString,
    arguments: VariantArray
)

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

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

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

pub unsafe fn can_translate_messages(&self) -> bool

pub unsafe fn connect(
    &mut self,
    signal: GodotString,
    target: Option<Object>,
    method: GodotString,
    binds: VariantArray,
    flags: i64
) -> Result<(), GodotError>

pub unsafe fn disconnect(
    &mut self,
    signal: GodotString,
    target: Option<Object>,
    method: GodotString
)

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

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

pub unsafe fn get_class(&self) -> GodotString

pub unsafe fn get_incoming_connections(&self) -> VariantArray

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

pub unsafe fn get_instance_id(&self) -> i64

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

pub unsafe fn get_meta_list(&self) -> StringArray

pub unsafe fn get_method_list(&self) -> VariantArray

pub unsafe fn get_property_list(&self) -> VariantArray

pub unsafe fn get_script(&self) -> Option<Reference>

pub unsafe fn get_signal_connection_list(
    &self,
    signal: GodotString
) -> VariantArray

pub unsafe fn get_signal_list(&self) -> VariantArray

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

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

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

pub unsafe fn is_blocking_signals(&self) -> bool

pub unsafe fn is_class(&self, _type: GodotString) -> bool

pub unsafe fn is_connected(
    &self,
    signal: GodotString,
    target: Option<Object>,
    method: GodotString
) -> bool

pub unsafe fn is_queued_for_deletion(&self) -> bool

pub unsafe fn notification(&mut self, what: i64, reversed: bool)

pub unsafe fn property_list_changed_notify(&mut self)

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

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

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

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

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

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

pub unsafe fn set_script(&mut self, script: Option<Reference>)

pub unsafe fn tr(&self, message: GodotString) -> GodotString

pub unsafe fn cast<T>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

Trait Implementations

impl Clone for Object

fn clone(&self) -> Object

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Object

impl Debug for Object

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

Formats the value using the given formatter.

impl Free for Object

unsafe fn godot_free(self)

impl FromVariant for Object

fn from_variant(variant: &Variant) -> Option<Object>

impl GodotObject for Object

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut c_void) -> Object

unsafe fn to_sys(&self) -> *mut c_void

impl Instanciable for Object

fn construct() -> Object

impl ToVariant for Object

fn to_variant(&self) -> Variant