Struct gdnative_physics::common::SceneTree [−][src]
pub struct SceneTree { /* fields omitted */ }core class SceneTree inherits MainLoop (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.
SceneTree 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 SceneTree::free.
Feature flag
This type is behind the gdnative crate's common feature flag.
Class hierarchy
SceneTree inherits methods from:
Methods
impl SceneTree[src]
impl SceneTreepub fn new() -> SceneTree[src]
pub fn new() -> SceneTreeConstructor.
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 SceneTree::free.
pub unsafe fn free(self)[src]
pub unsafe fn free(self)Manually deallocate the object.
pub unsafe fn get_root(&self) -> Option<Viewport>[src]
pub unsafe fn get_root(&self) -> Option<Viewport>pub unsafe fn has_group(&self, name: GodotString) -> bool[src]
pub unsafe fn has_group(&self, name: GodotString) -> boolpub unsafe fn set_auto_accept_quit(&mut self, enabled: bool)[src]
pub unsafe fn set_auto_accept_quit(&mut self, enabled: bool)pub unsafe fn set_quit_on_go_back(&mut self, enabled: bool)[src]
pub unsafe fn set_quit_on_go_back(&mut self, enabled: bool)pub unsafe fn set_debug_collisions_hint(&mut self, enable: bool)[src]
pub unsafe fn set_debug_collisions_hint(&mut self, enable: bool)pub unsafe fn is_debugging_collisions_hint(&self) -> bool[src]
pub unsafe fn is_debugging_collisions_hint(&self) -> boolpub unsafe fn set_edited_scene_root(&mut self, scene: Option<Object>)[src]
pub unsafe fn set_edited_scene_root(&mut self, scene: Option<Object>)pub unsafe fn get_edited_scene_root(&self) -> Option<Node>[src]
pub unsafe fn get_edited_scene_root(&self) -> Option<Node>pub unsafe fn set_pause(&mut self, enable: bool)[src]
pub unsafe fn set_pause(&mut self, enable: bool)pub unsafe fn is_paused(&self) -> bool[src]
pub unsafe fn is_paused(&self) -> boolpub unsafe fn set_input_as_handled(&mut self)[src]
pub unsafe fn set_input_as_handled(&mut self)pub unsafe fn is_input_handled(&mut self) -> bool[src]
pub unsafe fn is_input_handled(&mut self) -> boolpub unsafe fn create_timer(
&mut self,
time_sec: f64,
pause_mode_process: bool
) -> Option<SceneTreeTimer>[src]
pub unsafe fn create_timer(
&mut self,
time_sec: f64,
pause_mode_process: bool
) -> Option<SceneTreeTimer>pub unsafe fn get_node_count(&self) -> i64[src]
pub unsafe fn get_node_count(&self) -> i64pub unsafe fn get_frame(&self) -> i64[src]
pub unsafe fn get_frame(&self) -> i64pub unsafe fn quit(&mut self)[src]
pub unsafe fn quit(&mut self)pub unsafe fn set_screen_stretch(
&mut self,
mode: i64,
aspect: i64,
minsize: TypedVector2D<f32, UnknownUnit>,
shrink: f64
)[src]
pub unsafe fn set_screen_stretch(
&mut self,
mode: i64,
aspect: i64,
minsize: TypedVector2D<f32, UnknownUnit>,
shrink: f64
)pub unsafe fn queue_delete(&mut self, obj: Option<Object>)[src]
pub unsafe fn queue_delete(&mut self, obj: Option<Object>)pub unsafe fn call_group_flags(
&mut self,
flags: i64,
group: GodotString,
method: GodotString,
varargs: &[Variant]
) -> Variant[src]
pub unsafe fn call_group_flags(
&mut self,
flags: i64,
group: GodotString,
method: GodotString,
varargs: &[Variant]
) -> Variantpub unsafe fn notify_group_flags(
&mut self,
call_flags: i64,
group: GodotString,
notification: i64
)[src]
pub unsafe fn notify_group_flags(
&mut self,
call_flags: i64,
group: GodotString,
notification: i64
)pub unsafe fn set_group_flags(
&mut self,
call_flags: i64,
group: GodotString,
property: GodotString,
value: Variant
)[src]
pub unsafe fn set_group_flags(
&mut self,
call_flags: i64,
group: GodotString,
property: GodotString,
value: Variant
)pub unsafe fn call_group(
&mut self,
group: GodotString,
method: GodotString,
varargs: &[Variant]
) -> Variant[src]
pub unsafe fn call_group(
&mut self,
group: GodotString,
method: GodotString,
varargs: &[Variant]
) -> Variantpub unsafe fn notify_group(&mut self, group: GodotString, notification: i64)[src]
pub unsafe fn notify_group(&mut self, group: GodotString, notification: i64)pub unsafe fn set_group(
&mut self,
group: GodotString,
property: GodotString,
value: Variant
)[src]
pub unsafe fn set_group(
&mut self,
group: GodotString,
property: GodotString,
value: Variant
)pub unsafe fn get_nodes_in_group(&mut self, group: GodotString) -> VariantArray[src]
pub unsafe fn get_nodes_in_group(&mut self, group: GodotString) -> VariantArraypub unsafe fn set_current_scene(&mut self, child_node: Option<Object>)[src]
pub unsafe fn set_current_scene(&mut self, child_node: Option<Object>)pub unsafe fn get_current_scene(&self) -> Option<Node>[src]
pub unsafe fn get_current_scene(&self) -> Option<Node>pub unsafe fn change_scene(
&mut self,
path: GodotString
) -> Result<(), GodotError>[src]
pub unsafe fn change_scene(
&mut self,
path: GodotString
) -> Result<(), GodotError>pub unsafe fn change_scene_to(
&mut self,
packed_scene: Option<PackedScene>
) -> Result<(), GodotError>[src]
pub unsafe fn change_scene_to(
&mut self,
packed_scene: Option<PackedScene>
) -> Result<(), GodotError>pub unsafe fn reload_current_scene(&mut self) -> Result<(), GodotError>[src]
pub unsafe fn reload_current_scene(&mut self) -> Result<(), GodotError>pub unsafe fn _change_scene(&mut self, arg0: Option<Object>)[src]
pub unsafe fn _change_scene(&mut self, arg0: Option<Object>)pub unsafe fn set_multiplayer(&mut self, multiplayer: Option<MultiplayerAPI>)[src]
pub unsafe fn set_multiplayer(&mut self, multiplayer: Option<MultiplayerAPI>)pub unsafe fn get_multiplayer(&self) -> Option<MultiplayerAPI>[src]
pub unsafe fn get_multiplayer(&self) -> Option<MultiplayerAPI>pub unsafe fn set_multiplayer_poll_enabled(&mut self, enabled: bool)[src]
pub unsafe fn set_multiplayer_poll_enabled(&mut self, enabled: bool)pub unsafe fn is_multiplayer_poll_enabled(&self) -> bool[src]
pub unsafe fn is_multiplayer_poll_enabled(&self) -> boolpub unsafe fn set_network_peer(
&mut self,
peer: Option<NetworkedMultiplayerPeer>
)[src]
pub unsafe fn set_network_peer(
&mut self,
peer: Option<NetworkedMultiplayerPeer>
)pub unsafe fn get_network_peer(&self) -> Option<NetworkedMultiplayerPeer>[src]
pub unsafe fn get_network_peer(&self) -> Option<NetworkedMultiplayerPeer>pub unsafe fn is_network_server(&self) -> bool[src]
pub unsafe fn is_network_server(&self) -> boolpub unsafe fn has_network_peer(&self) -> bool[src]
pub unsafe fn has_network_peer(&self) -> boolpub unsafe fn get_network_connected_peers(&self) -> Int32Array[src]
pub unsafe fn get_network_connected_peers(&self) -> Int32Arraypub unsafe fn get_network_unique_id(&self) -> i64[src]
pub unsafe fn get_network_unique_id(&self) -> i64pub unsafe fn get_rpc_sender_id(&self) -> i64[src]
pub unsafe fn get_rpc_sender_id(&self) -> i64pub unsafe fn set_refuse_new_network_connections(&mut self, refuse: bool)[src]
pub unsafe fn set_refuse_new_network_connections(&mut self, refuse: bool)pub unsafe fn is_refusing_new_network_connections(&self) -> bool[src]
pub unsafe fn is_refusing_new_network_connections(&self) -> boolpub unsafe fn _network_peer_connected(&mut self, arg0: i64)[src]
pub unsafe fn _network_peer_connected(&mut self, arg0: i64)pub unsafe fn _network_peer_disconnected(&mut self, arg0: i64)[src]
pub unsafe fn _network_peer_disconnected(&mut self, arg0: i64)pub unsafe fn _connected_to_server(&mut self)[src]
pub unsafe fn _connected_to_server(&mut self)pub unsafe fn _connection_failed(&mut self)[src]
pub unsafe fn _connection_failed(&mut self)pub unsafe fn _server_disconnected(&mut self)[src]
pub unsafe fn _server_disconnected(&mut self)pub unsafe fn set_use_font_oversampling(&mut self, enable: bool)[src]
pub unsafe fn set_use_font_oversampling(&mut self, enable: bool)pub unsafe fn is_using_font_oversampling(&self) -> bool[src]
pub unsafe fn is_using_font_oversampling(&self) -> boolpub unsafe fn _input_event(&mut self, ev: Option<InputEvent>)[src]
pub unsafe fn _input_event(&mut self, ev: Option<InputEvent>)Inherited from MainLoop.
pub unsafe fn _input_text(&mut self, text: GodotString)[src]
pub unsafe fn _input_text(&mut self, text: GodotString)Inherited from MainLoop.
pub unsafe fn _initialize(&mut self)[src]
pub unsafe fn _initialize(&mut self)Inherited from MainLoop.
pub unsafe fn _iteration(&mut self, delta: f64)[src]
pub unsafe fn _iteration(&mut self, delta: f64)Inherited from MainLoop.
pub unsafe fn _idle(&mut self, delta: f64)[src]
pub unsafe fn _idle(&mut self, delta: f64)Inherited from MainLoop.
pub unsafe fn _drop_files(&mut self, files: StringArray, screen: i64)[src]
pub unsafe fn _drop_files(&mut self, files: StringArray, screen: i64)Inherited from MainLoop.
pub unsafe fn _finalize(&mut self)[src]
pub unsafe fn _finalize(&mut self)Inherited from MainLoop.
pub unsafe fn input_event(&mut self, ev: Option<InputEvent>)[src]
pub unsafe fn input_event(&mut self, ev: Option<InputEvent>)Inherited from MainLoop.
pub unsafe fn input_text(&mut self, text: GodotString)[src]
pub unsafe fn input_text(&mut self, text: GodotString)Inherited from MainLoop.
pub unsafe fn init(&mut self)[src]
pub unsafe fn init(&mut self)Inherited from MainLoop.
pub unsafe fn iteration(&mut self, delta: f64) -> bool[src]
pub unsafe fn iteration(&mut self, delta: f64) -> boolInherited from MainLoop.
pub unsafe fn idle(&mut self, delta: f64) -> bool[src]
pub unsafe fn idle(&mut self, delta: f64) -> boolInherited from MainLoop.
pub unsafe fn finish(&mut self)[src]
pub unsafe fn finish(&mut self)Inherited from MainLoop.
pub unsafe fn _notification(&mut self, what: i64)[src]
pub unsafe fn _notification(&mut self, what: i64)Inherited from Object.
pub unsafe fn _set(&mut self, property: GodotString, value: Variant) -> bool[src]
pub unsafe fn _set(&mut self, property: GodotString, value: Variant) -> boolInherited from Object.
pub unsafe fn _get(&mut self, property: GodotString) -> Variant[src]
pub unsafe fn _get(&mut self, property: GodotString) -> VariantInherited from Object.
pub unsafe fn _get_property_list(&mut self) -> VariantArray[src]
pub unsafe fn _get_property_list(&mut self) -> VariantArrayInherited from Object.
pub unsafe fn _init(&mut self)[src]
pub unsafe fn _init(&mut self)Inherited from Object.
pub unsafe fn get_class(&self) -> GodotString[src]
pub unsafe fn get_class(&self) -> GodotStringInherited from Object.
pub unsafe fn is_class(&self, _type: GodotString) -> bool[src]
pub unsafe fn is_class(&self, _type: GodotString) -> boolInherited from Object.
pub unsafe fn set(&mut self, property: GodotString, value: Variant)[src]
pub unsafe fn set(&mut self, property: GodotString, value: Variant)Inherited from Object.
pub unsafe fn get(&self, property: GodotString) -> Variant[src]
pub unsafe fn get(&self, property: GodotString) -> VariantInherited from Object.
pub unsafe fn set_indexed(&mut self, property: NodePath, value: Variant)[src]
pub unsafe fn set_indexed(&mut self, property: NodePath, value: Variant)Inherited from Object.
pub unsafe fn get_indexed(&self, property: NodePath) -> Variant[src]
pub unsafe fn get_indexed(&self, property: NodePath) -> VariantInherited from Object.
pub unsafe fn get_property_list(&self) -> VariantArray[src]
pub unsafe fn get_property_list(&self) -> VariantArrayInherited from Object.
pub unsafe fn get_method_list(&self) -> VariantArray[src]
pub unsafe fn get_method_list(&self) -> VariantArrayInherited from Object.
pub unsafe fn notification(&mut self, what: i64, reversed: bool)[src]
pub unsafe fn notification(&mut self, what: i64, reversed: bool)Inherited from Object.
pub unsafe fn get_instance_id(&self) -> i64[src]
pub unsafe fn get_instance_id(&self) -> i64Inherited from Object.
pub unsafe fn set_script(&mut self, script: Option<Reference>)[src]
pub unsafe fn set_script(&mut self, script: Option<Reference>)Inherited from Object.
pub unsafe fn get_script(&self) -> Option<Reference>[src]
pub unsafe fn get_script(&self) -> Option<Reference>Inherited from Object.
pub unsafe fn set_meta(&mut self, name: GodotString, value: Variant)[src]
pub unsafe fn set_meta(&mut self, name: GodotString, value: Variant)Inherited from Object.
pub unsafe fn get_meta(&self, name: GodotString) -> Variant[src]
pub unsafe fn get_meta(&self, name: GodotString) -> VariantInherited from Object.
pub unsafe fn has_meta(&self, name: GodotString) -> bool[src]
pub unsafe fn has_meta(&self, name: GodotString) -> boolInherited from Object.
pub unsafe fn get_meta_list(&self) -> StringArray[src]
pub unsafe fn get_meta_list(&self) -> StringArrayInherited from Object.
pub unsafe fn add_user_signal(
&mut self,
signal: GodotString,
arguments: VariantArray
)[src]
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[src]
pub unsafe fn has_user_signal(&self, signal: GodotString) -> boolInherited from Object.
pub unsafe fn emit_signal(
&mut self,
signal: GodotString,
varargs: &[Variant]
) -> Variant[src]
pub unsafe fn emit_signal(
&mut self,
signal: GodotString,
varargs: &[Variant]
) -> VariantInherited from Object.
pub unsafe fn call(
&mut self,
method: GodotString,
varargs: &[Variant]
) -> Variant[src]
pub unsafe fn call(
&mut self,
method: GodotString,
varargs: &[Variant]
) -> VariantInherited from Object.
pub unsafe fn call_deferred(
&mut self,
method: GodotString,
varargs: &[Variant]
) -> Variant[src]
pub unsafe fn call_deferred(
&mut self,
method: GodotString,
varargs: &[Variant]
) -> VariantInherited from Object.
pub unsafe fn callv(
&mut self,
method: GodotString,
arg_array: VariantArray
) -> Variant[src]
pub unsafe fn callv(
&mut self,
method: GodotString,
arg_array: VariantArray
) -> VariantInherited from Object.
pub unsafe fn has_method(&self, method: GodotString) -> bool[src]
pub unsafe fn has_method(&self, method: GodotString) -> boolInherited from Object.
pub unsafe fn get_signal_list(&self) -> VariantArray[src]
pub unsafe fn get_signal_list(&self) -> VariantArrayInherited from Object.
pub unsafe fn get_signal_connection_list(
&self,
signal: GodotString
) -> VariantArray[src]
pub unsafe fn get_signal_connection_list(
&self,
signal: GodotString
) -> VariantArrayInherited from Object.
pub unsafe fn get_incoming_connections(&self) -> VariantArray[src]
pub unsafe fn get_incoming_connections(&self) -> VariantArrayInherited from Object.
pub unsafe fn connect(
&mut self,
signal: GodotString,
target: Option<Object>,
method: GodotString,
binds: VariantArray,
flags: i64
) -> Result<(), GodotError>[src]
pub unsafe fn connect(
&mut self,
signal: GodotString,
target: Option<Object>,
method: GodotString,
binds: VariantArray,
flags: i64
) -> Result<(), GodotError>Inherited from Object.
pub unsafe fn disconnect(
&mut self,
signal: GodotString,
target: Option<Object>,
method: GodotString
)[src]
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[src]
pub unsafe fn is_connected(
&self,
signal: GodotString,
target: Option<Object>,
method: GodotString
) -> boolInherited from Object.
pub unsafe fn set_block_signals(&mut self, enable: bool)[src]
pub unsafe fn set_block_signals(&mut self, enable: bool)Inherited from Object.
pub unsafe fn is_blocking_signals(&self) -> bool[src]
pub unsafe fn is_blocking_signals(&self) -> boolInherited from Object.
pub unsafe fn property_list_changed_notify(&mut self)[src]
pub unsafe fn property_list_changed_notify(&mut self)Inherited from Object.
pub unsafe fn set_message_translation(&mut self, enable: bool)[src]
pub unsafe fn set_message_translation(&mut self, enable: bool)Inherited from Object.
pub unsafe fn can_translate_messages(&self) -> bool[src]
pub unsafe fn can_translate_messages(&self) -> boolInherited from Object.
pub unsafe fn tr(&self, message: GodotString) -> GodotString[src]
pub unsafe fn tr(&self, message: GodotString) -> GodotStringInherited from Object.
pub unsafe fn is_queued_for_deletion(&self) -> bool[src]
pub unsafe fn is_queued_for_deletion(&self) -> boolInherited from Object.
pub unsafe fn to_main_loop(&self) -> MainLoop[src]
pub unsafe fn to_main_loop(&self) -> MainLoopUp-cast.
pub unsafe fn to_object(&self) -> Object[src]
pub unsafe fn to_object(&self) -> ObjectUp-cast.
pub unsafe fn cast<T>(&self) -> Option<T> where
T: GodotObject, [src]
pub unsafe fn cast<T>(&self) -> Option<T> where
T: GodotObject, Generic dynamic cast.
Trait Implementations
impl GodotObject for SceneTree[src]
impl GodotObject for SceneTreefn class_name() -> &'static str[src]
fn class_name() -> &'static strunsafe fn from_sys(obj: *mut c_void) -> SceneTree[src]
unsafe fn from_sys(obj: *mut c_void) -> SceneTreeunsafe fn to_sys(&self) -> *mut c_void[src]
unsafe fn to_sys(&self) -> *mut c_voidimpl Free for SceneTree[src]
impl Free for SceneTreeunsafe fn godot_free(self)[src]
unsafe fn godot_free(self)impl Clone for SceneTree[src]
impl Clone for SceneTreefn clone(&self) -> SceneTree[src]
fn clone(&self) -> SceneTreeReturns 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 ToVariant for SceneTree[src]
impl ToVariant for SceneTreefn to_variant(&self) -> Variant[src]
fn to_variant(&self) -> Variantfn from_variant(variant: &Variant) -> Option<SceneTree>[src]
fn from_variant(variant: &Variant) -> Option<SceneTree>impl Debug for SceneTree[src]
impl Debug for SceneTreefn fmt(&self, f: &mut Formatter) -> Result<(), Error>[src]
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>Formats the value using the given formatter. Read more
impl Copy for SceneTree[src]
impl Copy for SceneTree