godotengine/godot-docs-l10n
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs-l10n.git synced 2026-01-05 14:10:19 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
4.x
godot-docs-l10n/classes/fr/class_scenestate.rst

428 lines
23 KiB
ReStructuredText
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

:github_url: hide
.. _class_SceneState:
SceneState
==========
**Hérite de :** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
Fournit un accès à l'information d'un fichier de scène.
.. rst-class:: classref-introduction-group
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 :ref:`PackedScene<class_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 :ref:`PackedScene.get_state()<class_PackedScene_method_get_state>`.
.. rst-class:: classref-reftable-group
Méthodes
----------------
.. table::
:widths: auto
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`SceneState<class_SceneState>` | :ref:`get_base_scene_state<class_SceneState_method_get_base_scene_state>`\ (\ ) |const| |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>` | :ref:`get_connection_binds<class_SceneState_method_get_connection_binds>`\ (\ idx\: :ref:`int<class_int>`\ ) |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>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringName<class_StringName>` | :ref:`get_connection_method<class_SceneState_method_get_connection_method>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringName<class_StringName>` | :ref:`get_connection_signal<class_SceneState_method_get_connection_signal>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_NodePath>` | :ref:`get_connection_source<class_SceneState_method_get_connection_source>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_NodePath>` | :ref:`get_connection_target<class_SceneState_method_get_connection_target>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_connection_unbinds<class_SceneState_method_get_connection_unbinds>`\ (\ idx\: :ref:`int<class_int>`\ ) |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>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_node_index<class_SceneState_method_get_node_index>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedScene<class_PackedScene>` | :ref:`get_node_instance<class_SceneState_method_get_node_instance>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_node_instance_placeholder<class_SceneState_method_get_node_instance_placeholder>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringName<class_StringName>` | :ref:`get_node_name<class_SceneState_method_get_node_name>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_NodePath>` | :ref:`get_node_owner_path<class_SceneState_method_get_node_owner_path>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_NodePath>` | :ref:`get_node_path<class_SceneState_method_get_node_path>`\ (\ idx\: :ref:`int<class_int>`, for_parent\: :ref:`bool<class_bool>` = false\ ) |const| |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_node_property_count<class_SceneState_method_get_node_property_count>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringName<class_StringName>` | :ref:`get_node_property_name<class_SceneState_method_get_node_property_name>`\ (\ idx\: :ref:`int<class_int>`, prop_idx\: :ref:`int<class_int>`\ ) |const| |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>` | :ref:`get_node_property_value<class_SceneState_method_get_node_property_value>`\ (\ idx\: :ref:`int<class_int>`, prop_idx\: :ref:`int<class_int>`\ ) |const| |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringName<class_StringName>` | :ref:`get_node_type<class_SceneState_method_get_node_type>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_path<class_SceneState_method_get_path>`\ (\ ) |const| |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_node_instance_placeholder<class_SceneState_method_is_node_instance_placeholder>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Énumérations
------------------------
.. _enum_SceneState_GenEditState:
.. rst-class:: classref-enumeration
enum **GenEditState**: :ref:`🔗<enum_SceneState_GenEditState>`
.. _class_SceneState_constant_GEN_EDIT_STATE_DISABLED:
.. rst-class:: classref-enumeration-constant
:ref:`GenEditState<enum_SceneState_GenEditState>` **GEN_EDIT_STATE_DISABLED** = ``0``
Si passé à :ref:`PackedScene.instantiate()<class_PackedScene_method_instantiate>`, bloque les modifications à l'état de la scène.
.. _class_SceneState_constant_GEN_EDIT_STATE_INSTANCE:
.. rst-class:: classref-enumeration-constant
:ref:`GenEditState<enum_SceneState_GenEditState>` **GEN_EDIT_STATE_INSTANCE** = ``1``
Si passé à :ref:`PackedScene.instantiate()<class_PackedScene_method_instantiate>`, fournit les ressources de la scène héritée à la scène locale.
\ **Note :** Seulement disponible dans les compilations d'éditeur.
.. _class_SceneState_constant_GEN_EDIT_STATE_MAIN:
.. rst-class:: classref-enumeration-constant
:ref:`GenEditState<enum_SceneState_GenEditState>` **GEN_EDIT_STATE_MAIN** = ``2``
If passed to :ref:`PackedScene.instantiate()<class_PackedScene_method_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.
.. _class_SceneState_constant_GEN_EDIT_STATE_MAIN_INHERITED:
.. rst-class:: classref-enumeration-constant
:ref:`GenEditState<enum_SceneState_GenEditState>` **GEN_EDIT_STATE_MAIN_INHERITED** = ``3``
S'il est passé à :ref:`PackedScene.instantiate()<class_PackedScene_method_instantiate>`, il est similaire à :ref:`GEN_EDIT_STATE_MAIN<class_SceneState_constant_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.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Descriptions des méthodes
--------------------------------------------------
.. _class_SceneState_method_get_base_scene_state:
.. rst-class:: classref-method
:ref:`SceneState<class_SceneState>` **get_base_scene_state**\ (\ ) |const| :ref:`🔗<class_SceneState_method_get_base_scene_state>`
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.
.. rst-class:: classref-item-separator
----
.. _class_SceneState_method_get_connection_binds:
.. rst-class:: classref-method
:ref:`Array<class_Array>` **get_connection_binds**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_SceneState_method_get_connection_binds>`
Renvoie la liste des paramètres liés pour le signal à l'index ``idx``.
.. rst-class:: classref-item-separator
----
.. _class_SceneState_method_get_connection_count:
.. rst-class:: classref-method
:ref:`int<class_int>` **get_connection_count**\ (\ ) |const| :ref:`🔗<class_SceneState_method_get_connection_count>`
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]``.
.. rst-class:: classref-item-separator
----
.. _class_SceneState_method_get_connection_flags:
.. rst-class:: classref-method
:ref:`int<class_int>` **get_connection_flags**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_SceneState_method_get_connection_flags>`
Renvoie les drapeaux de connexion pour le signal à l'index ``idx``. Voir les constantes :ref:`ConnectFlags<enum_Object_ConnectFlags>`.
.. rst-class:: classref-item-separator
----
.. _class_SceneState_method_get_connection_method:
.. rst-class:: classref-method
:ref:`StringName<class_StringName>` **get_connection_method**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_SceneState_method_get_connection_method>`
Renvoie la méthode connectée au signal à l'index ``idx``.
.. rst-class:: classref-item-separator
----
.. _class_SceneState_method_get_connection_signal:
.. rst-class:: classref-method
:ref:`StringName<class_StringName>` **get_connection_signal**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_SceneState_method_get_connection_signal>`
Renvoie le nom du signal à l'index ``idx``.
.. rst-class:: classref-item-separator
----
.. _class_SceneState_method_get_connection_source:
.. rst-class:: classref-method
:ref:`NodePath<class_NodePath>` **get_connection_source**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_SceneState_method_get_connection_source>`
Renvoie le chemin vers le nœud qui possède le signal à l'index ``idx``, relatif au nœud racine.
.. rst-class:: classref-item-separator
----
.. _class_SceneState_method_get_connection_target:
.. rst-class:: classref-method
:ref:`NodePath<class_NodePath>` **get_connection_target**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_SceneState_method_get_connection_target>`
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.
.. rst-class:: classref-item-separator
----
.. _class_SceneState_method_get_connection_unbinds:
.. rst-class:: classref-method
:ref:`int<class_int>` **get_connection_unbinds**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_SceneState_method_get_connection_unbinds>`
Renvoie le nombre de paramètres non liés pour le signal à l'index ``idx``.
.. rst-class:: classref-item-separator
----
.. _class_SceneState_method_get_node_count:
.. rst-class:: classref-method
:ref:`int<class_int>` **get_node_count**\ (\ ) |const| :ref:`🔗<class_SceneState_method_get_node_count>`
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]``.
.. rst-class:: classref-item-separator
----
.. _class_SceneState_method_get_node_groups:
.. rst-class:: classref-method
:ref:`PackedStringArray<class_PackedStringArray>` **get_node_groups**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_SceneState_method_get_node_groups>`
Renvoie la liste des noms de groupe associés avec le nœud à l'index ``idx``.
.. rst-class:: classref-item-separator
----
.. _class_SceneState_method_get_node_index:
.. rst-class:: classref-method
:ref:`int<class_int>` **get_node_index**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_SceneState_method_get_node_index>`
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.
.. rst-class:: classref-item-separator
----
.. _class_SceneState_method_get_node_instance:
.. rst-class:: classref-method
:ref:`PackedScene<class_PackedScene>` **get_node_instance**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_SceneState_method_get_node_instance>`
Renvoie une :ref:`PackedScene<class_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.
.. rst-class:: classref-item-separator
----
.. _class_SceneState_method_get_node_instance_placeholder:
.. rst-class:: classref-method
:ref:`String<class_String>` **get_node_instance_placeholder**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_SceneState_method_get_node_instance_placeholder>`
Renvoie le chemin vers le fichier de scène représenté si le nœud à l'index ``idx`` est un :ref:`InstancePlaceholder<class_InstancePlaceholder>`.
.. rst-class:: classref-item-separator
----
.. _class_SceneState_method_get_node_name:
.. rst-class:: classref-method
:ref:`StringName<class_StringName>` **get_node_name**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_SceneState_method_get_node_name>`
Renvoie le nom du nœud à l'index ``idx``.
.. rst-class:: classref-item-separator
----
.. _class_SceneState_method_get_node_owner_path:
.. rst-class:: classref-method
:ref:`NodePath<class_NodePath>` **get_node_owner_path**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_SceneState_method_get_node_owner_path>`
Renvoie le chemin vers le propriétaire du nœud à l'index ``idx``, par rapport au nœud racine.
.. rst-class:: classref-item-separator
----
.. _class_SceneState_method_get_node_path:
.. rst-class:: classref-method
:ref:`NodePath<class_NodePath>` **get_node_path**\ (\ idx\: :ref:`int<class_int>`, for_parent\: :ref:`bool<class_bool>` = false\ ) |const| :ref:`🔗<class_SceneState_method_get_node_path>`
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.
.. rst-class:: classref-item-separator
----
.. _class_SceneState_method_get_node_property_count:
.. rst-class:: classref-method
:ref:`int<class_int>` **get_node_property_count**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_SceneState_method_get_node_property_count>`
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]``.
.. rst-class:: classref-item-separator
----
.. _class_SceneState_method_get_node_property_name:
.. rst-class:: classref-method
:ref:`StringName<class_StringName>` **get_node_property_name**\ (\ idx\: :ref:`int<class_int>`, prop_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_SceneState_method_get_node_property_name>`
Renvoie le nom de la propriété à l'index ``prop_idx`` pour le nœud à l'index ``idx``.
.. rst-class:: classref-item-separator
----
.. _class_SceneState_method_get_node_property_value:
.. rst-class:: classref-method
:ref:`Variant<class_Variant>` **get_node_property_value**\ (\ idx\: :ref:`int<class_int>`, prop_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_SceneState_method_get_node_property_value>`
Renvoie la valeur de la propriété à l'index ``prop_idx`` pour le nœud à l'index ``idx``.
.. rst-class:: classref-item-separator
----
.. _class_SceneState_method_get_node_type:
.. rst-class:: classref-method
:ref:`StringName<class_StringName>` **get_node_type**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_SceneState_method_get_node_type>`
Renvoie le type du nœud à l'index ``idx``.
.. rst-class:: classref-item-separator
----
.. _class_SceneState_method_get_path:
.. rst-class:: classref-method
:ref:`String<class_String>` **get_path**\ (\ ) |const| :ref:`🔗<class_SceneState_method_get_path>`
Renvoie le chemin de ressource vers la :ref:`PackedScene<class_PackedScene>` représentée.
.. rst-class:: classref-item-separator
----
.. _class_SceneState_method_is_node_instance_placeholder:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_node_instance_placeholder**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_SceneState_method_is_node_instance_placeholder>`
Renvoie ``true`` si le nœud à l'index ``idx`` est un :ref:`InstancePlaceholder<class_InstancePlaceholder>`.
.. |virtual| replace:: :abbr:`virtual (Cette méthode doit typiquement être redéfinie par l'utilisateur pour avoir un effet.)`
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
.. |const| replace:: :abbr:`const (Cette méthode n'a pas d'effets de bord. Elle ne modifie aucune des variables membres de l'instance.)`
.. |vararg| replace:: :abbr:`vararg (Cette méthode accepte n'importe quel nombre d'arguments après ceux décris ici.)`
.. |constructor| replace:: :abbr:`constructor (Cette méthode est utilisée pour construire un type.)`
.. |static| replace:: :abbr:`static (Cette méthode n'a pas besoin d'instance pour être appelée, elle peut donc être directement appelée en utilisant le nom de la classe.)`
.. |operator| replace:: :abbr:`operator (Cette méthode décrit un opérateur valide à utiliser avec ce type en tant qu'opérande gauche.)`
.. |bitfield| replace:: :abbr:`BitField (Cette valeur est un nombre entier composé d'un masque de bits des options suivantes.)`
.. |void| replace:: :abbr:`void (Aucune valeur de retour.)`
Reference in New Issue View Git Blame Copy Permalink