mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
209 lines
14 KiB
ReStructuredText
209 lines
14 KiB
ReStructuredText
.. 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>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
A script interface to a scene file's data.
|
|
|
|
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:`String<class_String>` | :ref:`get_connection_method<class_SceneState_method_get_connection_method>` **(** :ref:`int<class_int>` idx **)** const |
|
|
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :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:`PoolStringArray<class_PoolStringArray>` | :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:`String<class_String>` | :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:`String<class_String>` | :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:`String<class_String>` | :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. Requires tools compiled.
|
|
|
|
- **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. Requires tools compiled.
|
|
|
|
Description
|
|
-----------
|
|
|
|
Maintains a list of resources, nodes, exported, and overridden properties, and built-in scripts associated with a scene.
|
|
|
|
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.
|
|
|
|
.. _class_SceneState_method_get_connection_flags:
|
|
|
|
- :ref:`int<class_int>` **get_connection_flags** **(** :ref:`int<class_int>` idx **)** const
|
|
|
|
Returns the flags for the signal at ``idx``. See :ref:`Object<class_Object>`'s ``CONNECT_*`` flags.
|
|
|
|
.. _class_SceneState_method_get_connection_method:
|
|
|
|
- :ref:`String<class_String>` **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:`String<class_String>` **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.
|
|
|
|
.. _class_SceneState_method_get_node_groups:
|
|
|
|
- :ref:`PoolStringArray<class_PoolStringArray>` **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
|
|
|
|
.. _class_SceneState_method_get_node_instance:
|
|
|
|
- :ref:`PackedScene<class_PackedScene>` **get_node_instance** **(** :ref:`int<class_int>` idx **)** const
|
|
|
|
Returns the scene for the node at ``idx`` 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:`String<class_String>` **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``.
|
|
|
|
.. _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``.
|
|
|
|
.. _class_SceneState_method_get_node_property_name:
|
|
|
|
- :ref:`String<class_String>` **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:`String<class_String>` **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>`.
|
|
|