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
Hérite de : RefCounted < Object
Fournit un accès à l'information d'un fichier de scène.
Description
Maintient une liste des ressources, des nœuds, des propriétés exportées et redéfinies et des scripts intégrés associés à une scène. Ils ne peuvent être modifiés à partir d'un SceneState, seulement accessibles. Utile pour jeter un coup d’œil à ce qu'une PackedScene contient sans l'instancier.
Cette classe ne peut pas être instanciée directement, elle est récupérée pour une scène donnée en tant que résultat de PackedScene.get_state().
Méthodes
get_base_scene_state() const |
|
get_connection_binds(idx: int) const |
|
get_connection_count() const |
|
get_connection_flags(idx: int) const |
|
get_connection_method(idx: int) const |
|
get_connection_signal(idx: int) const |
|
get_connection_source(idx: int) const |
|
get_connection_target(idx: int) const |
|
get_connection_unbinds(idx: int) const |
|
get_node_count() const |
|
get_node_groups(idx: int) const |
|
get_node_index(idx: int) const |
|
get_node_instance(idx: int) const |
|
get_node_instance_placeholder(idx: int) const |
|
get_node_name(idx: int) const |
|
get_node_owner_path(idx: int) const |
|
get_node_path(idx: int, for_parent: bool = false) const |
|
get_node_property_count(idx: int) const |
|
get_node_property_name(idx: int, prop_idx: int) const |
|
get_node_property_value(idx: int, prop_idx: int) const |
|
get_node_type(idx: int) const |
|
get_path() const |
|
is_node_instance_placeholder(idx: int) const |
Énumérations
enum GenEditState: 🔗
GenEditState GEN_EDIT_STATE_DISABLED = 0
Si passé à PackedScene.instantiate(), bloque les modifications à l'état de la scène.
GenEditState GEN_EDIT_STATE_INSTANCE = 1
Si passé à PackedScene.instantiate(), fournit les ressources de la scène héritée à la scène locale.
Note : Seulement disponible dans les compilations d'éditeur.
GenEditState GEN_EDIT_STATE_MAIN = 2
If passed to PackedScene.instantiate(), provides local scene resources to the local scene. Only the main scene should receive the main edit state.
Note: Only available in editor builds.
GenEditState GEN_EDIT_STATE_MAIN_INHERITED = 3
S'il est passé à PackedScene.instantiate(), il est similaire à GEN_EDIT_STATE_MAIN, mais pour les cas où la scène est instanciée pour être la base d'une autre scène.
Note : Seulement disponible dans les compilations d'éditeur.
Descriptions des méthodes
SceneState get_base_scene_state() const 🔗
Renvoie le SceneState de la scène dont cette scène hérite, ou null si elle n'hérite pas d'une scène.
Array get_connection_binds(idx: int) const 🔗
Renvoie la liste des paramètres liés pour le signal à l'index idx.
int get_connection_count() const 🔗
Renvoie le nombre de connexions de signal dans la scène.
L'argument idx utilisé pour demander des métadonnées de connexion dans les autres méthodes get_connection_* est dans l'intervalle [0, get_connection_count() - 1].
int get_connection_flags(idx: int) const 🔗
Renvoie les drapeaux de connexion pour le signal à l'index idx. Voir les constantes ConnectFlags.
StringName get_connection_method(idx: int) const 🔗
Renvoie la méthode connectée au signal à l'index idx.
StringName get_connection_signal(idx: int) const 🔗
Renvoie le nom du signal à l'index idx.
NodePath get_connection_source(idx: int) const 🔗
Renvoie le chemin vers le nœud qui possède le signal à l'index idx, relatif au nœud racine.
NodePath get_connection_target(idx: int) const 🔗
Renvoie le chemin vers le nœud qui possède la méthode connectée au signal à l'index idx, relatif au nœud racine.
int get_connection_unbinds(idx: int) const 🔗
Renvoie le nombre de paramètres non liés pour le signal à l'index idx.
Renvoie le nombre de nœuds sur la scène.
L'argument idx utilisé pour demander des données de nœud dans d'autres méthodes get_node_* est dans l'intervalle [0, get_node_count() - 1].
PackedStringArray get_node_groups(idx: int) const 🔗
Renvoie la liste des noms de groupe associés avec le nœud à l'index idx.
int get_node_index(idx: int) const 🔗
Renvoie l'index du nœud, qui est sa position par rapport à ses frères. Ceci est seulement pertinent et sauvegardé dans des scènes pour les cas où de nouveaux nœuds sont ajoutés à une scène instanciée ou héritée parmi les frères de la scène de base. Malgré le nom, cet index n'est pas lié à l'argument idx utilisé ici et dans d'autres méthodes.
PackedScene get_node_instance(idx: int) const 🔗
Renvoie une PackedScene pour le nœud à l'index idx (c.-à-d. toute la branche à partir de ce nœud, avec ses nœuds enfants et ses ressources), ou null si le nœud n'est pas une instance.
String get_node_instance_placeholder(idx: int) const 🔗
Renvoie le chemin vers le fichier de scène représenté si le nœud à l'index idx est un InstancePlaceholder.
StringName get_node_name(idx: int) const 🔗
Renvoie le nom du nœud à l'index idx.
NodePath get_node_owner_path(idx: int) const 🔗
Renvoie le chemin vers le propriétaire du nœud à l'index idx, par rapport au nœud racine.
NodePath get_node_path(idx: int, for_parent: bool = false) const 🔗
Renvoie le chemin vers le nœud à l'index idx.
Si for_parent vaut true, renvoie le chemin du parent du nœud d'index idx à la place.
int get_node_property_count(idx: int) const 🔗
Renvoie le nombre de propriétés exportées ou redéfinies pour le nœud à l'index idx.
L'argument prop_idx utilisé pour rechercher les données de propriété de nœud dans d'autres méthodes get_node_property_* est dans l'intervalle [0, get_node_property_count() - 1].
StringName get_node_property_name(idx: int, prop_idx: int) const 🔗
Renvoie le nom de la propriété à l'index prop_idx pour le nœud à l'index idx.
Variant get_node_property_value(idx: int, prop_idx: int) const 🔗
Renvoie la valeur de la propriété à l'index prop_idx pour le nœud à l'index idx.
StringName get_node_type(idx: int) const 🔗
Renvoie le type du nœud à l'index idx.
Renvoie le chemin de ressource vers la PackedScene représentée.
bool is_node_instance_placeholder(idx: int) const 🔗
Renvoie true si le nœud à l'index idx est un InstancePlaceholder.