Struct gdnative_core::Reference

pub struct Reference { /* fields omitted */ }

Base class of all reference-counted types. Inherits Object.

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

Reference inherits methods from:

• Object

Methods

impl Reference

pub fn new() -> Self

pub fn new_ref(&self) -> Self

Creates a new reference to the same reference-counted object.

pub fn init_ref(&mut self) -> bool

pub fn to_object(&self) -> Object

Up-cast.

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

Generic dynamic cast.

Methods from Deref<Target = Object>

pub const CONNECT_DEFERRED: i64

pub const CONNECT_PERSIST: i64

pub const CONNECT_REFERENCE_COUNTED: i64

pub const CONNECT_ONESHOT: i64

pub const NOTIFICATION_POSTINITIALIZE: i64

pub const NOTIFICATION_PREDELETE: i64

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 _to_string(&mut self) -> GodotString

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
) -> GodotResult

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, class: 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 remove_meta(&mut self, name: GodotString)

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 to_string(&mut self) -> GodotString

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

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

Generic dynamic cast.

Trait Implementations

impl Clone for Reference

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Reference

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

Formats the value using the given formatter.

impl Deref for Reference

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Object

Dereferences the value.

impl DerefMut for Reference

fn deref_mut(&mut self) -> &mut Object

Mutably dereferences the value.

impl Drop for Reference

fn drop(&mut self)

Executes the destructor for this type.

impl FromVariant for Reference

fn from_variant(variant: &Variant) -> Result<Self, FromVariantError>

impl GodotObject for Reference

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut godot_object) -> Self

unsafe fn from_return_position_sys(obj: *mut godot_object) -> Self

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

impl Instanciable for Reference

fn construct() -> Self

impl ToVariant for Reference

fn to_variant(&self) -> Variant