Struct gdnative::MainLoop

pub struct MainLoop { /* fields omitted */ }

core class MainLoop inherits Object (unsafe).

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.

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

Class hierarchy

MainLoop inherits methods from:

• Object

Methods

impl MainLoop

Constants

pub const NOTIFICATION_APP_PAUSED: i64

pub const NOTIFICATION_WM_FOCUS_OUT: i64

pub const NOTIFICATION_WM_ABOUT: i64

pub const NOTIFICATION_WM_MOUSE_ENTER: i64

pub const NOTIFICATION_WM_MOUSE_EXIT: i64

pub const NOTIFICATION_WM_UNFOCUS_REQUEST: i64

pub const NOTIFICATION_OS_MEMORY_WARNING: i64

pub const NOTIFICATION_WM_GO_BACK_REQUEST: i64

pub const NOTIFICATION_CRASH: i64

pub const NOTIFICATION_OS_IME_UPDATE: i64

pub const NOTIFICATION_WM_QUIT_REQUEST: i64

pub const NOTIFICATION_WM_FOCUS_IN: i64

pub const NOTIFICATION_APP_RESUMED: i64

pub const NOTIFICATION_TRANSLATION_CHANGED: i64

impl MainLoop

pub fn new() -> MainLoop

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

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn _drop_files(&mut self, files: StringArray, from_screen: i64)

pub unsafe fn _finalize(&mut self)

pub unsafe fn _global_menu_action(&mut self, id: Variant, meta: Variant)

pub unsafe fn _idle(&mut self, delta: f64) -> bool

pub unsafe fn _initialize(&mut self)

pub unsafe fn _input_event(&mut self, event: Option<InputEvent>)

pub unsafe fn _input_text(&mut self, text: GodotString)

pub unsafe fn _iteration(&mut self, delta: f64) -> bool

pub unsafe fn finish(&mut self)

pub unsafe fn idle(&mut self, delta: f64) -> bool

pub unsafe fn init(&mut self)

pub unsafe fn input_event(&mut self, event: Option<InputEvent>)

pub unsafe fn input_text(&mut self, text: GodotString)

pub unsafe fn iteration(&mut self, delta: f64) -> bool

pub unsafe fn to_object(&self) -> Object

Up-cast.

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

Generic dynamic cast.

Methods from Deref<Target = Object>

pub const CONNECT_DEFERRED: i64

pub const CONNECT_ONESHOT: i64

pub const CONNECT_REFERENCE_COUNTED: i64

pub const NOTIFICATION_POSTINITIALIZE: i64

pub const NOTIFICATION_PREDELETE: i64

pub const CONNECT_PERSIST: 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
) -> 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, 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>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

Trait Implementations

impl Clone for MainLoop

fn clone(&self) -> MainLoop

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for MainLoop

impl Debug for MainLoop

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

Formats the value using the given formatter.

impl Deref for MainLoop

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Object

Dereferences the value.

impl DerefMut for MainLoop

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

Mutably dereferences the value.

impl Free for MainLoop

unsafe fn godot_free(self)

impl FromVariant for MainLoop

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

impl GodotObject for MainLoop

fn class_name() -> &'static str

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

unsafe fn from_return_position_sys(obj: *mut c_void) -> MainLoop

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

impl Instanciable for MainLoop

fn construct() -> MainLoop

impl ToVariant for MainLoop

fn to_variant(&self) -> Variant