Struct gdnative_visual_script::common::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
impl Objectpub fn new() -> Object
pub fn new() -> ObjectConstructor.
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)
pub unsafe fn free(self)Manually deallocate the object.
pub unsafe fn _notification(&mut self, what: i64)
pub unsafe fn _notification(&mut self, what: i64)pub unsafe fn _set(&mut self, property: GodotString, value: Variant) -> bool
pub unsafe fn _set(&mut self, property: GodotString, value: Variant) -> boolpub unsafe fn _get(&mut self, property: GodotString) -> Variant
pub unsafe fn _get(&mut self, property: GodotString) -> Variantpub unsafe fn _get_property_list(&mut self) -> VariantArray
pub unsafe fn _get_property_list(&mut self) -> VariantArraypub unsafe fn _init(&mut self)
pub unsafe fn _init(&mut self)pub unsafe fn get_class(&self) -> GodotString
pub unsafe fn get_class(&self) -> GodotStringpub unsafe fn is_class(&self, _type: GodotString) -> bool
pub unsafe fn is_class(&self, _type: GodotString) -> boolpub unsafe fn set(&mut self, property: GodotString, value: Variant)
pub unsafe fn set(&mut self, property: GodotString, value: Variant)pub unsafe fn get(&self, property: GodotString) -> Variant
pub unsafe fn get(&self, property: GodotString) -> Variantpub unsafe fn set_indexed(&mut self, property: NodePath, value: Variant)
pub unsafe fn set_indexed(&mut self, property: NodePath, value: Variant)pub unsafe fn get_indexed(&self, property: NodePath) -> Variant
pub unsafe fn get_indexed(&self, property: NodePath) -> Variantpub unsafe fn get_property_list(&self) -> VariantArray
pub unsafe fn get_property_list(&self) -> VariantArraypub unsafe fn get_method_list(&self) -> VariantArray
pub unsafe fn get_method_list(&self) -> VariantArraypub unsafe fn notification(&mut self, what: i64, reversed: bool)
pub unsafe fn notification(&mut self, what: i64, reversed: bool)pub unsafe fn get_instance_id(&self) -> i64
pub unsafe fn get_instance_id(&self) -> i64pub unsafe fn set_script(&mut self, script: Option<Reference>)
pub unsafe fn set_script(&mut self, script: Option<Reference>)pub unsafe fn get_script(&self) -> Option<Reference>
pub unsafe fn get_script(&self) -> Option<Reference>pub unsafe fn set_meta(&mut self, name: GodotString, value: Variant)
pub unsafe fn set_meta(&mut self, name: GodotString, value: Variant)pub unsafe fn get_meta(&self, name: GodotString) -> Variant
pub unsafe fn get_meta(&self, name: GodotString) -> Variantpub unsafe fn has_meta(&self, name: GodotString) -> bool
pub unsafe fn has_meta(&self, name: GodotString) -> boolpub unsafe fn get_meta_list(&self) -> StringArray
pub unsafe fn get_meta_list(&self) -> StringArraypub unsafe fn add_user_signal(
&mut self,
signal: GodotString,
arguments: VariantArray
)
pub unsafe fn add_user_signal(
&mut self,
signal: GodotString,
arguments: VariantArray
)pub unsafe fn has_user_signal(&self, signal: GodotString) -> bool
pub unsafe fn has_user_signal(&self, signal: GodotString) -> boolpub unsafe fn emit_signal(
&mut self,
signal: GodotString,
varargs: &[Variant]
) -> Variant
pub unsafe fn emit_signal(
&mut self,
signal: GodotString,
varargs: &[Variant]
) -> Variantpub unsafe fn call(
&mut self,
method: GodotString,
varargs: &[Variant]
) -> Variant
pub unsafe fn call(
&mut self,
method: GodotString,
varargs: &[Variant]
) -> Variantpub unsafe fn call_deferred(
&mut self,
method: GodotString,
varargs: &[Variant]
) -> Variant
pub unsafe fn call_deferred(
&mut self,
method: GodotString,
varargs: &[Variant]
) -> Variantpub unsafe fn callv(
&mut self,
method: GodotString,
arg_array: VariantArray
) -> Variant
pub unsafe fn callv(
&mut self,
method: GodotString,
arg_array: VariantArray
) -> Variantpub unsafe fn has_method(&self, method: GodotString) -> bool
pub unsafe fn has_method(&self, method: GodotString) -> boolpub unsafe fn get_signal_list(&self) -> VariantArray
pub unsafe fn get_signal_list(&self) -> VariantArraypub unsafe fn get_signal_connection_list(
&self,
signal: GodotString
) -> VariantArray
pub unsafe fn get_signal_connection_list(
&self,
signal: GodotString
) -> VariantArraypub unsafe fn get_incoming_connections(&self) -> VariantArray
pub unsafe fn get_incoming_connections(&self) -> VariantArraypub unsafe fn connect(
&mut self,
signal: GodotString,
target: Option<Object>,
method: GodotString,
binds: VariantArray,
flags: i64
) -> Result<(), GodotError>
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 disconnect(
&mut self,
signal: GodotString,
target: Option<Object>,
method: GodotString
)pub unsafe fn is_connected(
&self,
signal: GodotString,
target: Option<Object>,
method: GodotString
) -> bool
pub unsafe fn is_connected(
&self,
signal: GodotString,
target: Option<Object>,
method: GodotString
) -> boolpub unsafe fn set_block_signals(&mut self, enable: bool)
pub unsafe fn set_block_signals(&mut self, enable: bool)pub unsafe fn is_blocking_signals(&self) -> bool
pub unsafe fn is_blocking_signals(&self) -> boolpub unsafe fn property_list_changed_notify(&mut self)
pub unsafe fn property_list_changed_notify(&mut self)pub unsafe fn set_message_translation(&mut self, enable: bool)
pub unsafe fn set_message_translation(&mut self, enable: bool)pub unsafe fn can_translate_messages(&self) -> bool
pub unsafe fn can_translate_messages(&self) -> boolpub unsafe fn tr(&self, message: GodotString) -> GodotString
pub unsafe fn tr(&self, message: GodotString) -> GodotStringpub unsafe fn is_queued_for_deletion(&self) -> bool
pub unsafe fn is_queued_for_deletion(&self) -> boolpub unsafe fn cast<T>(&self) -> Option<T> where
T: GodotObject,
pub unsafe fn cast<T>(&self) -> Option<T> where
T: GodotObject, Generic dynamic cast.
Trait Implementations
impl Free for Object
impl Free for Objectunsafe fn godot_free(self)
unsafe fn godot_free(self)impl ToVariant for Object
impl ToVariant for Objectfn to_variant(&self) -> Variant
fn to_variant(&self) -> Variantfn from_variant(variant: &Variant) -> Option<Object>
fn from_variant(variant: &Variant) -> Option<Object>impl Clone for Object
impl Clone for Objectfn clone(&self) -> Object
fn clone(&self) -> ObjectReturns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)1.0.0[src]
fn clone_from(&mut self, source: &Self)Performs copy-assignment from source. Read more
impl Debug for Object
impl Debug for Objectfn fmt(&self, f: &mut Formatter) -> Result<(), Error>
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>Formats the value using the given formatter. Read more
impl GodotObject for Object
impl GodotObject for Objectfn class_name() -> &'static str
fn class_name() -> &'static strunsafe fn from_sys(obj: *mut c_void) -> Object
unsafe fn from_sys(obj: *mut c_void) -> Objectunsafe fn to_sys(&self) -> *mut c_void
unsafe fn to_sys(&self) -> *mut c_voidimpl Copy for Object
impl Copy for Object