pub struct SceneTree { /* private fields */ }Expand description
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:
Implementations§
Source§impl SceneTree
impl SceneTree
Sourcepub fn new() -> Self
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 SceneTree::free.
pub unsafe fn get_root(&self) -> Option<Viewport>
pub unsafe fn has_group(&self, name: GodotString) -> bool
pub unsafe fn set_auto_accept_quit(&mut self, enabled: bool)
pub unsafe fn set_quit_on_go_back(&mut self, enabled: bool)
pub unsafe fn set_debug_collisions_hint(&mut self, enable: bool)
pub unsafe fn is_debugging_collisions_hint(&self) -> bool
pub unsafe fn set_edited_scene_root(&mut self, scene: Option<Object>)
pub unsafe fn get_edited_scene_root(&self) -> Option<Node>
pub unsafe fn set_pause(&mut self, enable: bool)
pub unsafe fn is_paused(&self) -> bool
pub unsafe fn set_input_as_handled(&mut self)
pub unsafe fn is_input_handled(&mut self) -> bool
pub unsafe fn create_timer( &mut self, time_sec: f64, pause_mode_process: bool, ) -> Option<SceneTreeTimer>
pub unsafe fn get_node_count(&self) -> i64
pub unsafe fn get_frame(&self) -> i64
pub unsafe fn quit(&mut self)
pub unsafe fn set_screen_stretch( &mut self, mode: i64, aspect: i64, minsize: Vector2, shrink: f64, )
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
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, )
pub unsafe fn call_group( &mut self, group: GodotString, method: GodotString, varargs: &[Variant], ) -> Variant
pub unsafe fn notify_group(&mut self, group: GodotString, notification: i64)
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
pub unsafe fn set_current_scene(&mut self, child_node: Option<Object>)
pub unsafe fn get_current_scene(&self) -> Option<Node>
pub unsafe fn change_scene(&mut self, path: GodotString) -> GodotResult
pub unsafe fn change_scene_to( &mut self, packed_scene: Option<PackedScene>, ) -> GodotResult
pub unsafe fn reload_current_scene(&mut self) -> GodotResult
pub unsafe fn _change_scene(&mut self, arg0: Option<Object>)
pub unsafe fn set_multiplayer(&mut self, multiplayer: Option<MultiplayerAPI>)
pub unsafe fn get_multiplayer(&self) -> Option<MultiplayerAPI>
pub unsafe fn set_multiplayer_poll_enabled(&mut self, enabled: bool)
pub unsafe fn is_multiplayer_poll_enabled(&self) -> bool
pub unsafe fn set_network_peer( &mut self, peer: Option<NetworkedMultiplayerPeer>, )
pub unsafe fn get_network_peer(&self) -> Option<NetworkedMultiplayerPeer>
pub unsafe fn is_network_server(&self) -> bool
pub unsafe fn has_network_peer(&self) -> bool
pub unsafe fn get_network_connected_peers(&self) -> Int32Array
pub unsafe fn get_network_unique_id(&self) -> i64
pub unsafe fn get_rpc_sender_id(&self) -> i64
pub unsafe fn set_refuse_new_network_connections(&mut self, refuse: bool)
pub unsafe fn is_refusing_new_network_connections(&self) -> bool
pub unsafe fn _network_peer_connected(&mut self, arg0: i64)
pub unsafe fn _network_peer_disconnected(&mut self, arg0: i64)
pub unsafe fn _connected_to_server(&mut self)
pub unsafe fn _connection_failed(&mut self)
pub unsafe fn _server_disconnected(&mut self)
pub unsafe fn set_use_font_oversampling(&mut self, enable: bool)
pub unsafe fn is_using_font_oversampling(&self) -> bool
Sourcepub unsafe fn _input_event(&mut self, ev: Option<InputEvent>)
pub unsafe fn _input_event(&mut self, ev: Option<InputEvent>)
Inherited from MainLoop.
Sourcepub unsafe fn _input_text(&mut self, text: GodotString)
pub unsafe fn _input_text(&mut self, text: GodotString)
Inherited from MainLoop.
Sourcepub unsafe fn _initialize(&mut self)
pub unsafe fn _initialize(&mut self)
Inherited from MainLoop.
Sourcepub unsafe fn _iteration(&mut self, delta: f64)
pub unsafe fn _iteration(&mut self, delta: f64)
Inherited from MainLoop.
Sourcepub unsafe fn _drop_files(&mut self, files: StringArray, screen: i64)
pub unsafe fn _drop_files(&mut self, files: StringArray, screen: i64)
Inherited from MainLoop.
Sourcepub unsafe fn input_event(&mut self, ev: Option<InputEvent>)
pub unsafe fn input_event(&mut self, ev: Option<InputEvent>)
Inherited from MainLoop.
Sourcepub unsafe fn input_text(&mut self, text: GodotString)
pub unsafe fn input_text(&mut self, text: GodotString)
Inherited from MainLoop.
Sourcepub unsafe fn _notification(&mut self, what: i64)
pub unsafe fn _notification(&mut self, what: i64)
Inherited from Object.
Sourcepub unsafe fn _set(&mut self, property: GodotString, value: Variant) -> bool
pub unsafe fn _set(&mut self, property: GodotString, value: Variant) -> bool
Inherited from Object.
Sourcepub unsafe fn _get(&mut self, property: GodotString) -> Variant
pub unsafe fn _get(&mut self, property: GodotString) -> Variant
Inherited from Object.
Sourcepub unsafe fn _get_property_list(&mut self) -> VariantArray
pub unsafe fn _get_property_list(&mut self) -> VariantArray
Inherited from Object.
Sourcepub unsafe fn get_class(&self) -> GodotString
pub unsafe fn get_class(&self) -> GodotString
Inherited from Object.
Sourcepub unsafe fn is_class(&self, _type: GodotString) -> bool
pub unsafe fn is_class(&self, _type: GodotString) -> bool
Inherited from Object.
Sourcepub unsafe fn set(&mut self, property: GodotString, value: Variant)
pub unsafe fn set(&mut self, property: GodotString, value: Variant)
Inherited from Object.
Sourcepub unsafe fn get(&self, property: GodotString) -> Variant
pub unsafe fn get(&self, property: GodotString) -> Variant
Inherited from Object.
Sourcepub unsafe fn set_indexed(&mut self, property: NodePath, value: Variant)
pub unsafe fn set_indexed(&mut self, property: NodePath, value: Variant)
Inherited from Object.
Sourcepub unsafe fn get_indexed(&self, property: NodePath) -> Variant
pub unsafe fn get_indexed(&self, property: NodePath) -> Variant
Inherited from Object.
Sourcepub unsafe fn get_property_list(&self) -> VariantArray
pub unsafe fn get_property_list(&self) -> VariantArray
Inherited from Object.
Sourcepub unsafe fn get_method_list(&self) -> VariantArray
pub unsafe fn get_method_list(&self) -> VariantArray
Inherited from Object.
Sourcepub unsafe fn notification(&mut self, what: i64, reversed: bool)
pub unsafe fn notification(&mut self, what: i64, reversed: bool)
Inherited from Object.
Sourcepub unsafe fn get_instance_id(&self) -> i64
pub unsafe fn get_instance_id(&self) -> i64
Inherited from Object.
Sourcepub unsafe fn set_script(&mut self, script: Option<Reference>)
pub unsafe fn set_script(&mut self, script: Option<Reference>)
Inherited from Object.
Sourcepub unsafe fn get_script(&self) -> Option<Reference>
pub unsafe fn get_script(&self) -> Option<Reference>
Inherited from Object.
Sourcepub unsafe fn set_meta(&mut self, name: GodotString, value: Variant)
pub unsafe fn set_meta(&mut self, name: GodotString, value: Variant)
Inherited from Object.
Sourcepub unsafe fn get_meta(&self, name: GodotString) -> Variant
pub unsafe fn get_meta(&self, name: GodotString) -> Variant
Inherited from Object.
Sourcepub unsafe fn has_meta(&self, name: GodotString) -> bool
pub unsafe fn has_meta(&self, name: GodotString) -> bool
Inherited from Object.
Sourcepub unsafe fn get_meta_list(&self) -> StringArray
pub unsafe fn get_meta_list(&self) -> StringArray
Inherited from Object.
Sourcepub unsafe fn add_user_signal(
&mut self,
signal: GodotString,
arguments: VariantArray,
)
pub unsafe fn add_user_signal( &mut self, signal: GodotString, arguments: VariantArray, )
Inherited from Object.
Sourcepub unsafe fn has_user_signal(&self, signal: GodotString) -> bool
pub unsafe fn has_user_signal(&self, signal: GodotString) -> bool
Inherited from Object.
Sourcepub unsafe fn emit_signal(
&mut self,
signal: GodotString,
varargs: &[Variant],
) -> Variant
pub unsafe fn emit_signal( &mut self, signal: GodotString, varargs: &[Variant], ) -> Variant
Inherited from Object.
Sourcepub unsafe fn call(
&mut self,
method: GodotString,
varargs: &[Variant],
) -> Variant
pub unsafe fn call( &mut self, method: GodotString, varargs: &[Variant], ) -> Variant
Inherited from Object.
Sourcepub unsafe fn call_deferred(
&mut self,
method: GodotString,
varargs: &[Variant],
) -> Variant
pub unsafe fn call_deferred( &mut self, method: GodotString, varargs: &[Variant], ) -> Variant
Inherited from Object.
Sourcepub unsafe fn callv(
&mut self,
method: GodotString,
arg_array: VariantArray,
) -> Variant
pub unsafe fn callv( &mut self, method: GodotString, arg_array: VariantArray, ) -> Variant
Inherited from Object.
Sourcepub unsafe fn has_method(&self, method: GodotString) -> bool
pub unsafe fn has_method(&self, method: GodotString) -> bool
Inherited from Object.
Sourcepub unsafe fn get_signal_list(&self) -> VariantArray
pub unsafe fn get_signal_list(&self) -> VariantArray
Inherited from Object.
Sourcepub unsafe fn get_signal_connection_list(
&self,
signal: GodotString,
) -> VariantArray
pub unsafe fn get_signal_connection_list( &self, signal: GodotString, ) -> VariantArray
Inherited from Object.
Sourcepub unsafe fn get_incoming_connections(&self) -> VariantArray
pub unsafe fn get_incoming_connections(&self) -> VariantArray
Inherited from Object.
Sourcepub unsafe fn connect(
&mut self,
signal: GodotString,
target: Option<Object>,
method: GodotString,
binds: VariantArray,
flags: i64,
) -> GodotResult
pub unsafe fn connect( &mut self, signal: GodotString, target: Option<Object>, method: GodotString, binds: VariantArray, flags: i64, ) -> GodotResult
Inherited from Object.
Sourcepub unsafe fn disconnect(
&mut self,
signal: GodotString,
target: Option<Object>,
method: GodotString,
)
pub unsafe fn disconnect( &mut self, signal: GodotString, target: Option<Object>, method: GodotString, )
Inherited from Object.
Sourcepub unsafe fn is_connected(
&self,
signal: GodotString,
target: Option<Object>,
method: GodotString,
) -> bool
pub unsafe fn is_connected( &self, signal: GodotString, target: Option<Object>, method: GodotString, ) -> bool
Inherited from Object.
Sourcepub unsafe fn set_block_signals(&mut self, enable: bool)
pub unsafe fn set_block_signals(&mut self, enable: bool)
Inherited from Object.
Sourcepub unsafe fn is_blocking_signals(&self) -> bool
pub unsafe fn is_blocking_signals(&self) -> bool
Inherited from Object.
Sourcepub unsafe fn property_list_changed_notify(&mut self)
pub unsafe fn property_list_changed_notify(&mut self)
Inherited from Object.
Sourcepub unsafe fn set_message_translation(&mut self, enable: bool)
pub unsafe fn set_message_translation(&mut self, enable: bool)
Inherited from Object.
Sourcepub unsafe fn can_translate_messages(&self) -> bool
pub unsafe fn can_translate_messages(&self) -> bool
Inherited from Object.
Sourcepub unsafe fn tr(&self, message: GodotString) -> GodotString
pub unsafe fn tr(&self, message: GodotString) -> GodotString
Inherited from Object.
Sourcepub unsafe fn is_queued_for_deletion(&self) -> bool
pub unsafe fn is_queued_for_deletion(&self) -> bool
Inherited from Object.
Sourcepub unsafe fn to_main_loop(&self) -> MainLoop
pub unsafe fn to_main_loop(&self) -> MainLoop
Up-cast.
Sourcepub unsafe fn cast<T: GodotObject>(&self) -> Option<T>
pub unsafe fn cast<T: GodotObject>(&self) -> Option<T>
Generic dynamic cast.