Struct gdnative::api::SceneTree

source · [−]
pub struct SceneTree { /* private fields */ }
Expand description

core class SceneTree inherits MainLoop (manually managed).

This class has related types in the scene_tree module.

Official documentation

See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.

Memory management

Non-reference-counted objects, such as the ones of this type, are usually owned by the engine.

SceneTree is a reference-only type. Persistent references can only exist in the unsafe Ref<SceneTree> form.

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 Ref::free, or Ref::queue_free if it is a Node.

Class hierarchy

SceneTree inherits methods from:

Safety

All types in the Godot API have interior mutability in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Ownership in these types tracks whether ownership is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

Constants

Creates a new instance of this object.

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 Ref::free, or preferably Ref::queue_free if it is a Node.

Calls method on each member of the given group. You can pass arguments to method by specifying them at the end of the method call. This method is equivalent of calling call_group_flags with GROUP_CALL_DEFAULT flag. Note: method may only have 5 arguments at most (7 arguments passed to this method in total). Note: Due to design limitations, call_group will fail silently if one of the arguments is null. Note: call_group will always call methods with an one-frame delay, in a way similar to Object.call_deferred. To call methods immediately, use call_group_flags with the GROUP_CALL_REALTIME flag.

Sample code is GDScript unless otherwise noted.

Calls method on each member of the given group, respecting the given GroupCallFlags. You can pass arguments to method by specifying them at the end of the method call. Note: method may only have 5 arguments at most (8 arguments passed to this method in total). Note: Due to design limitations, call_group_flags will fail silently if one of the arguments is null.

get_tree().call_group_flags(SceneTree.GROUP_CALL_REALTIME | SceneTree.GROUP_CALL_REVERSE, "bases", "destroy")

Changes the running scene to the one at the given path, after loading it into a PackedScene and creating a new instance. Returns [OK][Self::OK] on success, [ERR_CANT_OPEN][Self::ERR_CANT_OPEN] if the path cannot be loaded into a PackedScene, or [ERR_CANT_CREATE][Self::ERR_CANT_CREATE] if that scene cannot be instantiated. Note: The scene change is deferred, which means that the new scene node is added on the next idle frame. You won’t be able to access it immediately after the change_scene call.

Changes the running scene to a new instance of the given PackedScene. Returns [OK][Self::OK] on success or [ERR_CANT_CREATE][Self::ERR_CANT_CREATE] if the scene cannot be instantiated. Note: The scene change is deferred, which means that the new scene node is added on the next idle frame. You won’t be able to access it immediately after the change_scene_to call.

Sample code is GDScript unless otherwise noted.

Returns a SceneTreeTimer which will [signal SceneTreeTimer.timeout] after the given time in seconds elapsed in this SceneTree. If pause_mode_process is set to false, pausing the SceneTree will also pause the timer. Commonly used to create a one-shot delay timer as in the following example:

func some_function():
    print("start")
    yield(get_tree().create_timer(1.0), "timeout")
    print("end")

The timer will be automatically freed after its time elapses.

Default Arguments
  • pause_mode_process - true

The current scene.

The root of the edited scene.

Returns the current frame number, i.e. the total frame count since the application started.

The default MultiplayerAPI instance for this SceneTree.

Returns the peer IDs of all connected peers of this SceneTree’s network_peer.

The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the SceneTree will become a network server (check with is_network_server) and will set the root node’s network mode to master, or it will become a regular peer with the root node set to puppet. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to SceneTree’s signals.

Returns the unique peer ID of this SceneTree’s network_peer.

Returns the number of nodes in this SceneTree.

Returns a list of all nodes assigned to the given group.

The SceneTree’s root Viewport.

Returns the sender’s peer ID for the most recently received RPC call.

Returns true if the given group exists.

Returns true if there is a network_peer set.

If true, collision shapes will be visible when running the game from the editor for debugging purposes.

If true, navigation polygons will be visible when running the game from the editor for debugging purposes.

Returns true if the most recent InputEvent was marked as handled with set_input_as_handled.

If true (default value), enables automatic polling of the MultiplayerAPI for this SceneTree during idle_frame. If false, you need to manually call MultiplayerAPI.poll to process network packets and deliver RPCs/RSETs. This allows running RPCs/RSETs in a different loop (e.g. physics, thread, specific time step) and for manual Mutex protection when accessing the MultiplayerAPI from threads.

Returns true if this SceneTree’s network_peer is in server mode (listening for connections).

If true, the SceneTree is paused. Doing so will have the following behavior:

  • 2D and 3D physics will be stopped. This includes signals and collision detection.
  • [Node._process][Node::_process], [Node._physics_process][Node::_physics_process] and [Node._input][Node::_input] will not be called anymore in nodes.

If true, the SceneTree’s network_peer refuses new incoming connections.

If true, font oversampling is used.

Sends the given notification to all members of the group.

Sends the given notification to all members of the group, respecting the given GroupCallFlags.

Queues the given object for deletion, delaying the call to [Object.free][Object::free] to after the current frame.

Quits the application at the end of the current iteration. A process exit_code can optionally be passed as an argument. If this argument is 0 or greater, it will override the OS.exit_code defined before quitting the application. Note: On iOS this method doesn’t work. Instead, as recommended by the iOS Human Interface Guidelines, the user is expected to close apps via the Home button.

Default Arguments
  • exit_code - -1

Reloads the currently active scene. Returns [OK][Self::OK] on success, [ERR_UNCONFIGURED][Self::ERR_UNCONFIGURED] if no current_scene was defined yet, [ERR_CANT_OPEN][Self::ERR_CANT_OPEN] if current_scene cannot be loaded into a PackedScene, or [ERR_CANT_CREATE][Self::ERR_CANT_CREATE] if the scene cannot be instantiated.

If true, the application automatically accepts quitting. Enabled by default. For mobile platforms, see set_quit_on_go_back.

The current scene.

If true, collision shapes will be visible when running the game from the editor for debugging purposes.

If true, navigation polygons will be visible when running the game from the editor for debugging purposes.

The root of the edited scene.

Sets the given property to value on all members of the given group.

Sets the given property to value on all members of the given group, respecting the given GroupCallFlags.

Marks the most recent InputEvent as handled.

The default MultiplayerAPI instance for this SceneTree.

If true (default value), enables automatic polling of the MultiplayerAPI for this SceneTree during idle_frame. If false, you need to manually call MultiplayerAPI.poll to process network packets and deliver RPCs/RSETs. This allows running RPCs/RSETs in a different loop (e.g. physics, thread, specific time step) and for manual Mutex protection when accessing the MultiplayerAPI from threads.

The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the SceneTree will become a network server (check with is_network_server) and will set the root node’s network mode to master, or it will become a regular peer with the root node set to puppet. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to SceneTree’s signals.

If true, the SceneTree is paused. Doing so will have the following behavior:

  • 2D and 3D physics will be stopped. This includes signals and collision detection.
  • [Node._process][Node::_process], [Node._physics_process][Node::_physics_process] and [Node._input][Node::_input] will not be called anymore in nodes.

If true, the application quits automatically on going back (e.g. on Android). Enabled by default. To handle ‘Go Back’ button when this option is disabled, use MainLoop.NOTIFICATION_WM_GO_BACK_REQUEST.

If true, the SceneTree’s network_peer refuses new incoming connections.

Configures screen stretching to the given StretchMode, StretchAspect, minimum size and scale.

Default Arguments
  • scale - 1

If true, font oversampling is used.

Methods from Deref<Target = MainLoop>

Should not be called manually, override [_finalize][Self::_finalize] instead. Will be removed in Godot 4.0.

Should not be called manually, override [_idle][Self::_idle] instead. Will be removed in Godot 4.0.

Should not be called manually, override [_initialize][Self::_initialize] instead. Will be removed in Godot 4.0.

Should not be called manually, override [_input_event][Self::_input_event] instead. Will be removed in Godot 4.0.

source

pub fn input_text(&self, text: impl Into<GodotString>)

Should not be called manually, override [_input_text][Self::_input_text] instead. Will be removed in Godot 4.0.

Should not be called manually, override [_iteration][Self::_iteration] instead. Will be removed in Godot 4.0.

Methods from Deref<Target = Object>

Adds a user-defined signal. Arguments are optional, but can be added as an Array of dictionaries, each containing name: String and type: int (see [enum Variant.Type]) entries.

Default Arguments
  • arguments - [ ]

Sample code is GDScript unless otherwise noted.

Calls the method on the object and returns the result. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:

call("set", "position", Vector2(42.0, 0.0))

Note: In C#, the method name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined methods where you should use the same convention as in the C# source (typically PascalCase).

Safety

This function bypasses Rust’s static type checks (aliasing, thread boundaries, calls to free(), …).

Sample code is GDScript unless otherwise noted.

Calls the method on the object during idle time. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:

call_deferred("set", "position", Vector2(42.0, 0.0))

Note: In C#, the method name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined methods where you should use the same convention as in the C# source (typically PascalCase).

Safety

This function bypasses Rust’s static type checks (aliasing, thread boundaries, calls to free(), …).

Sample code is GDScript unless otherwise noted.

Calls the method on the object and returns the result. Contrarily to call, this method does not support a variable number of arguments but expects all parameters to be via a single Array.

callv("set", [ "position", Vector2(42.0, 0.0) ])
Safety

This function bypasses Rust’s static type checks (aliasing, thread boundaries, calls to free(), …).

Returns true if the object can translate strings. See set_message_translation and tr.

Sample code is GDScript unless otherwise noted.

Connects a signal to a method on a target object. Pass optional binds to the call as an Array of parameters. These parameters will be passed to the method after any parameter used in the call to emit_signal. Use flags to set deferred or one-shot connections. See ConnectFlags constants. A signal can only be connected once to a method. It will throw an error if already connected, unless the signal was connected with CONNECT_REFERENCE_COUNTED. To avoid this, first, use is_connected to check for existing connections. If the target is destroyed in the game’s lifecycle, the connection will be lost. Examples:

connect("pressed", self, "_on_Button_pressed") # BaseButton signal
connect("text_entered", self, "_on_LineEdit_text_entered") # LineEdit signal
connect("hit", self, "_on_Player_hit", [ weapon_type, damage ]) # User-defined signal

An example of the relationship between binds passed to connect and parameters used when calling emit_signal:

connect("hit", self, "_on_Player_hit", [ weapon_type, damage ]) # weapon_type and damage are passed last
emit_signal("hit", "Dark lord", 5) # "Dark lord" and 5 are passed first
func _on_Player_hit(hit_by, level, weapon_type, damage):
    print("Hit by %s (lvl %d) with weapon %s for %d damage" % [hit_by, level, weapon_type, damage])
Default Arguments
  • binds - [ ]
  • flags - 0

Disconnects a signal from a method on the given target. If you try to disconnect a connection that does not exist, the method will throw an error. Use is_connected to ensure that the connection exists.

Sample code is GDScript unless otherwise noted.

Emits the given signal. The signal must exist, so it should be a built-in signal of this class or one of its parent classes, or a user-defined signal. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:

emit_signal("hit", weapon_type, damage)
emit_signal("game_over")

Returns the Variant value of the given property. If the property doesn’t exist, this will return null. Note: In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).

Returns the object’s class as a String. See also is_class. Note: get_class does not take class_name declarations into account. If the object has a class_name defined, the base class name will be returned instead.

Returns an Array of dictionaries with information about signals that are connected to the object. Each Dictionary contains three String entries:

  • source is a reference to the signal emitter.
  • signal_name is the name of the connected signal.
  • method_name is the name of the method to which the signal is connected.

Gets the object’s property indexed by the given NodePath. The node path should be relative to the current object and can use the colon character (:) to access nested properties. Examples: "position:x" or "material:next_pass:blend_mode".

Returns the object’s unique instance ID. This ID can be saved in EncodedObjectAsID, and can be used to retrieve the object instance with [method @GDScript.instance_from_id].

Returns the object’s metadata entry for the given name.

Returns the object’s metadata as a PoolStringArray.

Returns the object’s methods and their signatures as an Array.

Returns the object’s property list as an Array of dictionaries. Each property’s Dictionary contain at least name: String and type: int (see [enum Variant.Type]) entries. Optionally, it can also include hint: int (see [PropertyHint][PropertyHint]), hint_string: String, and usage: int (see [PropertyUsageFlags][PropertyUsageFlags]).

Returns the object’s Script instance, or null if none is assigned.

Returns an Array of connections for the given signal.

Returns the list of signals as an Array of dictionaries.

Returns true if a metadata entry is found with the given name.

Returns true if the object contains the given method.

Returns true if the given signal exists.

Returns true if the given user-defined signal exists. Only signals added using add_user_signal are taken into account.

Returns true if signal emission blocking is enabled.

Returns true if the object inherits from the given class. See also get_class. Note: is_class does not take class_name declarations into account. If the object has a class_name defined, is_class will return false for that name.

Returns true if a connection exists for a given signal, target, and method.

Returns true if the Node.queue_free method was called for the object.

Send a given notification to the object, which will also trigger a call to the [_notification][Self::_notification] method of all classes that the object inherits from. If reversed is true, [_notification][Self::_notification] is called first on the object’s own class, and then up to its successive parent classes. If reversed is false, [_notification][Self::_notification] is called first on the highest ancestor (Object itself), and then down to its successive inheriting classes.

Default Arguments
  • reversed - false

Notify the editor that the property list has changed, so that editor plugins can take the new values into account. Does nothing on export builds.

Removes a given entry from the object’s metadata. See also set_meta.

Assigns a new value to the given property. If the property does not exist, nothing will happen. Note: In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).

If set to true, signal emission is blocked.

Assigns a new value to the given property, after the current frame’s physics step. This is equivalent to calling set via call_deferred, i.e. call_deferred("set", property, value). Note: In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).

Sample code is GDScript unless otherwise noted.

Assigns a new value to the property identified by the NodePath. The node path should be relative to the current object and can use the colon character (:) to access nested properties. Example:

set_indexed("position", Vector2(42, 0))
set_indexed("position:y", -10)
print(position) # (42, -10)

Defines whether the object can translate strings (with calls to tr). Enabled by default.

Adds, changes or removes a given entry in the object’s metadata. Metadata are serialized and can take any Variant value. To remove a given entry from the object’s metadata, use remove_meta. Metadata is also removed if its value is set to null. This means you can also use set_meta("name", null) to remove metadata for "name".

Assigns a script to the object. Each object can have a single script assigned to it, which are used to extend its functionality. If the object already had a script, the previous script instance will be freed and its variables and state will be lost. The new script’s [_init][Self::_init] method will be called.

Returns a String representing the object. If not overridden, defaults to "[ClassName:RID]". Override the method [_to_string][Self::_to_string] to customize the String representation.

Translates a message using translation catalogs configured in the Project Settings. Only works if message translation is enabled (which it is by default), otherwise it returns the message unchanged. See set_message_translation.

Trait Implementations

Formats the value using the given formatter. Read more

The resulting type after dereferencing.

Dereferences the value.

Mutably dereferences the value.

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information. Read more

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option. Read more

Creates a new instance of Self using a zero-argument constructor, as a Unique reference. Read more

Performs a dynamic reference downcast to target type. Read more

Performs a static reference upcast to a supertype that is guaranteed to be valid. Read more

Creates a persistent reference to the same Godot object with shared thread access. Read more

Creates a persistent reference to the same Godot object with thread-local thread access. Read more

Creates a persistent reference to the same Godot object with unique access. Read more

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive. See also TRef::try_from_instance_id. Read more

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive, and panics otherwise. This does NOT guarantee that the resulting reference is safe to use. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.