Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

SceneState

Inherits: Reference < 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 PackedScene.get_state.

Métodos

Array

get_connection_binds ( int idx ) const

int

get_connection_count ( ) const

int

get_connection_flags ( int idx ) const

String

get_connection_method ( int idx ) const

String

get_connection_signal ( int idx ) const

NodePath

get_connection_source ( int idx ) const

NodePath

get_connection_target ( int idx ) const

int

get_node_count ( ) const

PoolStringArray

get_node_groups ( int idx ) const

int

get_node_index ( int idx ) const

PackedScene

get_node_instance ( int idx ) const

String

get_node_instance_placeholder ( int idx ) const

String

get_node_name ( int idx ) const

NodePath

get_node_owner_path ( int idx ) const

NodePath

get_node_path ( int idx, bool for_parent=false ) const

int

get_node_property_count ( int idx ) const

String

get_node_property_name ( int idx, int prop_idx ) const

Variant

get_node_property_value ( int idx, int prop_idx ) const

String

get_node_type ( int idx ) const

bool

is_node_instance_placeholder ( int idx ) const

Enumeraciones

enum GenEditState:

  • GEN_EDIT_STATE_DISABLED = 0 --- Si se pasa a PackedScene.instance, bloquea las ediciones al estado de escena.

  • GEN_EDIT_STATE_INSTANCE = 1 --- Si se pasa a PackedScene.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 PackedScene.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 PackedScene.instance, it's similar to 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

  • Array get_connection_binds ( int idx ) const

Devuelve la lista de parámetros vinculados a la señal en idx.

  • 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].

  • int get_connection_flags ( int idx ) const

Devuelve las flags de conexión para la señal en idx. Ver las constantes ConnectFlags.

  • String get_connection_method ( int idx ) const

Devuelve el método conectado a la señal en idx.

  • String get_connection_signal ( int idx ) const

Devuelve el nombre de la señal en idx.

Devuelve el camino al nodo que posee la señal en idx, relativo al nodo raíz.

Devuelve el camino al nodo que posee el método conectado a la señal en idx, relativo al nodo raíz.

  • 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].

Devuelve la lista de nombres de grupos asociados al nodo en idx.

  • int get_node_index ( 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.

Devuelve un 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.

  • String get_node_instance_placeholder ( int idx ) const

Devuelve la ruta del archivo de la escena representada si el nodo en idx es un InstancePlaceholder.

Devuelve el nombre del nodo en idx.

Devuelve la ruta al propietario del nodo en idx, relativa al nodo raíz.

Devuelve el camino al nodo en idx.

Si for_parent es true, devuelve la ruta del padre del nodo idx en su lugar.

  • int get_node_property_count ( 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].

  • String get_node_property_name ( int idx, int prop_idx ) const

Devuelve el nombre de la propiedad en prop_idx para el nodo en idx.

  • Variant get_node_property_value ( int idx, int prop_idx ) const

Devuelve el valor de la propiedad en prop_idx para el nodo en idx.

Devuelve el tipo de nodo en idx.

  • bool is_node_instance_placeholder ( int idx ) const

Devuelve true si el nodo de idx es un InstancePlaceholder.