[−][src]Struct gdnative_common::Node
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:
Methods
impl Node
[src]
pub fn new() -> Self
[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 _process(&mut self, delta: f64)
[src]
pub unsafe fn _physics_process(&mut self, delta: f64)
[src]
pub unsafe fn _enter_tree(&mut self)
[src]
pub unsafe fn _exit_tree(&mut self)
[src]
pub unsafe fn _ready(&mut self)
[src]
pub unsafe fn _input(&mut self, event: Option<InputEvent>)
[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_below_node(
&mut self,
node: Option<Object>,
child_node: Option<Object>,
legible_unique_name: bool
)
[src]
&mut self,
node: Option<Object>,
child_node: Option<Object>,
legible_unique_name: bool
)
pub unsafe fn set_name(&mut self, name: GodotString)
[src]
pub unsafe fn get_name(&self) -> GodotString
[src]
pub unsafe fn add_child(
&mut self,
node: Option<Object>,
legible_unique_name: bool
)
[src]
&mut self,
node: Option<Object>,
legible_unique_name: bool
)
pub unsafe fn remove_child(&mut self, node: Option<Object>)
[src]
pub unsafe fn get_child_count(&self) -> i64
[src]
pub unsafe fn get_children(&self) -> VariantArray
[src]
pub unsafe fn get_child(&self, idx: i64) -> Option<Node>
[src]
pub unsafe fn has_node(&self, path: NodePath) -> bool
[src]
pub unsafe fn get_node(&self, path: NodePath) -> Option<Node>
[src]
pub unsafe fn get_parent(&self) -> Option<Node>
[src]
pub unsafe fn find_node(
&self,
mask: GodotString,
recursive: bool,
owned: bool
) -> Option<Node>
[src]
&self,
mask: GodotString,
recursive: bool,
owned: bool
) -> Option<Node>
pub unsafe fn has_node_and_resource(&self, path: NodePath) -> bool
[src]
pub unsafe fn get_node_and_resource(&mut self, path: NodePath) -> VariantArray
[src]
pub unsafe fn is_inside_tree(&self) -> bool
[src]
pub unsafe fn is_a_parent_of(&self, node: Option<Object>) -> bool
[src]
pub unsafe fn is_greater_than(&self, node: Option<Object>) -> bool
[src]
pub unsafe fn get_path(&self) -> NodePath
[src]
pub unsafe fn get_path_to(&self, node: Option<Object>) -> NodePath
[src]
pub unsafe fn add_to_group(&mut self, group: GodotString, persistent: bool)
[src]
pub unsafe fn remove_from_group(&mut self, group: GodotString)
[src]
pub unsafe fn is_in_group(&self, group: GodotString) -> bool
[src]
pub unsafe fn move_child(
&mut self,
child_node: Option<Object>,
to_position: i64
)
[src]
&mut self,
child_node: Option<Object>,
to_position: i64
)
pub unsafe fn get_groups(&self) -> VariantArray
[src]
pub unsafe fn raise(&mut self)
[src]
pub unsafe fn set_owner(&mut self, owner: Option<Object>)
[src]
pub unsafe fn get_owner(&self) -> Option<Node>
[src]
pub unsafe fn remove_and_skip(&mut self)
[src]
pub unsafe fn get_index(&self) -> i64
[src]
pub unsafe fn print_tree(&mut self)
[src]
pub unsafe fn print_tree_pretty(&mut self)
[src]
pub unsafe fn set_filename(&mut self, filename: GodotString)
[src]
pub unsafe fn get_filename(&self) -> GodotString
[src]
pub unsafe fn propagate_notification(&mut self, what: i64)
[src]
pub unsafe fn propagate_call(
&mut self,
method: GodotString,
args: VariantArray,
parent_first: bool
)
[src]
&mut self,
method: GodotString,
args: VariantArray,
parent_first: bool
)
pub unsafe fn set_physics_process(&mut self, enable: bool)
[src]
pub unsafe fn get_physics_process_delta_time(&self) -> f64
[src]
pub unsafe fn is_physics_processing(&self) -> bool
[src]
pub unsafe fn get_process_delta_time(&self) -> f64
[src]
pub unsafe fn set_process(&mut self, enable: bool)
[src]
pub unsafe fn set_process_priority(&mut self, priority: i64)
[src]
pub unsafe fn is_processing(&self) -> bool
[src]
pub unsafe fn set_process_input(&mut self, enable: bool)
[src]
pub unsafe fn is_processing_input(&self) -> bool
[src]
pub unsafe fn set_process_unhandled_input(&mut self, enable: bool)
[src]
pub unsafe fn is_processing_unhandled_input(&self) -> bool
[src]
pub unsafe fn set_process_unhandled_key_input(&mut self, enable: bool)
[src]
pub unsafe fn is_processing_unhandled_key_input(&self) -> bool
[src]
pub unsafe fn set_pause_mode(&mut self, mode: i64)
[src]
pub unsafe fn get_pause_mode(&self) -> NodePauseMode
[src]
pub unsafe fn can_process(&self) -> bool
[src]
pub unsafe fn print_stray_nodes(&mut self)
[src]
pub unsafe fn get_position_in_parent(&self) -> i64
[src]
pub unsafe fn set_display_folded(&mut self, fold: bool)
[src]
pub unsafe fn is_displayed_folded(&self) -> bool
[src]
pub unsafe fn set_process_internal(&mut self, enable: bool)
[src]
pub unsafe fn is_processing_internal(&self) -> bool
[src]
pub unsafe fn set_physics_process_internal(&mut self, enable: bool)
[src]
pub unsafe fn is_physics_processing_internal(&self) -> bool
[src]
pub unsafe fn get_tree(&self) -> Option<SceneTree>
[src]
pub unsafe fn duplicate(&self, flags: i64) -> Option<Node>
[src]
pub unsafe fn replace_by(&mut self, node: Option<Object>, keep_data: bool)
[src]
pub unsafe fn set_scene_instance_load_placeholder(
&mut self,
load_placeholder: bool
)
[src]
&mut self,
load_placeholder: bool
)
pub unsafe fn get_scene_instance_load_placeholder(&self) -> bool
[src]
pub unsafe fn get_viewport(&self) -> Option<Viewport>
[src]
pub unsafe fn queue_free(&mut self)
[src]
pub unsafe fn request_ready(&mut self)
[src]
pub unsafe fn set_network_master(&mut self, id: i64, recursive: bool)
[src]
pub unsafe fn get_network_master(&self) -> i64
[src]
pub unsafe fn is_network_master(&self) -> bool
[src]
pub unsafe fn get_multiplayer(&self) -> Option<MultiplayerAPI>
[src]
pub unsafe fn get_custom_multiplayer(&self) -> Option<MultiplayerAPI>
[src]
pub unsafe fn set_custom_multiplayer(&mut self, api: Option<MultiplayerAPI>)
[src]
pub unsafe fn rpc_config(&mut self, method: GodotString, mode: i64)
[src]
pub unsafe fn rset_config(&mut self, property: GodotString, mode: i64)
[src]
pub unsafe fn _set_import_path(&mut self, import_path: NodePath)
[src]
pub unsafe fn _get_import_path(&self) -> NodePath
[src]
pub unsafe fn rpc(
&mut self,
method: GodotString,
varargs: &[Variant]
) -> Variant
[src]
&mut self,
method: GodotString,
varargs: &[Variant]
) -> Variant
pub unsafe fn rpc_unreliable(
&mut self,
method: GodotString,
varargs: &[Variant]
) -> Variant
[src]
&mut self,
method: GodotString,
varargs: &[Variant]
) -> Variant
pub unsafe fn rpc_id(
&mut self,
peer_id: i64,
method: GodotString,
varargs: &[Variant]
) -> Variant
[src]
&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
[src]
&mut self,
peer_id: i64,
method: GodotString,
varargs: &[Variant]
) -> Variant
pub unsafe fn rset(&mut self, property: GodotString, value: Variant)
[src]
pub unsafe fn rset_id(
&mut self,
peer_id: i64,
property: GodotString,
value: Variant
)
[src]
&mut self,
peer_id: i64,
property: GodotString,
value: Variant
)
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]
&mut self,
peer_id: i64,
property: GodotString,
value: Variant
)
pub unsafe fn _notification(&mut self, what: i64)
[src]
Inherited from Object.
pub unsafe fn _set(&mut self, property: GodotString, value: Variant) -> bool
[src]
Inherited from Object.
pub unsafe fn _get(&mut self, property: GodotString) -> Variant
[src]
Inherited from Object.
pub unsafe fn _get_property_list(&mut self) -> VariantArray
[src]
Inherited from Object.
pub unsafe fn _init(&mut self)
[src]
Inherited from Object.
pub unsafe fn get_class(&self) -> GodotString
[src]
Inherited from Object.
pub unsafe fn is_class(&self, _type: GodotString) -> bool
[src]
Inherited from Object.
pub unsafe fn set(&mut self, property: GodotString, value: Variant)
[src]
Inherited from Object.
pub unsafe fn get(&self, property: GodotString) -> Variant
[src]
Inherited from Object.
pub unsafe fn set_indexed(&mut self, property: NodePath, value: Variant)
[src]
Inherited from Object.
pub unsafe fn get_indexed(&self, property: NodePath) -> Variant
[src]
Inherited from Object.
pub unsafe fn get_property_list(&self) -> VariantArray
[src]
Inherited from Object.
pub unsafe fn get_method_list(&self) -> VariantArray
[src]
Inherited from Object.
pub unsafe fn notification(&mut self, what: i64, reversed: bool)
[src]
Inherited from Object.
pub unsafe fn get_instance_id(&self) -> i64
[src]
Inherited from Object.
pub unsafe fn set_script(&mut self, script: Option<Reference>)
[src]
Inherited from Object.
pub unsafe fn get_script(&self) -> Option<Reference>
[src]
Inherited from Object.
pub unsafe fn set_meta(&mut self, name: GodotString, value: Variant)
[src]
Inherited from Object.
pub unsafe fn get_meta(&self, name: GodotString) -> Variant
[src]
Inherited from Object.
pub unsafe fn has_meta(&self, name: GodotString) -> bool
[src]
Inherited from Object.
pub unsafe fn get_meta_list(&self) -> StringArray
[src]
Inherited from Object.
pub unsafe fn add_user_signal(
&mut self,
signal: GodotString,
arguments: VariantArray
)
[src]
&mut self,
signal: GodotString,
arguments: VariantArray
)
Inherited from Object.
pub unsafe fn has_user_signal(&self, signal: GodotString) -> bool
[src]
Inherited from Object.
pub unsafe fn emit_signal(
&mut self,
signal: GodotString,
varargs: &[Variant]
) -> Variant
[src]
&mut self,
signal: GodotString,
varargs: &[Variant]
) -> Variant
Inherited from Object.
pub unsafe fn call(
&mut self,
method: GodotString,
varargs: &[Variant]
) -> Variant
[src]
&mut self,
method: GodotString,
varargs: &[Variant]
) -> Variant
Inherited from Object.
pub unsafe fn call_deferred(
&mut self,
method: GodotString,
varargs: &[Variant]
) -> Variant
[src]
&mut self,
method: GodotString,
varargs: &[Variant]
) -> Variant
Inherited from Object.
pub unsafe fn callv(
&mut self,
method: GodotString,
arg_array: VariantArray
) -> Variant
[src]
&mut self,
method: GodotString,
arg_array: VariantArray
) -> Variant
Inherited from Object.
pub unsafe fn has_method(&self, method: GodotString) -> bool
[src]
Inherited from Object.
pub unsafe fn get_signal_list(&self) -> VariantArray
[src]
Inherited from Object.
pub unsafe fn get_signal_connection_list(
&self,
signal: GodotString
) -> VariantArray
[src]
&self,
signal: GodotString
) -> VariantArray
Inherited from Object.
pub unsafe fn get_incoming_connections(&self) -> VariantArray
[src]
Inherited from Object.
pub unsafe fn connect(
&mut self,
signal: GodotString,
target: Option<Object>,
method: GodotString,
binds: VariantArray,
flags: i64
) -> GodotResult
[src]
&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
)
[src]
&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
[src]
&self,
signal: GodotString,
target: Option<Object>,
method: GodotString
) -> bool
Inherited from Object.
pub unsafe fn set_block_signals(&mut self, enable: bool)
[src]
Inherited from Object.
pub unsafe fn is_blocking_signals(&self) -> bool
[src]
Inherited from Object.
pub unsafe fn property_list_changed_notify(&mut self)
[src]
Inherited from Object.
pub unsafe fn set_message_translation(&mut self, enable: bool)
[src]
Inherited from Object.
pub unsafe fn can_translate_messages(&self) -> bool
[src]
Inherited from Object.
pub unsafe fn tr(&self, message: GodotString) -> GodotString
[src]
Inherited from Object.
pub unsafe fn is_queued_for_deletion(&self) -> bool
[src]
Inherited from Object.
pub unsafe fn to_object(&self) -> Object
[src]
Up-cast.
pub unsafe fn cast<T: GodotObject>(&self) -> Option<T>
[src]
Generic dynamic cast.
Trait Implementations
impl Clone for Node
[src]
impl Copy for Node
[src]
impl Debug for Node
[src]
impl Free for Node
[src]
unsafe fn godot_free(self)
[src]
impl GodotObject for Node
[src]
fn class_name() -> &'static str
[src]
unsafe fn from_sys(obj: *mut godot_object) -> Self
[src]
unsafe fn to_sys(&self) -> *mut godot_object
[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]
fn from_variant(variant: &Variant) -> Option<Self>
[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]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
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]
U: Into<T>,
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]
U: TryFrom<T>,