Struct Node

pub struct Node { /* private fields */ }

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.

Feature flag

This type is behind the gdnative crate’s common feature flag.

Class hierarchy

Node inherits methods from:

• Object

Implementations

impl Node

pub fn new() -> Self

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)

Manually deallocate the object.

pub unsafe fn _process(&mut self, delta: f64)

pub unsafe fn _physics_process(&mut self, delta: f64)

pub unsafe fn _enter_tree(&mut self)

pub unsafe fn _exit_tree(&mut self)

pub unsafe fn _ready(&mut self)

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

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

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

pub unsafe fn add_child_below_node( &mut self, node: Option<Object>, child_node: Option<Object>, legible_unique_name: bool, )

pub unsafe fn set_name(&mut self, name: GodotString)

pub unsafe fn get_name(&self) -> GodotString

pub unsafe fn add_child( &mut self, node: Option<Object>, legible_unique_name: bool, )

pub unsafe fn remove_child(&mut self, node: Option<Object>)

pub unsafe fn get_child_count(&self) -> i64

pub unsafe fn get_children(&self) -> VariantArray

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

pub unsafe fn has_node(&self, path: NodePath) -> bool

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

pub unsafe fn get_parent(&self) -> Option<Node>

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

pub unsafe fn has_node_and_resource(&self, path: NodePath) -> bool

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

pub unsafe fn is_inside_tree(&self) -> bool

pub unsafe fn is_a_parent_of(&self, node: Option<Object>) -> bool

pub unsafe fn is_greater_than(&self, node: Option<Object>) -> bool

pub unsafe fn get_path(&self) -> NodePath

pub unsafe fn get_path_to(&self, node: Option<Object>) -> NodePath

pub unsafe fn add_to_group(&mut self, group: GodotString, persistent: bool)

pub unsafe fn remove_from_group(&mut self, group: GodotString)

pub unsafe fn is_in_group(&self, group: GodotString) -> bool

pub unsafe fn move_child( &mut self, child_node: Option<Object>, to_position: i64, )

pub unsafe fn get_groups(&self) -> VariantArray

pub unsafe fn raise(&mut self)

pub unsafe fn set_owner(&mut self, owner: Option<Object>)

pub unsafe fn get_owner(&self) -> Option<Node>

pub unsafe fn remove_and_skip(&mut self)

pub unsafe fn get_index(&self) -> i64

pub unsafe fn print_tree(&mut self)

pub unsafe fn print_tree_pretty(&mut self)

pub unsafe fn set_filename(&mut self, filename: GodotString)

pub unsafe fn get_filename(&self) -> GodotString

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

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

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

pub unsafe fn get_physics_process_delta_time(&self) -> f64

pub unsafe fn is_physics_processing(&self) -> bool

pub unsafe fn get_process_delta_time(&self) -> f64

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

pub unsafe fn set_process_priority(&mut self, priority: i64)

pub unsafe fn is_processing(&self) -> bool

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

pub unsafe fn is_processing_input(&self) -> bool

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

pub unsafe fn is_processing_unhandled_input(&self) -> bool

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

pub unsafe fn is_processing_unhandled_key_input(&self) -> bool

pub unsafe fn set_pause_mode(&mut self, mode: i64)

pub unsafe fn get_pause_mode(&self) -> NodePauseMode

pub unsafe fn can_process(&self) -> bool

pub unsafe fn print_stray_nodes(&mut self)

pub unsafe fn get_position_in_parent(&self) -> i64

pub unsafe fn set_display_folded(&mut self, fold: bool)

pub unsafe fn is_displayed_folded(&self) -> bool

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

pub unsafe fn is_processing_internal(&self) -> bool

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

pub unsafe fn is_physics_processing_internal(&self) -> bool

pub unsafe fn get_tree(&self) -> Option<SceneTree>

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

pub unsafe fn replace_by(&mut self, node: Option<Object>, keep_data: bool)

pub unsafe fn set_scene_instance_load_placeholder( &mut self, load_placeholder: bool, )

pub unsafe fn get_scene_instance_load_placeholder(&self) -> bool

pub unsafe fn get_viewport(&self) -> Option<Viewport>

pub unsafe fn queue_free(&mut self)

pub unsafe fn request_ready(&mut self)

pub unsafe fn set_network_master(&mut self, id: i64, recursive: bool)

pub unsafe fn get_network_master(&self) -> i64

pub unsafe fn is_network_master(&self) -> bool

pub unsafe fn get_multiplayer(&self) -> Option<MultiplayerAPI>

pub unsafe fn get_custom_multiplayer(&self) -> Option<MultiplayerAPI>

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

pub unsafe fn rpc_config(&mut self, method: GodotString, mode: i64)

pub unsafe fn rset_config(&mut self, property: GodotString, mode: i64)

pub unsafe fn _set_import_path(&mut self, import_path: NodePath)

pub unsafe fn _get_import_path(&self) -> NodePath

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

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

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

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

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

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

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

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

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

pub unsafe fn _init(&mut self)

Inherited from Object.

pub unsafe fn get_class(&self) -> GodotString

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

pub unsafe fn get_property_list(&self) -> VariantArray

Inherited from Object.

pub unsafe fn get_method_list(&self) -> VariantArray

Inherited from Object.

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

Inherited from Object.

pub unsafe fn get_instance_id(&self) -> i64

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

pub unsafe fn get_meta_list(&self) -> StringArray

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

pub unsafe fn get_signal_list(&self) -> VariantArray

Inherited from Object.

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

Inherited from Object.

pub unsafe fn get_incoming_connections(&self) -> VariantArray

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

pub unsafe fn is_blocking_signals(&self) -> bool

Inherited from Object.

pub unsafe fn property_list_changed_notify(&mut self)

Inherited from Object.

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

Inherited from Object.

pub unsafe fn can_translate_messages(&self) -> bool

Inherited from Object.

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

Inherited from Object.

pub unsafe fn is_queued_for_deletion(&self) -> bool

Inherited from Object.

pub unsafe fn to_object(&self) -> Object

Up-cast.

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

Generic dynamic cast.

Trait Implementations

impl Clone for Node

fn clone(&self) -> Node

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Node

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

Formats the value using the given formatter.

impl Free for Node

unsafe fn godot_free(self)

impl GodotObject for Node

fn class_name() -> &'static str

impl QueueFree for Node

unsafe fn godot_queue_free(&mut self)

impl ToVariant for Node

fn to_variant(&self) -> Variant

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

impl Copy for Node