.. Generated automatically by doc/tools/makerst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. .. _class_SceneTree: SceneTree ========= **Inherits:** :ref:`MainLoop` **<** :ref:`Object` **Category:** Core Brief Description ----------------- Member Functions ---------------- +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`call_group` **(** :ref:`int` flags, :ref:`String` group, :ref:`String` method, :ref:`Variant` arg0=NULL, :ref:`Variant` arg1=NULL, :ref:`Variant` arg2=NULL, :ref:`Variant` arg3=NULL, :ref:`Variant` arg4=NULL **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`change_scene` **(** :ref:`String` path **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`change_scene_to` **(** :ref:`PackedScene` packed_scene **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Node` | :ref:`get_current_scene` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Object` | :ref:`get_edited_scene_root` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_frame` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_node_count` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_nodes_in_group` **(** :ref:`String` group **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Viewport` | :ref:`get_root` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_group` **(** :ref:`String` name **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_debugging_collisions_hint` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_debugging_navigation_hint` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_editor_hint` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_input_handled` **(** **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_paused` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`notify_group` **(** :ref:`int` call_flags, :ref:`String` group, :ref:`int` notification **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`queue_delete` **(** :ref:`Object` obj **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`quit` **(** **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`reload_current_scene` **(** **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_auto_accept_quit` **(** :ref:`bool` enabled **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_current_scene` **(** :ref:`Node` child_node **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_debug_collisions_hint` **(** :ref:`bool` enable **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_debug_navigation_hint` **(** :ref:`bool` enable **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_edited_scene_root` **(** :ref:`Object` scene **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_editor_hint` **(** :ref:`bool` enable **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_group` **(** :ref:`int` call_flags, :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_input_as_handled` **(** **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_pause` **(** :ref:`bool` enable **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_screen_stretch` **(** :ref:`int` mode, :ref:`int` aspect, :ref:`Vector2` minsize **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- - **connected_to_server** **(** **)** - **connection_failed** **(** **)** - **files_dropped** **(** :ref:`PoolStringArray` files, :ref:`int` screen **)** - **fixed_frame** **(** **)** - **idle_frame** **(** **)** - **network_peer_connected** **(** :ref:`int` id **)** - **network_peer_disconnected** **(** :ref:`int` id **)** - **node_configuration_warning_changed** **(** :ref:`Object` node **)** - **node_removed** **(** :ref:`Object` node **)** - **screen_resized** **(** **)** - **server_disconnected** **(** **)** - **tree_changed** **(** **)** Numeric Constants ----------------- - **GROUP_CALL_DEFAULT** = **0** - **GROUP_CALL_REVERSE** = **1** - **GROUP_CALL_REALTIME** = **2** - **GROUP_CALL_UNIQUE** = **4** - **STRETCH_MODE_DISABLED** = **0** - **STRETCH_MODE_2D** = **1** - **STRETCH_MODE_VIEWPORT** = **2** - **STRETCH_ASPECT_IGNORE** = **0** - **STRETCH_ASPECT_KEEP** = **1** - **STRETCH_ASPECT_KEEP_WIDTH** = **2** - **STRETCH_ASPECT_KEEP_HEIGHT** = **3** Member Function Description --------------------------- .. _class_SceneTree_call_group: - :ref:`Variant` **call_group** **(** :ref:`String` group, :ref:`String` method **)** vararg .. _class_SceneTree_call_group_flags: - :ref:`Variant` **call_group_flags** **(** :ref:`int` flags, :ref:`String` group, :ref:`String` method **)** vararg .. _class_SceneTree_change_scene: - :ref:`int` **change_scene** **(** :ref:`String` path **)** .. _class_SceneTree_change_scene_to: - :ref:`int` **change_scene_to** **(** :ref:`PackedScene` packed_scene **)** .. _class_SceneTree_create_timer: - :ref:`SceneTreeTimer` **create_timer** **(** :ref:`float` time_sec, :ref:`bool` pause_mode_process=null **)** .. _class_SceneTree_get_current_scene: - :ref:`Node` **get_current_scene** **(** **)** const .. _class_SceneTree_get_edited_scene_root: - :ref:`Node` **get_edited_scene_root** **(** **)** const .. _class_SceneTree_get_frame: - :ref:`int` **get_frame** **(** **)** const .. _class_SceneTree_get_network_connected_peers: - :ref:`PoolIntArray` **get_network_connected_peers** **(** **)** const .. _class_SceneTree_get_network_unique_id: - :ref:`int` **get_network_unique_id** **(** **)** const .. _class_SceneTree_get_node_count: - :ref:`int` **get_node_count** **(** **)** const .. _class_SceneTree_get_nodes_in_group: - :ref:`Array` **get_nodes_in_group** **(** :ref:`String` group **)** .. _class_SceneTree_get_root: - :ref:`Viewport` **get_root** **(** **)** const .. _class_SceneTree_get_rpc_sender_id: - :ref:`int` **get_rpc_sender_id** **(** **)** const .. _class_SceneTree_has_group: - :ref:`bool` **has_group** **(** :ref:`String` name **)** const .. _class_SceneTree_has_network_peer: - :ref:`bool` **has_network_peer** **(** **)** const Returns true if there is a :ref:`NetworkedMultiplayerPeer` set (with :ref:`SceneTree.set_network_peer`). .. _class_SceneTree_is_debugging_collisions_hint: - :ref:`bool` **is_debugging_collisions_hint** **(** **)** const .. _class_SceneTree_is_debugging_navigation_hint: - :ref:`bool` **is_debugging_navigation_hint** **(** **)** const .. _class_SceneTree_is_input_handled: - :ref:`bool` **is_input_handled** **(** **)** .. _class_SceneTree_is_network_server: - :ref:`bool` **is_network_server** **(** **)** const Returns true if this SceneTree's :ref:`NetworkedMultiplayerPeer` is in server mode (listening for connections). .. _class_SceneTree_is_input_handled: - :ref:`bool` **is_input_handled** **(** **)** .. _class_SceneTree_is_paused: - :ref:`bool` **is_paused** **(** **)** const .. _class_SceneTree_is_refusing_new_network_connections: - :ref:`bool` **is_refusing_new_network_connections** **(** **)** const .. _class_SceneTree_notify_group: - void **notify_group** **(** :ref:`String` group, :ref:`int` notification **)** .. _class_SceneTree_notify_group_flags: - void **notify_group_flags** **(** :ref:`int` call_flags, :ref:`String` group, :ref:`int` notification **)** .. _class_SceneTree_queue_delete: - void **queue_delete** **(** :ref:`Object` obj **)** .. _class_SceneTree_quit: - void **quit** **(** **)** .. _class_SceneTree_reload_current_scene: - :ref:`int` **reload_current_scene** **(** **)** .. _class_SceneTree_set_auto_accept_quit: - void **set_auto_accept_quit** **(** :ref:`bool` enabled **)** .. _class_SceneTree_set_current_scene: - void **set_current_scene** **(** :ref:`Node` child_node **)** .. _class_SceneTree_set_debug_collisions_hint: - void **set_debug_collisions_hint** **(** :ref:`bool` enable **)** .. _class_SceneTree_set_debug_navigation_hint: - void **set_debug_navigation_hint** **(** :ref:`bool` enable **)** .. _class_SceneTree_set_edited_scene_root: - void **set_edited_scene_root** **(** :ref:`Node` scene **)** .. _class_SceneTree_set_group: - void **set_group** **(** :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** .. _class_SceneTree_set_group_flags: - void **set_group_flags** **(** :ref:`int` call_flags, :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** .. _class_SceneTree_set_input_as_handled: - void **set_input_as_handled** **(** **)** .. _class_SceneTree_set_network_peer: - void **set_network_peer** **(** :ref:`NetworkedMultiplayerPeer` peer **)** Set the peer object to handle the RPC system (effectively enabling networking). Depending on the peer itself, the SceneTree will become a network server (check with :ref:`is_network_server()`) and will set root node's network mode to master (see NETWORK_MODE\_\* constants in :ref:`Node`), or it will become a regular peer with root node set to slave. 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. .. _class_SceneTree_set_pause: - void **set_pause** **(** :ref:`bool` enable **)** .. _class_SceneTree_set_refuse_new_network_connections: - void **set_refuse_new_network_connections** **(** :ref:`bool` refuse **)** .. _class_SceneTree_set_screen_stretch: - void **set_screen_stretch** **(** :ref:`int` mode, :ref:`int` aspect, :ref:`Vector2` minsize, :ref:`int` shrink=null **)**