Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259
							:github_url: hide

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the SceneState.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_SceneState:

SceneState
==========

**Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

A script interface to a scene file's data.

Description
-----------

Maintains a list of resources, nodes, exported, and overridden properties, and built-in scripts associated with a scene.

This class cannot be instantiated directly, it is retrieved for a given scene as the result of :ref:`PackedScene.get_state<class_PackedScene_method_get_state>`.

Methods
-------

+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>`                         | :ref:`get_connection_binds<class_SceneState_method_get_connection_binds>` **(** :ref:`int<class_int>` idx **)** const                                       |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                             | :ref:`get_connection_count<class_SceneState_method_get_connection_count>` **(** **)** const                                                                 |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                             | :ref:`get_connection_flags<class_SceneState_method_get_connection_flags>` **(** :ref:`int<class_int>` idx **)** const                                       |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringName<class_StringName>`               | :ref:`get_connection_method<class_SceneState_method_get_connection_method>` **(** :ref:`int<class_int>` idx **)** const                                     |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringName<class_StringName>`               | :ref:`get_connection_signal<class_SceneState_method_get_connection_signal>` **(** :ref:`int<class_int>` idx **)** const                                     |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_NodePath>`                   | :ref:`get_connection_source<class_SceneState_method_get_connection_source>` **(** :ref:`int<class_int>` idx **)** const                                     |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_NodePath>`                   | :ref:`get_connection_target<class_SceneState_method_get_connection_target>` **(** :ref:`int<class_int>` idx **)** const                                     |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                             | :ref:`get_node_count<class_SceneState_method_get_node_count>` **(** **)** const                                                                             |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_node_groups<class_SceneState_method_get_node_groups>` **(** :ref:`int<class_int>` idx **)** const                                                 |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                             | :ref:`get_node_index<class_SceneState_method_get_node_index>` **(** :ref:`int<class_int>` idx **)** const                                                   |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedScene<class_PackedScene>`             | :ref:`get_node_instance<class_SceneState_method_get_node_instance>` **(** :ref:`int<class_int>` idx **)** const                                             |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                       | :ref:`get_node_instance_placeholder<class_SceneState_method_get_node_instance_placeholder>` **(** :ref:`int<class_int>` idx **)** const                     |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringName<class_StringName>`               | :ref:`get_node_name<class_SceneState_method_get_node_name>` **(** :ref:`int<class_int>` idx **)** const                                                     |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_NodePath>`                   | :ref:`get_node_owner_path<class_SceneState_method_get_node_owner_path>` **(** :ref:`int<class_int>` idx **)** const                                         |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_NodePath>`                   | :ref:`get_node_path<class_SceneState_method_get_node_path>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` for_parent=false **)** const           |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                             | :ref:`get_node_property_count<class_SceneState_method_get_node_property_count>` **(** :ref:`int<class_int>` idx **)** const                                 |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringName<class_StringName>`               | :ref:`get_node_property_name<class_SceneState_method_get_node_property_name>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` prop_idx **)** const   |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>`                     | :ref:`get_node_property_value<class_SceneState_method_get_node_property_value>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` prop_idx **)** const |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringName<class_StringName>`               | :ref:`get_node_type<class_SceneState_method_get_node_type>` **(** :ref:`int<class_int>` idx **)** const                                                     |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                           | :ref:`is_node_instance_placeholder<class_SceneState_method_is_node_instance_placeholder>` **(** :ref:`int<class_int>` idx **)** const                       |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+

Enumerations
------------

.. _enum_SceneState_GenEditState:

.. _class_SceneState_constant_GEN_EDIT_STATE_DISABLED:

.. _class_SceneState_constant_GEN_EDIT_STATE_INSTANCE:

.. _class_SceneState_constant_GEN_EDIT_STATE_MAIN:

enum **GenEditState**:

- **GEN_EDIT_STATE_DISABLED** = **0** --- If passed to :ref:`PackedScene.instance<class_PackedScene_method_instance>`, blocks edits to the scene state.

- **GEN_EDIT_STATE_INSTANCE** = **1** --- If passed to :ref:`PackedScene.instance<class_PackedScene_method_instance>`, provides inherited scene resources to the local scene.

**Note:** Only available in editor builds.

- **GEN_EDIT_STATE_MAIN** = **2** --- If passed to :ref:`PackedScene.instance<class_PackedScene_method_instance>`, provides local scene resources to the local scene. Only the main scene should receive the main edit state.

**Note:** Only available in editor builds.

Method Descriptions
-------------------

.. _class_SceneState_method_get_connection_binds:

- :ref:`Array<class_Array>` **get_connection_binds** **(** :ref:`int<class_int>` idx **)** const

Returns the list of bound parameters for the signal at ``idx``.

----

.. _class_SceneState_method_get_connection_count:

- :ref:`int<class_int>` **get_connection_count** **(** **)** const

Returns the number of signal connections in the scene.

The ``idx`` argument used to query connection metadata in other ``get_connection_*`` methods in the interval ``[0, get_connection_count() - 1]``.

----

.. _class_SceneState_method_get_connection_flags:

- :ref:`int<class_int>` **get_connection_flags** **(** :ref:`int<class_int>` idx **)** const

Returns the connection flags for the signal at ``idx``. See :ref:`ConnectFlags<enum_Object_ConnectFlags>` constants.

----

.. _class_SceneState_method_get_connection_method:

- :ref:`StringName<class_StringName>` **get_connection_method** **(** :ref:`int<class_int>` idx **)** const

Returns the method connected to the signal at ``idx``.

----

.. _class_SceneState_method_get_connection_signal:

- :ref:`StringName<class_StringName>` **get_connection_signal** **(** :ref:`int<class_int>` idx **)** const

Returns the name of the signal at ``idx``.

----

.. _class_SceneState_method_get_connection_source:

- :ref:`NodePath<class_NodePath>` **get_connection_source** **(** :ref:`int<class_int>` idx **)** const

Returns the path to the node that owns the signal at ``idx``, relative to the root node.

----

.. _class_SceneState_method_get_connection_target:

- :ref:`NodePath<class_NodePath>` **get_connection_target** **(** :ref:`int<class_int>` idx **)** const

Returns the path to the node that owns the method connected to the signal at ``idx``, relative to the root node.

----

.. _class_SceneState_method_get_node_count:

- :ref:`int<class_int>` **get_node_count** **(** **)** const

Returns the number of nodes in the scene.

The ``idx`` argument used to query node data in other ``get_node_*`` methods in the interval ``[0, get_node_count() - 1]``.

----

.. _class_SceneState_method_get_node_groups:

- :ref:`PackedStringArray<class_PackedStringArray>` **get_node_groups** **(** :ref:`int<class_int>` idx **)** const

Returns the list of group names associated with the node at ``idx``.

----

.. _class_SceneState_method_get_node_index:

- :ref:`int<class_int>` **get_node_index** **(** :ref:`int<class_int>` idx **)** const

Returns the node's index, which is its position relative to its siblings. This is only relevant and saved in scenes for cases where new nodes are added to an instanced or inherited scene among siblings from the base scene. Despite the name, this index is not related to the ``idx`` argument used here and in other methods.

----

.. _class_SceneState_method_get_node_instance:

- :ref:`PackedScene<class_PackedScene>` **get_node_instance** **(** :ref:`int<class_int>` idx **)** const

Returns a :ref:`PackedScene<class_PackedScene>` for the node at ``idx`` (i.e. the whole branch starting at this node, with its child nodes and resources), or ``null`` if the node is not an instance.

----

.. _class_SceneState_method_get_node_instance_placeholder:

- :ref:`String<class_String>` **get_node_instance_placeholder** **(** :ref:`int<class_int>` idx **)** const

Returns the path to the represented scene file if the node at ``idx`` is an :ref:`InstancePlaceholder<class_InstancePlaceholder>`.

----

.. _class_SceneState_method_get_node_name:

- :ref:`StringName<class_StringName>` **get_node_name** **(** :ref:`int<class_int>` idx **)** const

Returns the name of the node at ``idx``.

----

.. _class_SceneState_method_get_node_owner_path:

- :ref:`NodePath<class_NodePath>` **get_node_owner_path** **(** :ref:`int<class_int>` idx **)** const

Returns the path to the owner of the node at ``idx``, relative to the root node.

----

.. _class_SceneState_method_get_node_path:

- :ref:`NodePath<class_NodePath>` **get_node_path** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` for_parent=false **)** const

Returns the path to the node at ``idx``.

If ``for_parent`` is ``true``, returns the path of the ``idx`` node's parent instead.

----

.. _class_SceneState_method_get_node_property_count:

- :ref:`int<class_int>` **get_node_property_count** **(** :ref:`int<class_int>` idx **)** const

Returns the number of exported or overridden properties for the node at ``idx``.

The ``prop_idx`` argument used to query node property data in other ``get_node_property_*`` methods in the interval ``[0, get_node_property_count() - 1]``.

----

.. _class_SceneState_method_get_node_property_name:

- :ref:`StringName<class_StringName>` **get_node_property_name** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` prop_idx **)** const

Returns the name of the property at ``prop_idx`` for the node at ``idx``.

----

.. _class_SceneState_method_get_node_property_value:

- :ref:`Variant<class_Variant>` **get_node_property_value** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` prop_idx **)** const

Returns the value of the property at ``prop_idx`` for the node at ``idx``.

----

.. _class_SceneState_method_get_node_type:

- :ref:`StringName<class_StringName>` **get_node_type** **(** :ref:`int<class_int>` idx **)** const

Returns the type of the node at ``idx``.

----

.. _class_SceneState_method_is_node_instance_placeholder:

- :ref:`bool<class_bool>` **is_node_instance_placeholder** **(** :ref:`int<class_int>` idx **)** const

Returns ``true`` if the node at ``idx`` is an :ref:`InstancePlaceholder<class_InstancePlaceholder>`.