mirror of
https://github.com/godotengine/godot-docs-l10n.git
synced 2026-01-05 14:10:19 +03:00
cf78697eea
Currently including `zh_CN` and `es` which both have very high completion ratios. Others will be added once they reach a significant percentage too. These RST files will be used by godot-docs in place of its `classes` folder after we sync with https://github.com/godotengine/godot-docs/pull/5458. The update workflow is manual for now (example for `zh_CN`): - Build `godotengine/godot` in the branch we currently track (now `3.x`) - Run `godot --doctool -l zh_CN` - Run `cd doc && make rst LANGARG=zh_CN` - Copy `doc/_build/rst/*` to `classes/zh_CN/` here - Make sure to have `classes/zh_CN/index.rst` copied from `docs/classes`
269 lines
16 KiB
ReStructuredText
269 lines
16 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/make_rst.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>`
|
|
|
|
Una interfaz de script para los datos de un archivo de escena.
|
|
|
|
Descripción
|
|
----------------------
|
|
|
|
Mantiene una lista de recursos, nodos, propiedades exportadas y anuladas, y scripts incorporados asociados a una escena.
|
|
|
|
Esta clase no puede ser instanciada directamente, se recupera para una escena dada como resultado del :ref:`PackedScene.get_state<class_PackedScene_method_get_state>`.
|
|
|
|
Métodos
|
|
--------------
|
|
|
|
+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :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| |
|
|
+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Enumeraciones
|
|
--------------------------
|
|
|
|
.. _enum_SceneState_GenEditState:
|
|
|
|
.. _class_SceneState_constant_GEN_EDIT_STATE_DISABLED:
|
|
|
|
.. _class_SceneState_constant_GEN_EDIT_STATE_INSTANCE:
|
|
|
|
.. _class_SceneState_constant_GEN_EDIT_STATE_MAIN:
|
|
|
|
.. _class_SceneState_constant_GEN_EDIT_STATE_MAIN_INHERITED:
|
|
|
|
enum **GenEditState**:
|
|
|
|
- **GEN_EDIT_STATE_DISABLED** = **0** --- Si se pasa a :ref:`PackedScene.instance<class_PackedScene_method_instance>`, bloquea las ediciones al estado de escena.
|
|
|
|
- **GEN_EDIT_STATE_INSTANCE** = **1** --- Si se pasa a :ref:`PackedScene.instance<class_PackedScene_method_instance>`, proporciona recursos de escena heredados a la escena local.
|
|
|
|
\ **Nota:** Sólo disponible en las construcciones de los editores.
|
|
|
|
- **GEN_EDIT_STATE_MAIN** = **2** --- Si se pasa a :ref:`PackedScene.instance<class_PackedScene_method_instance>`, proporciona recursos de la escena local a la escena local. Sólo la escena principal debería recibir el estado de edición principal.
|
|
|
|
\ **Nota:** Sólo disponible en las construcciones de los editores.
|
|
|
|
- **GEN_EDIT_STATE_MAIN_INHERITED** = **3** --- If passed to :ref:`PackedScene.instance<class_PackedScene_method_instance>`, it's similar to :ref:`GEN_EDIT_STATE_MAIN<class_SceneState_constant_GEN_EDIT_STATE_MAIN>`, but for the case where the scene is being instantiated to be the base of another one.
|
|
|
|
\ **Note:** Only available in editor builds.
|
|
|
|
Descripciones de Métodos
|
|
------------------------------------------------
|
|
|
|
.. _class_SceneState_method_get_connection_binds:
|
|
|
|
- :ref:`Array<class_Array>` **get_connection_binds** **(** :ref:`int<class_int>` idx **)** |const|
|
|
|
|
Devuelve la lista de parámetros vinculados a la señal en ``idx``.
|
|
|
|
----
|
|
|
|
.. _class_SceneState_method_get_connection_count:
|
|
|
|
- :ref:`int<class_int>` **get_connection_count** **(** **)** |const|
|
|
|
|
Devuelve el número de conexiones de señales en la escena.
|
|
|
|
El argumento ``idx`` utilizado para consultar los metadatos de conexión en otros métodos ``get_connection_*`` en el intervalo ``[0, get_connection_count() - 1]``.
|
|
|
|
----
|
|
|
|
.. _class_SceneState_method_get_connection_flags:
|
|
|
|
- :ref:`int<class_int>` **get_connection_flags** **(** :ref:`int<class_int>` idx **)** |const|
|
|
|
|
Devuelve las flags de conexión para la señal en ``idx``. Ver las constantes :ref:`ConnectFlags<enum_Object_ConnectFlags>`.
|
|
|
|
----
|
|
|
|
.. _class_SceneState_method_get_connection_method:
|
|
|
|
- :ref:`String<class_String>` **get_connection_method** **(** :ref:`int<class_int>` idx **)** |const|
|
|
|
|
Devuelve el método conectado a la señal en ``idx``.
|
|
|
|
----
|
|
|
|
.. _class_SceneState_method_get_connection_signal:
|
|
|
|
- :ref:`String<class_String>` **get_connection_signal** **(** :ref:`int<class_int>` idx **)** |const|
|
|
|
|
Devuelve el nombre de la señal en ``idx``.
|
|
|
|
----
|
|
|
|
.. _class_SceneState_method_get_connection_source:
|
|
|
|
- :ref:`NodePath<class_NodePath>` **get_connection_source** **(** :ref:`int<class_int>` idx **)** |const|
|
|
|
|
Devuelve el camino al nodo que posee la señal en ``idx``, relativo al nodo raíz.
|
|
|
|
----
|
|
|
|
.. _class_SceneState_method_get_connection_target:
|
|
|
|
- :ref:`NodePath<class_NodePath>` **get_connection_target** **(** :ref:`int<class_int>` idx **)** |const|
|
|
|
|
Devuelve el camino al nodo que posee el método conectado a la señal en ``idx``, relativo al nodo raíz.
|
|
|
|
----
|
|
|
|
.. _class_SceneState_method_get_node_count:
|
|
|
|
- :ref:`int<class_int>` **get_node_count** **(** **)** |const|
|
|
|
|
Devuelve el número de nodos en la escena.
|
|
|
|
El argumento ``idx`` utilizado para consultar los datos de los nodos en otros métodos ``get_node_*`` en el intervalo ``[0, get_node_count() - 1]``.
|
|
|
|
----
|
|
|
|
.. _class_SceneState_method_get_node_groups:
|
|
|
|
- :ref:`PoolStringArray<class_PoolStringArray>` **get_node_groups** **(** :ref:`int<class_int>` idx **)** |const|
|
|
|
|
Devuelve la lista de nombres de grupos asociados al nodo en ``idx``.
|
|
|
|
----
|
|
|
|
.. _class_SceneState_method_get_node_index:
|
|
|
|
- :ref:`int<class_int>` **get_node_index** **(** :ref:`int<class_int>` idx **)** |const|
|
|
|
|
Devuelve el índice del nodo, que es su posición en relación con sus hermanos. Esto sólo es relevante y se guarda en las escenas para los casos en que se añaden nuevos nodos a una escena instanciada o heredada entre hermanos de la escena base. A pesar del nombre, este índice no está relacionado con el argumento ``idx`` utilizado aquí y en otros métodos.
|
|
|
|
----
|
|
|
|
.. _class_SceneState_method_get_node_instance:
|
|
|
|
- :ref:`PackedScene<class_PackedScene>` **get_node_instance** **(** :ref:`int<class_int>` idx **)** |const|
|
|
|
|
Devuelve un :ref:`PackedScene<class_PackedScene>` para el nodo en ``idx`` (es decir, toda la rama que comienza en este nodo, con sus nodos hijos y recursos), o ``null`` si el nodo no es una instancia.
|
|
|
|
----
|
|
|
|
.. _class_SceneState_method_get_node_instance_placeholder:
|
|
|
|
- :ref:`String<class_String>` **get_node_instance_placeholder** **(** :ref:`int<class_int>` idx **)** |const|
|
|
|
|
Devuelve la ruta del archivo de la escena representada si el nodo en ``idx`` es un :ref:`InstancePlaceholder<class_InstancePlaceholder>`.
|
|
|
|
----
|
|
|
|
.. _class_SceneState_method_get_node_name:
|
|
|
|
- :ref:`String<class_String>` **get_node_name** **(** :ref:`int<class_int>` idx **)** |const|
|
|
|
|
Devuelve el nombre del nodo en ``idx``.
|
|
|
|
----
|
|
|
|
.. _class_SceneState_method_get_node_owner_path:
|
|
|
|
- :ref:`NodePath<class_NodePath>` **get_node_owner_path** **(** :ref:`int<class_int>` idx **)** |const|
|
|
|
|
Devuelve la ruta al propietario del nodo en ``idx``, relativa al nodo raíz.
|
|
|
|
----
|
|
|
|
.. _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|
|
|
|
|
Devuelve el camino al nodo en ``idx``.
|
|
|
|
Si ``for_parent`` es ``true``, devuelve la ruta del padre del nodo ``idx`` en su lugar.
|
|
|
|
----
|
|
|
|
.. _class_SceneState_method_get_node_property_count:
|
|
|
|
- :ref:`int<class_int>` **get_node_property_count** **(** :ref:`int<class_int>` idx **)** |const|
|
|
|
|
Devuelve el número de propiedades exportadas o anuladas del nodo en ``idx``.
|
|
|
|
El argumento ``prop_idx`` utilizado para consultar los datos de las propiedades del nodo en otros métodos ``get_node_property_*`` en el intervalo ``[0, get_node_property_count() - 1]``.
|
|
|
|
----
|
|
|
|
.. _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|
|
|
|
|
Devuelve el nombre de la propiedad en ``prop_idx`` para el nodo en ``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|
|
|
|
|
Devuelve el valor de la propiedad en ``prop_idx`` para el nodo en ``idx``.
|
|
|
|
----
|
|
|
|
.. _class_SceneState_method_get_node_type:
|
|
|
|
- :ref:`String<class_String>` **get_node_type** **(** :ref:`int<class_int>` idx **)** |const|
|
|
|
|
Devuelve el tipo de nodo en ``idx``.
|
|
|
|
----
|
|
|
|
.. _class_SceneState_method_is_node_instance_placeholder:
|
|
|
|
- :ref:`bool<class_bool>` **is_node_instance_placeholder** **(** :ref:`int<class_int>` idx **)** |const|
|
|
|
|
Devuelve ``true`` si el nodo de ``idx`` es un :ref:`InstancePlaceholder<class_InstancePlaceholder>`.
|
|
|
|
.. |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.)`
|