Struct gdnative::SceneTree

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.

Class hierarchy

SceneTree inherits methods from:

• MainLoop
• Object

Methods

impl SceneTree

Constants

pub const GROUP_CALL_REVERSE: i64

pub const STRETCH_ASPECT_EXPAND: i64

pub const STRETCH_ASPECT_KEEP: i64

pub const STRETCH_MODE_2D: i64

pub const STRETCH_ASPECT_KEEP_HEIGHT: i64

pub const STRETCH_MODE_DISABLED: i64

pub const STRETCH_ASPECT_IGNORE: i64

pub const GROUP_CALL_UNIQUE: i64

pub const GROUP_CALL_DEFAULT: i64

pub const STRETCH_ASPECT_KEEP_WIDTH: i64

pub const GROUP_CALL_REALTIME: i64

pub const STRETCH_MODE_VIEWPORT: i64

impl SceneTree

pub fn new() -> SceneTree

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 free(self)

Manually deallocate the object.

pub unsafe fn _change_scene(&mut self, arg0: Option<Node>)

pub unsafe fn _connected_to_server(&mut self)

pub unsafe fn _connection_failed(&mut self)

pub unsafe fn _network_peer_connected(&mut self, arg0: i64)

pub unsafe fn _network_peer_disconnected(&mut self, arg0: i64)

pub unsafe fn _server_disconnected(&mut self)

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

pub unsafe fn call_group_flags(
    &mut self,
    flags: i64,
    group: GodotString,
    method: GodotString,
    varargs: &[Variant]
) -> Variant

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>

pub unsafe fn create_timer(
    &mut self,
    time_sec: f64,
    pause_mode_process: bool
) -> Option<SceneTreeTimer>

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

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

pub unsafe fn get_frame(&self) -> i64

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

pub unsafe fn get_network_connected_peers(&self) -> Int32Array

pub unsafe fn get_network_peer(&self) -> Option<NetworkedMultiplayerPeer>

pub unsafe fn get_network_unique_id(&self) -> i64

pub unsafe fn get_node_count(&self) -> i64

pub unsafe fn get_nodes_in_group(&mut self, group: GodotString) -> VariantArray

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

pub unsafe fn get_rpc_sender_id(&self) -> i64

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

pub unsafe fn has_network_peer(&self) -> bool

pub unsafe fn is_debugging_collisions_hint(&self) -> bool

pub unsafe fn is_debugging_navigation_hint(&self) -> bool

pub unsafe fn is_input_handled(&mut self) -> bool

pub unsafe fn is_multiplayer_poll_enabled(&self) -> bool

pub unsafe fn is_network_server(&self) -> bool

pub unsafe fn is_paused(&self) -> bool

pub unsafe fn is_refusing_new_network_connections(&self) -> bool

pub unsafe fn is_using_font_oversampling(&self) -> bool

pub unsafe fn notify_group(&mut self, group: GodotString, notification: i64)

pub unsafe fn notify_group_flags(
    &mut self,
    call_flags: i64,
    group: GodotString,
    notification: i64
)

pub unsafe fn queue_delete(&mut self, obj: Option<Object>)

pub unsafe fn quit(&mut self, exit_code: i64)

pub unsafe fn reload_current_scene(&mut self) -> Result<(), GodotError>

pub unsafe fn set_auto_accept_quit(&mut self, enabled: bool)

pub unsafe fn set_current_scene(&mut self, child_node: Option<Node>)

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

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

pub unsafe fn set_edited_scene_root(&mut self, scene: Option<Node>)

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

pub unsafe fn set_group_flags(
    &mut self,
    call_flags: i64,
    group: GodotString,
    property: GodotString,
    value: Variant
)

pub unsafe fn set_input_as_handled(&mut self)

pub unsafe fn set_multiplayer(&mut self, multiplayer: Option<MultiplayerAPI>)

pub unsafe fn set_multiplayer_poll_enabled(&mut self, enabled: bool)

pub unsafe fn set_network_peer(
    &mut self,
    peer: Option<NetworkedMultiplayerPeer>
)

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

pub unsafe fn set_quit_on_go_back(&mut self, enabled: bool)

pub unsafe fn set_refuse_new_network_connections(&mut self, refuse: bool)

pub unsafe fn set_screen_stretch(
    &mut self,
    mode: i64,
    aspect: i64,
    minsize: Vector2D<f32, UnknownUnit>,
    shrink: f64
)

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

pub unsafe fn to_main_loop(&self) -> MainLoop

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

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

Generic dynamic cast.

Methods from Deref<Target = MainLoop>

pub const NOTIFICATION_OS_MEMORY_WARNING: i64

pub const NOTIFICATION_WM_GO_BACK_REQUEST: i64

pub const NOTIFICATION_APP_RESUMED: i64

pub const NOTIFICATION_WM_FOCUS_IN: i64

pub const NOTIFICATION_WM_FOCUS_OUT: i64

pub const NOTIFICATION_WM_MOUSE_EXIT: i64

pub const NOTIFICATION_WM_QUIT_REQUEST: i64

pub const NOTIFICATION_OS_IME_UPDATE: i64

pub const NOTIFICATION_APP_PAUSED: i64

pub const NOTIFICATION_TRANSLATION_CHANGED: i64

pub const NOTIFICATION_WM_UNFOCUS_REQUEST: i64

pub const NOTIFICATION_WM_ABOUT: i64

pub const NOTIFICATION_CRASH: i64

pub const NOTIFICATION_WM_MOUSE_ENTER: i64

pub unsafe fn _drop_files(&mut self, files: StringArray, from_screen: i64)

pub unsafe fn _finalize(&mut self)

pub unsafe fn _global_menu_action(&mut self, id: Variant, meta: Variant)

pub unsafe fn _idle(&mut self, delta: f64) -> bool

pub unsafe fn _initialize(&mut self)

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

pub unsafe fn _input_text(&mut self, text: GodotString)

pub unsafe fn _iteration(&mut self, delta: f64) -> bool

pub unsafe fn finish(&mut self)

pub unsafe fn idle(&mut self, delta: f64) -> bool

pub unsafe fn init(&mut self)

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

pub unsafe fn input_text(&mut self, text: GodotString)

pub unsafe fn iteration(&mut self, delta: f64) -> bool

pub unsafe fn to_object(&self) -> Object

Up-cast.

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

Generic dynamic cast.

Trait Implementations

impl Clone for SceneTree

fn clone(&self) -> SceneTree

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for SceneTree

impl Debug for SceneTree

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

Formats the value using the given formatter.

impl Deref for SceneTree

type Target = MainLoop

The resulting type after dereferencing.

fn deref(&self) -> &MainLoop

Dereferences the value.

impl DerefMut for SceneTree

fn deref_mut(&mut self) -> &mut MainLoop

Mutably dereferences the value.

impl Free for SceneTree

unsafe fn godot_free(self)

impl FromVariant for SceneTree

fn from_variant(variant: &Variant) -> Result<SceneTree, FromVariantError>

impl GodotObject for SceneTree

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut c_void) -> SceneTree

unsafe fn from_return_position_sys(obj: *mut c_void) -> SceneTree

unsafe fn to_sys(&self) -> *mut c_void

impl Instanciable for SceneTree

fn construct() -> SceneTree

impl ToVariant for SceneTree

fn to_variant(&self) -> Variant