[−][src]Struct gdnative::Node

pub struct Node { /* fields omitted */ }

core class Node 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.

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

Class hierarchy

Node inherits methods from:

Object

Methods

`impl Node`[src]

Constants

`pub const NOTIFICATION_PATH_CHANGED: i64`[src]

`pub const NOTIFICATION_WM_FOCUS_IN: i64`[src]

`pub const NOTIFICATION_PHYSICS_PROCESS: i64`[src]

`pub const NOTIFICATION_INTERNAL_PHYSICS_PROCESS: i64`[src]

`pub const NOTIFICATION_WM_MOUSE_EXIT: i64`[src]

`pub const DUPLICATE_SCRIPTS: i64`[src]

`pub const NOTIFICATION_APP_RESUMED: i64`[src]

`pub const NOTIFICATION_WM_ABOUT: i64`[src]

`pub const NOTIFICATION_APP_PAUSED: i64`[src]

`pub const NOTIFICATION_UNPARENTED: i64`[src]

`pub const NOTIFICATION_WM_FOCUS_OUT: i64`[src]

`pub const NOTIFICATION_TRANSLATION_CHANGED: i64`[src]

`pub const NOTIFICATION_OS_IME_UPDATE: i64`[src]

`pub const NOTIFICATION_INSTANCED: i64`[src]

`pub const NOTIFICATION_DRAG_BEGIN: i64`[src]

`pub const NOTIFICATION_READY: i64`[src]

`pub const NOTIFICATION_UNPAUSED: i64`[src]

`pub const PAUSE_MODE_INHERIT: i64`[src]

`pub const PAUSE_MODE_STOP: i64`[src]

`pub const NOTIFICATION_WM_UNFOCUS_REQUEST: i64`[src]

`pub const DUPLICATE_GROUPS: i64`[src]

`pub const NOTIFICATION_CRASH: i64`[src]

`pub const NOTIFICATION_INTERNAL_PROCESS: i64`[src]

`pub const NOTIFICATION_DRAG_END: i64`[src]

`pub const DUPLICATE_USE_INSTANCING: i64`[src]

`pub const NOTIFICATION_PROCESS: i64`[src]

`pub const DUPLICATE_SIGNALS: i64`[src]

`pub const NOTIFICATION_EXIT_TREE: i64`[src]

`pub const NOTIFICATION_WM_QUIT_REQUEST: i64`[src]

`pub const NOTIFICATION_MOVED_IN_PARENT: i64`[src]

`pub const NOTIFICATION_OS_MEMORY_WARNING: i64`[src]

`pub const NOTIFICATION_PAUSED: i64`[src]

`pub const NOTIFICATION_PARENTED: i64`[src]

`pub const NOTIFICATION_ENTER_TREE: i64`[src]

`pub const NOTIFICATION_WM_MOUSE_ENTER: i64`[src]

`pub const PAUSE_MODE_PROCESS: i64`[src]

`pub const NOTIFICATION_WM_GO_BACK_REQUEST: i64`[src]

`impl Node`[src]

`pub fn new() -> Node`[src]

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

`pub unsafe fn free(self)`[src]

Manually deallocate the object.

`pub unsafe fn _enter_tree(&mut self)`[src]

`pub unsafe fn _exit_tree(&mut self)`[src]

`pub unsafe fn _get_configuration_warning(&mut self) -> GodotString`[src]

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

`pub unsafe fn _get_import_path(&self) -> NodePath`[src]

`pub unsafe fn _input(&mut self, event: Option<InputEvent>)`[src]

`pub unsafe fn _physics_process(&mut self, delta: f64)`[src]

`pub unsafe fn _process(&mut self, delta: f64)`[src]

`pub unsafe fn _ready(&mut self)`[src]

`pub unsafe fn _set_editor_description( &mut self, editor_description: GodotString )`[src]

`pub unsafe fn _set_import_path(&mut self, import_path: NodePath)`[src]

`pub unsafe fn _unhandled_input(&mut self, event: Option<InputEvent>)`[src]

`pub unsafe fn _unhandled_key_input(&mut self, event: Option<InputEventKey>)`[src]

`pub unsafe fn add_child( &mut self, node: Option<Node>, legible_unique_name: bool )`[src]

`pub unsafe fn add_child_below_node( &mut self, node: Option<Node>, child_node: Option<Node>, legible_unique_name: bool )`[src]

`pub unsafe fn add_to_group(&mut self, group: GodotString, persistent: bool)`[src]

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

`pub unsafe fn duplicate(&self, flags: i64) -> Option<Node>`[src]

`pub unsafe fn find_node( &self, mask: GodotString, recursive: bool, owned: bool ) -> Option<Node>`[src]

`pub unsafe fn find_parent(&self, mask: GodotString) -> Option<Node>`[src]

`pub unsafe fn get_child(&self, idx: i64) -> Option<Node>`[src]

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

`pub unsafe fn get_children(&self) -> VariantArray`[src]

`pub unsafe fn get_custom_multiplayer(&self) -> Option<MultiplayerAPI>`[src]

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

`pub unsafe fn get_groups(&self) -> VariantArray`[src]

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

`pub unsafe fn get_multiplayer(&self) -> Option<MultiplayerAPI>`[src]

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

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

`pub unsafe fn get_node(&self, path: NodePath) -> Option<Node>`[src]

`pub unsafe fn get_node_and_resource(&mut self, path: NodePath) -> VariantArray`[src]

`pub unsafe fn get_node_or_null(&self, path: NodePath) -> Option<Node>`[src]

`pub unsafe fn get_owner(&self) -> Option<Node>`[src]

`pub unsafe fn get_parent(&self) -> Option<Node>`[src]

`pub unsafe fn get_path(&self) -> NodePath`[src]

`pub unsafe fn get_path_to(&self, node: Option<Node>) -> NodePath`[src]

`pub unsafe fn get_pause_mode(&self) -> NodePauseMode`[src]

`pub unsafe fn get_physics_process_delta_time(&self) -> f64`[src]

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

`pub unsafe fn get_process_delta_time(&self) -> f64`[src]

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

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

`pub unsafe fn get_tree(&self) -> Option<SceneTree>`[src]

`pub unsafe fn get_viewport(&self) -> Option<Viewport>`[src]

`pub unsafe fn has_node(&self, path: NodePath) -> bool`[src]

`pub unsafe fn has_node_and_resource(&self, path: NodePath) -> bool`[src]

`pub unsafe fn is_a_parent_of(&self, node: Option<Node>) -> bool`[src]

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

`pub unsafe fn is_greater_than(&self, node: Option<Node>) -> bool`[src]

`pub unsafe fn is_in_group(&self, group: GodotString) -> bool`[src]

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

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

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

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

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

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

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

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

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

`pub unsafe fn move_child(&mut self, child_node: Option<Node>, to_position: i64)`[src]

`pub unsafe fn print_stray_nodes(&mut self)`[src]

`pub unsafe fn print_tree(&mut self)`[src]

`pub unsafe fn print_tree_pretty(&mut self)`[src]

`pub unsafe fn propagate_call( &mut self, method: GodotString, args: VariantArray, parent_first: bool )`[src]

`pub unsafe fn propagate_notification(&mut self, what: i64)`[src]

`pub unsafe fn queue_free(&mut self)`[src]

`pub unsafe fn raise(&mut self)`[src]

`pub unsafe fn remove_and_skip(&mut self)`[src]

`pub unsafe fn remove_child(&mut self, node: Option<Node>)`[src]

`pub unsafe fn remove_from_group(&mut self, group: GodotString)`[src]

`pub unsafe fn replace_by(&mut self, node: Option<Node>, keep_data: bool)`[src]

`pub unsafe fn request_ready(&mut self)`[src]

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

`pub unsafe fn rpc_config(&mut self, method: GodotString, mode: i64)`[src]

`pub unsafe fn rpc_id( &mut self, peer_id: i64, method: GodotString, varargs: &[Variant] ) -> Variant`[src]

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

`pub unsafe fn rpc_unreliable_id( &mut self, peer_id: i64, method: GodotString, varargs: &[Variant] ) -> Variant`[src]

`pub unsafe fn rset(&mut self, property: GodotString, value: Variant)`[src]

`pub unsafe fn rset_config(&mut self, property: GodotString, mode: i64)`[src]

`pub unsafe fn rset_id( &mut self, peer_id: i64, property: GodotString, value: Variant )`[src]

`pub unsafe fn rset_unreliable(&mut self, property: GodotString, value: Variant)`[src]

`pub unsafe fn rset_unreliable_id( &mut self, peer_id: i64, property: GodotString, value: Variant )`[src]

`pub unsafe fn set_custom_multiplayer(&mut self, api: Option<MultiplayerAPI>)`[src]

`pub unsafe fn set_display_folded(&mut self, fold: bool)`[src]

`pub unsafe fn set_filename(&mut self, filename: GodotString)`[src]

`pub unsafe fn set_name(&mut self, name: GodotString)`[src]

`pub unsafe fn set_network_master(&mut self, id: i64, recursive: bool)`[src]

`pub unsafe fn set_owner(&mut self, owner: Option<Node>)`[src]

`pub unsafe fn set_pause_mode(&mut self, mode: i64)`[src]

`pub unsafe fn set_physics_process(&mut self, enable: bool)`[src]

`pub unsafe fn set_physics_process_internal(&mut self, enable: bool)`[src]

`pub unsafe fn set_process(&mut self, enable: bool)`[src]

`pub unsafe fn set_process_input(&mut self, enable: bool)`[src]

`pub unsafe fn set_process_internal(&mut self, enable: bool)`[src]

`pub unsafe fn set_process_priority(&mut self, priority: i64)`[src]

`pub unsafe fn set_process_unhandled_input(&mut self, enable: bool)`[src]

`pub unsafe fn set_process_unhandled_key_input(&mut self, enable: bool)`[src]

`pub unsafe fn set_scene_instance_load_placeholder( &mut self, load_placeholder: bool )`[src]

`pub unsafe fn update_configuration_warning(&mut self)`[src]

`pub unsafe fn to_object(&self) -> Object`[src]

Up-cast.

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

Generic dynamic cast.

Methods from Deref<Target = Object>

`pub const CONNECT_DEFERRED: i64`[src]

`pub const CONNECT_ONESHOT: i64`[src]

`pub const CONNECT_REFERENCE_COUNTED: i64`[src]

`pub const NOTIFICATION_POSTINITIALIZE: i64`[src]

`pub const NOTIFICATION_PREDELETE: i64`[src]

`pub const CONNECT_PERSIST: i64`[src]

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

`pub unsafe fn _get_property_list(&mut self) -> VariantArray`[src]

`pub unsafe fn _init(&mut self)`[src]

`pub unsafe fn _notification(&mut self, what: i64)`[src]

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

`pub unsafe fn _to_string(&mut self) -> GodotString`[src]

`pub unsafe fn add_user_signal( &mut self, signal: GodotString, arguments: VariantArray )`[src]

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

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

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

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

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

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

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

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

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

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

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

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

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

`pub unsafe fn get_meta_list(&self) -> StringArray`[src]

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

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

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

`pub unsafe fn get_signal_connection_list( &self, signal: GodotString ) -> VariantArray`[src]

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

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

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

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

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

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

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

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

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

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

`pub unsafe fn remove_meta(&mut self, name: GodotString)`[src]

`pub unsafe fn set(&mut self, property: GodotString, value: Variant)`[src]

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

`pub unsafe fn set_deferred(&mut self, property: GodotString, value: Variant)`[src]

`pub unsafe fn set_indexed(&mut self, property: NodePath, value: Variant)`[src]

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

`pub unsafe fn set_meta(&mut self, name: GodotString, value: Variant)`[src]

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

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

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

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

Generic dynamic cast.

Trait Implementations

`impl Clone for Node`[src]

`fn clone(&self) -> Node`[src]

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Copy for Node`[src]

`impl Debug for Node`[src]

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

`impl Deref for Node`[src]

`type Target = Object`

The resulting type after dereferencing.

`fn deref(&self) -> &Object`[src]

`impl DerefMut for Node`[src]

`fn deref_mut(&mut self) -> &mut Object`[src]

`impl Free for Node`[src]

`unsafe fn godot_free(self)`[src]

`impl FromVariant for Node`[src]

`fn from_variant(variant: &Variant) -> Result<Node, FromVariantError>`[src]

`impl GodotObject for Node`[src]

`fn class_name() -> &'static str`[src]

`unsafe fn from_sys(obj: *mut c_void) -> Node`[src]

`unsafe fn from_return_position_sys(obj: *mut c_void) -> Node`[src]

`unsafe fn to_sys(&self) -> *mut c_void`[src]

`impl Instanciable for Node`[src]

`fn construct() -> Node`[src]

`impl QueueFree for Node`[src]

`unsafe fn godot_queue_free(&mut self)`[src]

`impl ToVariant for Node`[src]

`fn to_variant(&self) -> Variant`[src]

Auto Trait Implementations

`impl RefUnwindSafe for Node`

`impl !Send for Node`

`impl !Sync for Node`

`impl Unpin for Node`

`impl UnwindSafe for Node`

Blanket Implementations

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> Export for T where T: GodotObject + ToVariant,` [src]

`type Hint = ()`

A type-specific hint type that is valid for the type being exported.

`fn export_info(_hint: Option<<T as Export>::Hint>) -> ExportInfo`[src]

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> Into<U> for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

The resulting type after obtaining ownership.

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T, U> TryFrom<U> for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

`impl<T, U> TryInto<U> for T where U: TryFrom<T>,` [src]

`type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]