godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
4cb983d24b293ff6239c19a438e89ca3942016ed
godot-docs/classes/class_scenetree.rst

315 lines
21 KiB
ReStructuredText
Raw Blame History

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the SceneTree.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_SceneTree:
SceneTree
=========
**Inherits:** :ref:`MainLoop<class_mainloop>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`call_group<class_SceneTree_call_group>` **(** :ref:`String<class_string>` group, :ref:`String<class_string>` method **)** vararg |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`call_group_flags<class_SceneTree_call_group_flags>` **(** :ref:`int<class_int>` flags, :ref:`String<class_string>` group, :ref:`String<class_string>` method **)** vararg |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`change_scene<class_SceneTree_change_scene>` **(** :ref:`String<class_string>` path **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`change_scene_to<class_SceneTree_change_scene_to>` **(** :ref:`PackedScene<class_packedscene>` packed_scene **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`SceneTreeTimer<class_scenetreetimer>` | :ref:`create_timer<class_SceneTree_create_timer>` **(** :ref:`float<class_float>` time_sec, :ref:`bool<class_bool>` pause_mode_process=true **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_frame<class_SceneTree_get_frame>` **(** **)** const |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolIntArray<class_poolintarray>` | :ref:`get_network_connected_peers<class_SceneTree_get_network_connected_peers>` **(** **)** const |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_network_unique_id<class_SceneTree_get_network_unique_id>` **(** **)** const |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_node_count<class_SceneTree_get_node_count>` **(** **)** const |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_nodes_in_group<class_SceneTree_get_nodes_in_group>` **(** :ref:`String<class_string>` group **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_rpc_sender_id<class_SceneTree_get_rpc_sender_id>` **(** **)** const |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_group<class_SceneTree_has_group>` **(** :ref:`String<class_string>` name **)** const |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_network_peer<class_SceneTree_has_network_peer>` **(** **)** const |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_input_handled<class_SceneTree_is_input_handled>` **(** **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_network_server<class_SceneTree_is_network_server>` **(** **)** const |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`notify_group<class_SceneTree_notify_group>` **(** :ref:`String<class_string>` group, :ref:`int<class_int>` notification **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`notify_group_flags<class_SceneTree_notify_group_flags>` **(** :ref:`int<class_int>` call_flags, :ref:`String<class_string>` group, :ref:`int<class_int>` notification **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`queue_delete<class_SceneTree_queue_delete>` **(** :ref:`Object<class_object>` obj **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`quit<class_SceneTree_quit>` **(** **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`reload_current_scene<class_SceneTree_reload_current_scene>` **(** **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_auto_accept_quit<class_SceneTree_set_auto_accept_quit>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_group<class_SceneTree_set_group>` **(** :ref:`String<class_string>` group, :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_group_flags<class_SceneTree_set_group_flags>` **(** :ref:`int<class_int>` call_flags, :ref:`String<class_string>` group, :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_input_as_handled<class_SceneTree_set_input_as_handled>` **(** **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_quit_on_go_back<class_SceneTree_set_quit_on_go_back>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_screen_stretch<class_SceneTree_set_screen_stretch>` **(** :ref:`int<class_int>` mode, :ref:`int<class_int>` aspect, :ref:`Vector2<class_vector2>` minsize, :ref:`float<class_float>` shrink=1 **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
.. _class_SceneTree_connected_to_server:
- **connected_to_server** **(** **)**
.. _class_SceneTree_connection_failed:
- **connection_failed** **(** **)**
.. _class_SceneTree_files_dropped:
- **files_dropped** **(** :ref:`PoolStringArray<class_poolstringarray>` files, :ref:`int<class_int>` screen **)**
.. _class_SceneTree_idle_frame:
- **idle_frame** **(** **)**
.. _class_SceneTree_network_peer_connected:
- **network_peer_connected** **(** :ref:`int<class_int>` id **)**
.. _class_SceneTree_network_peer_disconnected:
- **network_peer_disconnected** **(** :ref:`int<class_int>` id **)**
.. _class_SceneTree_node_added:
- **node_added** **(** :ref:`Object<class_object>` node **)**
.. _class_SceneTree_node_configuration_warning_changed:
- **node_configuration_warning_changed** **(** :ref:`Object<class_object>` node **)**
.. _class_SceneTree_node_removed:
- **node_removed** **(** :ref:`Object<class_object>` node **)**
.. _class_SceneTree_physics_frame:
- **physics_frame** **(** **)**
.. _class_SceneTree_screen_resized:
- **screen_resized** **(** **)**
.. _class_SceneTree_server_disconnected:
- **server_disconnected** **(** **)**
.. _class_SceneTree_tree_changed:
- **tree_changed** **(** **)**
Member Variables
----------------
.. _class_SceneTree_current_scene:
- :ref:`Node<class_node>` **current_scene**
.. _class_SceneTree_debug_collisions_hint:
- :ref:`bool<class_bool>` **debug_collisions_hint**
.. _class_SceneTree_debug_navigation_hint:
- :ref:`bool<class_bool>` **debug_navigation_hint**
.. _class_SceneTree_edited_scene_root:
- :ref:`Node<class_node>` **edited_scene_root**
.. _class_SceneTree_network_peer:
- :ref:`NetworkedMultiplayerPeer<class_networkedmultiplayerpeer>` **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 :ref:`is_network_server()<class_SceneTree_is_network_server()>`) and will set root node's network mode to master (see NETWORK_MODE\_\* constants in :ref:`Node<class_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_paused:
- :ref:`bool<class_bool>` **paused**
.. _class_SceneTree_refuse_new_network_connections:
- :ref:`bool<class_bool>` **refuse_new_network_connections**
.. _class_SceneTree_root:
- :ref:`Viewport<class_viewport>` **root**
.. _class_SceneTree_use_font_oversampling:
- :ref:`bool<class_bool>` **use_font_oversampling**
Enums
-----
.. _enum_SceneTree_GroupCallFlags:
enum **GroupCallFlags**
- **GROUP_CALL_DEFAULT** = **0**
- **GROUP_CALL_REVERSE** = **1**
- **GROUP_CALL_REALTIME** = **2**
- **GROUP_CALL_UNIQUE** = **4**
.. _enum_SceneTree_StretchMode:
enum **StretchMode**
- **STRETCH_MODE_DISABLED** = **0**
- **STRETCH_MODE_2D** = **1**
- **STRETCH_MODE_VIEWPORT** = **2**
.. _enum_SceneTree_StretchAspect:
enum **StretchAspect**
- **STRETCH_ASPECT_IGNORE** = **0**
- **STRETCH_ASPECT_KEEP** = **1**
- **STRETCH_ASPECT_KEEP_WIDTH** = **2**
- **STRETCH_ASPECT_KEEP_HEIGHT** = **3**
- **STRETCH_ASPECT_EXPAND** = **4**
Member Function Description
---------------------------
.. _class_SceneTree_call_group:
- :ref:`Variant<class_variant>` **call_group** **(** :ref:`String<class_string>` group, :ref:`String<class_string>` method **)** vararg
.. _class_SceneTree_call_group_flags:
- :ref:`Variant<class_variant>` **call_group_flags** **(** :ref:`int<class_int>` flags, :ref:`String<class_string>` group, :ref:`String<class_string>` method **)** vararg
.. _class_SceneTree_change_scene:
- :ref:`int<class_int>` **change_scene** **(** :ref:`String<class_string>` path **)**
.. _class_SceneTree_change_scene_to:
- :ref:`int<class_int>` **change_scene_to** **(** :ref:`PackedScene<class_packedscene>` packed_scene **)**
.. _class_SceneTree_create_timer:
- :ref:`SceneTreeTimer<class_scenetreetimer>` **create_timer** **(** :ref:`float<class_float>` time_sec, :ref:`bool<class_bool>` pause_mode_process=true **)**
.. _class_SceneTree_get_frame:
- :ref:`int<class_int>` **get_frame** **(** **)** const
.. _class_SceneTree_get_network_connected_peers:
- :ref:`PoolIntArray<class_poolintarray>` **get_network_connected_peers** **(** **)** const
.. _class_SceneTree_get_network_unique_id:
- :ref:`int<class_int>` **get_network_unique_id** **(** **)** const
.. _class_SceneTree_get_node_count:
- :ref:`int<class_int>` **get_node_count** **(** **)** const
.. _class_SceneTree_get_nodes_in_group:
- :ref:`Array<class_array>` **get_nodes_in_group** **(** :ref:`String<class_string>` group **)**
.. _class_SceneTree_get_rpc_sender_id:
- :ref:`int<class_int>` **get_rpc_sender_id** **(** **)** const
.. _class_SceneTree_has_group:
- :ref:`bool<class_bool>` **has_group** **(** :ref:`String<class_string>` name **)** const
.. _class_SceneTree_has_network_peer:
- :ref:`bool<class_bool>` **has_network_peer** **(** **)** const
Returns true if there is a :ref:`NetworkedMultiplayerPeer<class_networkedmultiplayerpeer>` set (with :ref:`SceneTree.set_network_peer<class_SceneTree_set_network_peer>`).
.. _class_SceneTree_is_input_handled:
- :ref:`bool<class_bool>` **is_input_handled** **(** **)**
.. _class_SceneTree_is_network_server:
- :ref:`bool<class_bool>` **is_network_server** **(** **)** const
Returns true if this SceneTree's :ref:`NetworkedMultiplayerPeer<class_networkedmultiplayerpeer>` is in server mode (listening for connections).
.. _class_SceneTree_notify_group:
- void **notify_group** **(** :ref:`String<class_string>` group, :ref:`int<class_int>` notification **)**
.. _class_SceneTree_notify_group_flags:
- void **notify_group_flags** **(** :ref:`int<class_int>` call_flags, :ref:`String<class_string>` group, :ref:`int<class_int>` notification **)**
.. _class_SceneTree_queue_delete:
- void **queue_delete** **(** :ref:`Object<class_object>` obj **)**
.. _class_SceneTree_quit:
- void **quit** **(** **)**
.. _class_SceneTree_reload_current_scene:
- :ref:`int<class_int>` **reload_current_scene** **(** **)**
.. _class_SceneTree_set_auto_accept_quit:
- void **set_auto_accept_quit** **(** :ref:`bool<class_bool>` enabled **)**
.. _class_SceneTree_set_group:
- void **set_group** **(** :ref:`String<class_string>` group, :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)**
.. _class_SceneTree_set_group_flags:
- void **set_group_flags** **(** :ref:`int<class_int>` call_flags, :ref:`String<class_string>` group, :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)**
.. _class_SceneTree_set_input_as_handled:
- void **set_input_as_handled** **(** **)**
.. _class_SceneTree_set_quit_on_go_back:
- void **set_quit_on_go_back** **(** :ref:`bool<class_bool>` enabled **)**
.. _class_SceneTree_set_screen_stretch:
- void **set_screen_stretch** **(** :ref:`int<class_int>` mode, :ref:`int<class_int>` aspect, :ref:`Vector2<class_vector2>` minsize, :ref:`float<class_float>` shrink=1 **)**
Reference in New Issue View Git Blame Copy Permalink