.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/doc/classes/SceneTree.xml. .. _class_SceneTree: SceneTree ========= **Inherits:** :ref:`MainLoop` **<** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------+------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`auto_accept_quit` | ``true`` | +-----------------------------+------------------------------------------------------------------------------+-----------+ | :ref:`Node` | :ref:`current_scene` | | +-----------------------------+------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`debug_collisions_hint` | ``false`` | +-----------------------------+------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`debug_navigation_hint` | ``false`` | +-----------------------------+------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`debug_paths_hint` | ``false`` | +-----------------------------+------------------------------------------------------------------------------+-----------+ | :ref:`Node` | :ref:`edited_scene_root` | | +-----------------------------+------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`multiplayer_poll` | ``true`` | +-----------------------------+------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`paused` | ``false`` | +-----------------------------+------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`physics_interpolation` | ``false`` | +-----------------------------+------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`quit_on_go_back` | ``true`` | +-----------------------------+------------------------------------------------------------------------------+-----------+ | :ref:`Window` | :ref:`root` | | +-----------------------------+------------------------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`call_group` **(** :ref:`StringName` group, :ref:`StringName` method, ... **)** |vararg| | +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`call_group_flags` **(** :ref:`int` flags, :ref:`StringName` group, :ref:`StringName` method, ... **)** |vararg| | +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`change_scene_to_file` **(** :ref:`String` path **)** | +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`change_scene_to_packed` **(** :ref:`PackedScene` packed_scene **)** | +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`SceneTreeTimer` | :ref:`create_timer` **(** :ref:`float` time_sec, :ref:`bool` process_always=true, :ref:`bool` process_in_physics=false, :ref:`bool` ignore_time_scale=false **)** | +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Tween` | :ref:`create_tween` **(** **)** | +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Node` | :ref:`get_first_node_in_group` **(** :ref:`StringName` group **)** | +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_frame` **(** **)** |const| | +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`MultiplayerAPI` | :ref:`get_multiplayer` **(** :ref:`NodePath` for_path=NodePath("") **)** |const| | +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_node_count` **(** **)** |const| | +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_node_count_in_group` **(** :ref:`StringName` group **)** |const| | +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Node[]` | :ref:`get_nodes_in_group` **(** :ref:`StringName` group **)** | +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Tween[]` | :ref:`get_processed_tweens` **(** **)** | +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_group` **(** :ref:`StringName` name **)** |const| | +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`notify_group` **(** :ref:`StringName` group, :ref:`int` notification **)** | +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`notify_group_flags` **(** :ref:`int` call_flags, :ref:`StringName` group, :ref:`int` notification **)** | +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`queue_delete` **(** :ref:`Object` obj **)** | +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`quit` **(** :ref:`int` exit_code=0 **)** | +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`reload_current_scene` **(** **)** | +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_group` **(** :ref:`StringName` group, :ref:`String` property, :ref:`Variant` value **)** | +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_group_flags` **(** :ref:`int` call_flags, :ref:`StringName` group, :ref:`String` property, :ref:`Variant` value **)** | +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_multiplayer` **(** :ref:`MultiplayerAPI` multiplayer, :ref:`NodePath` root_path=NodePath("") **)** | +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`unload_current_scene` **(** **)** | +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_SceneTree_signal_node_added: .. rst-class:: classref-signal **node_added** **(** :ref:`Node` node **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_signal_node_configuration_warning_changed: .. rst-class:: classref-signal **node_configuration_warning_changed** **(** :ref:`Node` node **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_signal_node_removed: .. rst-class:: classref-signal **node_removed** **(** :ref:`Node` node **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_signal_node_renamed: .. rst-class:: classref-signal **node_renamed** **(** :ref:`Node` node **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_signal_physics_frame: .. rst-class:: classref-signal **physics_frame** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_signal_process_frame: .. rst-class:: classref-signal **process_frame** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_signal_tree_changed: .. rst-class:: classref-signal **tree_changed** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_signal_tree_process_mode_changed: .. rst-class:: classref-signal **tree_process_mode_changed** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_SceneTree_GroupCallFlags: .. rst-class:: classref-enumeration enum **GroupCallFlags**: .. _class_SceneTree_constant_GROUP_CALL_DEFAULT: .. rst-class:: classref-enumeration-constant :ref:`GroupCallFlags` **GROUP_CALL_DEFAULT** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_SceneTree_constant_GROUP_CALL_REVERSE: .. rst-class:: classref-enumeration-constant :ref:`GroupCallFlags` **GROUP_CALL_REVERSE** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_SceneTree_constant_GROUP_CALL_DEFERRED: .. rst-class:: classref-enumeration-constant :ref:`GroupCallFlags` **GROUP_CALL_DEFERRED** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_SceneTree_constant_GROUP_CALL_UNIQUE: .. rst-class:: classref-enumeration-constant :ref:`GroupCallFlags` **GROUP_CALL_UNIQUE** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_SceneTree_property_auto_accept_quit: .. rst-class:: classref-property :ref:`bool` **auto_accept_quit** = ``true`` .. rst-class:: classref-property-setget - void **set_auto_accept_quit** **(** :ref:`bool` value **)** - :ref:`bool` **is_auto_accept_quit** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_property_current_scene: .. rst-class:: classref-property :ref:`Node` **current_scene** .. rst-class:: classref-property-setget - void **set_current_scene** **(** :ref:`Node` value **)** - :ref:`Node` **get_current_scene** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_property_debug_collisions_hint: .. rst-class:: classref-property :ref:`bool` **debug_collisions_hint** = ``false`` .. rst-class:: classref-property-setget - void **set_debug_collisions_hint** **(** :ref:`bool` value **)** - :ref:`bool` **is_debugging_collisions_hint** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_property_debug_navigation_hint: .. rst-class:: classref-property :ref:`bool` **debug_navigation_hint** = ``false`` .. rst-class:: classref-property-setget - void **set_debug_navigation_hint** **(** :ref:`bool` value **)** - :ref:`bool` **is_debugging_navigation_hint** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_property_debug_paths_hint: .. rst-class:: classref-property :ref:`bool` **debug_paths_hint** = ``false`` .. rst-class:: classref-property-setget - void **set_debug_paths_hint** **(** :ref:`bool` value **)** - :ref:`bool` **is_debugging_paths_hint** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_property_edited_scene_root: .. rst-class:: classref-property :ref:`Node` **edited_scene_root** .. rst-class:: classref-property-setget - void **set_edited_scene_root** **(** :ref:`Node` value **)** - :ref:`Node` **get_edited_scene_root** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_property_multiplayer_poll: .. rst-class:: classref-property :ref:`bool` **multiplayer_poll** = ``true`` .. rst-class:: classref-property-setget - void **set_multiplayer_poll_enabled** **(** :ref:`bool` value **)** - :ref:`bool` **is_multiplayer_poll_enabled** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_property_paused: .. rst-class:: classref-property :ref:`bool` **paused** = ``false`` .. rst-class:: classref-property-setget - void **set_pause** **(** :ref:`bool` value **)** - :ref:`bool` **is_paused** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_property_physics_interpolation: .. rst-class:: classref-property :ref:`bool` **physics_interpolation** = ``false`` .. rst-class:: classref-property-setget - void **set_physics_interpolation_enabled** **(** :ref:`bool` value **)** - :ref:`bool` **is_physics_interpolation_enabled** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_property_quit_on_go_back: .. rst-class:: classref-property :ref:`bool` **quit_on_go_back** = ``true`` .. rst-class:: classref-property-setget - void **set_quit_on_go_back** **(** :ref:`bool` value **)** - :ref:`bool` **is_quit_on_go_back** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_property_root: .. rst-class:: classref-property :ref:`Window` **root** .. rst-class:: classref-property-setget - :ref:`Window` **get_root** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_SceneTree_method_call_group: .. rst-class:: classref-method void **call_group** **(** :ref:`StringName` group, :ref:`StringName` method, ... **)** |vararg| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_method_call_group_flags: .. rst-class:: classref-method void **call_group_flags** **(** :ref:`int` flags, :ref:`StringName` group, :ref:`StringName` method, ... **)** |vararg| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_method_change_scene_to_file: .. rst-class:: classref-method :ref:`Error` **change_scene_to_file** **(** :ref:`String` path **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_method_change_scene_to_packed: .. rst-class:: classref-method :ref:`Error` **change_scene_to_packed** **(** :ref:`PackedScene` packed_scene **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_method_create_timer: .. rst-class:: classref-method :ref:`SceneTreeTimer` **create_timer** **(** :ref:`float` time_sec, :ref:`bool` process_always=true, :ref:`bool` process_in_physics=false, :ref:`bool` ignore_time_scale=false **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_method_create_tween: .. rst-class:: classref-method :ref:`Tween` **create_tween** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_method_get_first_node_in_group: .. rst-class:: classref-method :ref:`Node` **get_first_node_in_group** **(** :ref:`StringName` group **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_method_get_frame: .. rst-class:: classref-method :ref:`int` **get_frame** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_method_get_multiplayer: .. rst-class:: classref-method :ref:`MultiplayerAPI` **get_multiplayer** **(** :ref:`NodePath` for_path=NodePath("") **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_method_get_node_count: .. rst-class:: classref-method :ref:`int` **get_node_count** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_method_get_node_count_in_group: .. rst-class:: classref-method :ref:`int` **get_node_count_in_group** **(** :ref:`StringName` group **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_method_get_nodes_in_group: .. rst-class:: classref-method :ref:`Node[]` **get_nodes_in_group** **(** :ref:`StringName` group **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_method_get_processed_tweens: .. rst-class:: classref-method :ref:`Tween[]` **get_processed_tweens** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_method_has_group: .. rst-class:: classref-method :ref:`bool` **has_group** **(** :ref:`StringName` name **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_method_notify_group: .. rst-class:: classref-method void **notify_group** **(** :ref:`StringName` group, :ref:`int` notification **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_method_notify_group_flags: .. rst-class:: classref-method void **notify_group_flags** **(** :ref:`int` call_flags, :ref:`StringName` group, :ref:`int` notification **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_method_queue_delete: .. rst-class:: classref-method void **queue_delete** **(** :ref:`Object` obj **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_method_quit: .. rst-class:: classref-method void **quit** **(** :ref:`int` exit_code=0 **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_method_reload_current_scene: .. rst-class:: classref-method :ref:`Error` **reload_current_scene** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_method_set_group: .. rst-class:: classref-method void **set_group** **(** :ref:`StringName` group, :ref:`String` property, :ref:`Variant` value **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_method_set_group_flags: .. rst-class:: classref-method void **set_group_flags** **(** :ref:`int` call_flags, :ref:`StringName` group, :ref:`String` property, :ref:`Variant` value **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_method_set_multiplayer: .. rst-class:: classref-method void **set_multiplayer** **(** :ref:`MultiplayerAPI` multiplayer, :ref:`NodePath` root_path=NodePath("") **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneTree_method_unload_current_scene: .. rst-class:: classref-method void **unload_current_scene** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`