**DockWidgetPluginGui** est un `Class.PluginGui` qui affiche son contenu
à l'intérieur d'une fenêtre dockable de Roblox Studio. Il est utilisé pour créer des widgets similaires
aux **Animation Editor** et **Terrain Tools** intégrés.

Cette interface graphique peut être créée en utilisant `Class.Plugin:CreateDockWidgetPluginGuiAsync()`.


DockWidgetPluginGui

Décrit si l'état précédent de ce `Class.DockWidgetPluginGui`
a été rétabli lors de sa création.

DockWidgetPluginGui.HostWidgetWasRestored

Décrit si l'état précédent de ce DockWidgetPluginGui a été
rétabli lors de sa création.

PluginGui est une classe abstraite pour les interfaces graphiques (GUIs) qui permettent l'affichage de
`Class.GuiObject|GuiObjects` dans divers widgets de Roblox Studio. Actuellement,
le seul type de PluginGui disponible est `Class.DockWidgetPluginGui`, mais
il pourrait y en avoir d'autres à l'avenir!

Cet exemple de code crée deux fenêtres de widget de plugin : une source de glisser et une cible de dépôt. Dans la fenêtre source, le script crée un `Class.TextBox` et `Class.TextButton` pour permettre à l'utilisateur de commencer une action de glisser de plugin. La fenêtre de cible de dépôt affichera le type MIME de tout ce qui y est glissé. Si le type MIME est `text/plain`, il affichera plutôt les données en texte brut.

Pour exécuter cet exemple de code en tant que plugin, collez-le dans un `Class.Script`. Ensuite, faites un clic droit sur le script dans la fenêtre **Explorer** et choisissez **Enregistrer en tant que Plugin Local**.


**PluginDragDropped** se déclenche lorsque l'utilisateur relâche sa souris sur un
`Class.PluginGui` lors d'une opération de glisser-déposer commencée par
`Class.Plugin:StartDrag()`.

Voir aussi :

- `Class.PluginGui.PluginDragEntered`
- `Class.PluginGui.PluginDragLeft`
- `Class.PluginGui.PluginDragMoved`

PluginGui.PluginDragDropped

dragData

Se déclenche lorsque l'utilisateur relâche sa souris en survolant un PluginGui
lors d'une opération de glisser-déposer commencée par `Class.Plugin:StartDrag()`.

**PluginDragEntered** se déclenche lorsque la souris de l'utilisateur entre dans le
`Class.PluginGui` lors d'une opération de glisser-déposer commencée par
`Class.Plugin:StartDrag()`.

Cet événement est utile pour afficher une interface "Déposer ici" sur les PluginGuis où une
opération de glisser-déposer peut être déposée. Une telle interface doit être cachée lorsque
`Class.PluginGui.PluginDragLeft|PluginDragLeft` ou
`Class.PluginGui.PluginDragDropped|PluginDragDropped` se déclenchent.

Voir aussi :

- `Class.PluginGui.PluginDragLeft`
- `Class.PluginGui.PluginDragMoved`
- `Class.PluginGui.PluginDragDropped`

PluginGui.PluginDragEntered

Une copie des données initialement passées à `Class.Plugin:StartDrag()`.

Se déclenche lorsque la souris de l'utilisateur entre dans un PluginGui lors d'une opération de glisser-déposer
commencée par `Class.Plugin:StartDrag()`.

**PluginDragLeft** se déclenche lorsque la souris de l'utilisateur quitte un `Class.PluginGui`
lors d'une opération de glisser-déposer commencée par `Class.Plugin:StartDrag()`.

Cet événement et `Class.PluginGui.PluginDragDropped|PluginDragDropped` sont
utiles pour cacher une interface "Déposer ici" sur les PluginGuis où une opération de glisser-déposer
peut être déposée. Une telle interface doit être affichée lorsque
`Class.PluginGui.PluginDragEntered|PluginDragEntered` se déclenche.

Voir aussi :

- `Class.PluginGui.PluginDragEntered`
- `Class.PluginGui.PluginDragMoved`
- `Class.PluginGui.PluginDragDropped`

PluginGui.PluginDragLeft

Se déclenche lorsque la souris de l'utilisateur quitte un PluginGui lors d'une opération de glisser-déposer
commencée par `Class.Plugin:StartDrag()`.

**PluginDragMoved** se déclenche lorsque la souris de l'utilisateur se déplace à l'intérieur d'un
`Class.PluginGui` lors d'une opération de glisser-déposer commencée par
`Class.Plugin:StartDrag()`.

Voir aussi :

- `Class.PluginGui.PluginDragEntered`
- `Class.PluginGui.PluginDragLeft`
- `Class.PluginGui.PluginDragDropped`

PluginGui.PluginDragMoved

Se déclenche lorsque la souris de l'utilisateur se déplace à l'intérieur d'un PluginGui lors d'une opération
de glisser-déposer commencée par `Class.Plugin:StartDrag()`.

Cet exemple de code démontre comment l'état de mise au point d'un `PluginGui` peut être
suivi en utilisant les événements `Class.PluginGui.WindowFocused|WindowFocused()` et
`Class.PluginGui.WindowFocusReleased|WindowFocusReleased()`. Il change
le `Class.PluginGui.Title|Title()` à mesure que l'état de mise au point change.

**WindowFocused** se déclenche immédiatement lorsque l'utilisateur commence à interagir avec
la fenêtre du PluginGui, généralement en cliquant dessus. Cette fonction
fonctionne de manière similaire à l'événement `Class.UserInputService.WindowFocused`
qui porte un nom similaire. Elle se déclenche avant tout événement `Class.GuiObject.InputBegan`
avant les boutons de la souris.

Si un autre `Class.PluginGui` est au premier plan et que l'utilisateur met ce
PluginGui au premier plan, cet événement se déclenche après l'événement de
l'autre `Class.PluginGui.WindowFocusReleased|WindowFocusReleased`. Cependant,
si la fenêtre principale de jeu était au premier plan, cet événement se déclenche **après**
`Class.UserInputService.WindowFocusReleased`.

PluginGui.WindowFocused

Se déclenche lorsque l'utilisateur commence à interagir avec la fenêtre du PluginGui.

**WindowFocusReleased** se déclenche immédiatement lorsque l'utilisateur cesse d'interagir
avec la fenêtre du PluginGui, généralement en cliquant sur quelque chose qui n'est pas dans la
fenêtre. Cette fonction fonctionne de manière similaire à l'événement
`Class.UserInputService.WindowFocusReleased` qui porte un nom similaire.

Si le focus passe à un autre `Class.PluginGui` pendant que l'utilisateur avait ce
PluginGui au premier plan, alors cet événement se déclenche avant l'événement de
l'autre `Class.PluginGui.WindowFocused|WindowFocused`. Cependant, si la fenêtre
de jeu principale est mise au premier plan, cet événement se déclenche **après**
`Class.UserInputService.WindowFocused`.

PluginGui.WindowFocusReleased

Se déclenche lorsque l'utilisateur cesse d'interagir avec la fenêtre du PluginGui.

Cette fonction lie une fonction au bouton de fermeture de `Class.PluginGui`,
surpasse le comportement par défaut.

Par défaut, lorsque l'utilisateur clique sur le bouton 'x' dans le coin supérieur droit de
the `Class.PluginGui`, la propriété `Class.LayerCollector.Enabled|Enabled`
est réglée sur _false_, fermant la fenêtre. Lorsqu'une fonction personnalisée est liée
à l'aide de BindToClose, ce comportement est écrasé, vous permettant de vérifier si
l'utilisateur veut vraiment fermer la fenêtre ou de lui donner l'occasion de
sauvegarder son travail.

Comme le comportement de fermeture par défaut est écrasé par cette fonction, vous
devez configurer le `Class.PluginGui` pour fermer manuellement en définissant
`Class.LayerCollector.Enabled|PluginGui.Enabled` sur _false_. Par exemple,
dans l'extrait ci-dessous, les utilisateurs doivent cliquer sur un bouton de confirmation pour fermer
le GUI :

```lua
local closing = false
pluginGui:BindToClose(function()
	-- assurez-vous de ne pas avoir déjà créé un bouton
	if closing then
		return
	end
	closing = true

	-- créer un bouton de confirmation
	local confirmButton = Instance.new("TextButton")
	confirmButton.AnchorPoint = Vector2.new(0.5, 0.5)
	confirmButton.Size = UDim2.new(0.5, 0, 0.5, 0)
	confirmButton.Position = UDim2.new(0.5, 0, 0.5, 0)
	confirmButton.BackgroundColor3 = Color3.new(1, 0, 0)
	confirmButton.Text = "Fermer ?"
	confirmButton.Parent = pluginGui

	-- écouter le clic
	confirmButton.Activated:Connect(function()
		-- fermer le gui
		pluginGui.Enabled = false

		-- supprimer le bouton de confirmation
		confirmButton:Destroy()
	end)
end)
```
Vous pouvez appeler BindToClose sans argument pour 'débind' et revenir au
comportement par défaut décrit ci-dessus. Par exemple :

```lua
pluginGui:BindToClose()
```
Voir aussi :

- `Class.Plugin:CreateDockWidgetPluginGuiAsync()` pour créer un
  `Class.PluginGui`
- `Class.DataModel:BindToClose()`, qui peut être utilisé pour lier une fonction à
  la fin du jeu et ne doit pas être confondu avec cette fonction


PluginGui:BindToClose

function

La fonction à lier au bouton de fermeture. Si aucune fonction n'est spécifiée,
la fonction précédemment spécifiée sera déliée.

Lie une fonction au bouton de fermeture du `Class.PluginGui`, remplaçant le\ Comportement par défaut.

GetRelativeMousePosition renvoie la position de la souris par rapport au coin supérieur gauche de la
`Class.PluginGui`. La valeur renvoyée change seulement
si une entrée de souris commence sur le PluginGui, ou si la souris survole actuellement
la fenêtre.

PluginGui:GetRelativeMousePosition

La position de l'écran de la souris par rapport au PluginGui en pixels.

Renvoie la position de la souris par rapport au PluginGui.

PluginGui

Le titre qui est affiché au-dessus du contenu du `Class.PluginGui`.
Par défaut, il est une chaîne vide.

PluginGui.Title

Le titre qui est affiché au-dessus du contenu du `Class.PluginGui`.

**LayerCollector** est la classe de base des conteneurs UI 2D qui rendent
les descendants de `Class.GuiObject`, comme `Class.ScreenGui`.

Pour améliorer les performances, l'apparence d'un `Class.LayerCollector` est
mise en cache jusqu'à ce qu'un des événements suivants se produise :

- Un descendant est ajouté ou retiré.
- Une propriété d'un descendant change.
- Une propriété du `Class.LayerCollector` lui-même change.

LayerCollector:GetLayoutNodeTree

LayerCollector

Active ou désactive la visibilité de ce `Class.LayerCollector`. Lorsque `false`, le
contenu de l'UI ne sera pas rendu, ne traitera pas les entrées utilisateur, ou ne se mettra pas à jour en réponse aux
changements.

LayerCollector.Enabled

Active ou désactive la visibilité de ce `Class.LayerCollector`.

Lorsqu'il est défini sur `false` et que ce `Class.LayerCollector` est un enfant direct de
`Class.StarterGui`, il sera seulement copié dans le `Class.PlayerGui` de chaque joueur
une fois et il ne sera pas supprimé lorsque le personnage du joueur
réapparaît.

Lorsqu'il est défini sur `true` (par défaut), ou si ce `Class.LayerCollector` est un
**descendant** **indirect** de `Class.StarterGui`, il sera copié dans le `Class.PlayerGui`
de chaque joueur lorsque leur personnage réapparaît, et il se supprimera lorsqu'un
nouveau personnage du joueur réapparaît.

LayerCollector.ResetOnSpawn

Détermine si le `Class.LayerCollector` se réinitialise (supprime lui-même et
se recopie dans le `Class.PlayerGui` du joueur) chaque fois que le personnage du joueur
réapparaît.

Contrôle le comportement de `Class.GuiObject.ZIndex` sur tous les descendants de ce
`Class.LayerCollector`.

Avec `Enum.ZIndexBehavior.Sibling` (par défaut), les enfants s'affichent toujours au-dessus
de leurs parents, et le `Class.GuiObject.ZIndex|ZIndex` est utilisé pour décider
de l'ordre dans lequel les enfants d'un seul objet UI s'afficheront les uns
par rapport aux autres.

`Enum.ZIndexBehavior.Global` trie tous les descendants selon le
`Class.GuiObject.ZIndex|ZIndex`, puis résout les égalités en utilisant l'ordre
hiérarchique. Par conséquent, les descendants d'un `Class.GuiObject` doivent avoir un
valeur de `Class.GuiObject.ZIndex|ZIndex` au moins aussi élevée que celle de
leur parent, sinon ils s'afficheront en dessous de leur parent.


LayerCollector.ZIndexBehavior

Contrôle le comportement de `Class.GuiObject.ZIndex` sur tous les descendants de ce
`Class.LayerCollector`.


La classe de base des conteneurs UI 2D qui rendent des `Class.GuiObject|GuiObjects`
par niveaux.

`Class.GuiBase2d` est une classe abstraite héritée par 2D
`Class.GuiObject|GuiObjects`.

Cet événement se déclenche lorsque la sélection du gamepad passe à, sort de, ou change
au sein du `Class.GuiBase2d` connecté ou de tout descendant
`Class.GuiObject|GuiObjects`. Lorsque le surlignage de sélection se déplace vers un
`Class.GuiObject`, l'événement remonte de ce `Class.GuiObject` à tous ses ancêtres, leur
informant que la sélection a changé/est entrée/a quitté un `Class.GuiObject` dans leur
arbre descendant.

GuiBase2d.SelectionChanged

amISelected

Vrai si la nouvelle sélection correspond au GuiBase2d attaché.

previousSelection

newSelection

Se déclenche lorsque la sélection du gamepad passe à, sort de, ou change au sein du
`Class.GuiBase2d` connecté ou de tout descendant
`Class.GuiObject|GuiObjects`.

GuiBase2d

`Class.GuiBase2d.AbsolutePosition|AbsolutePosition` est une propriété en lecture seule
qui fournit la position à l'écran d'un élément `Class.GuiBase2d`
en pixels. Cela représente la position pixel réelle à laquelle un élément
se rend comme résultat des tailles et positions de ses ancêtres. Notez que
`Class.GuiBase2d.AbsolutePosition|AbsolutePosition` représente toujours le
coin supérieur gauche de l'élément `Class.GuiBase2d`.

Si le `Class.GuiBase2d` est dans un `Class.ScreenGui`, la
propriété `Class.GuiBase2d.AbsolutePosition|AbsolutePosition` utilise le
système de coordonnées du viewport `Enum.ScreenInsets|CoreUISafeInsets`. L'origine de ce
système de coordonnées est située dans le coin inférieur gauche de
la barre supérieure de Roblox. Notez que c'est le même système de
coordonnées utilisé par la propriété `Class.InputObject.Position`.

<img src="/assets/engine-api/classes/GuiBase2d/AbsolutePositionCoordinateSystem.png" width="840" alt="Diagramme montrant l'origine du système de coordonnées AbsolutePosition." />

Voir aussi `Class.GuiBase2d.AbsoluteRotation|AbsoluteRotation` et
`Class.GuiBase2d.AbsoluteSize|AbsoluteSize`.

GuiBase2d.AbsolutePosition

Décrit la position réelle à l'écran d'un élément `Class.GuiBase2d`, en
pixels.

`Class.GuiBase2d.AbsoluteRotation|AbsoluteRotation` est une propriété en lecture seule
qui décrit la rotation réelle à l'écran d'un élément `Class.GuiBase2d`, en degrés. Elle ne
fait **pas** de vérification de limites, donc sa valeur
peut ne pas être dans la plage `0` à `360`.

Voir aussi `Class.GuiBase2d.AbsolutePosition|AbsolutePosition` et
`Class.GuiBase2d.AbsoluteSize|AbsoluteSize`.

GuiBase2d.AbsoluteRotation

Décrit la rotation réelle à l'écran d'un élément `Class.GuiBase2d`, en
dégrees.

`Class.GuiBase2d.AbsoluteSize|AbsoluteSize` est une propriété en lecture seule qui
décrit la taille réelle à l'écran d'un élément `Class.GuiBase2d`, en
pixels.

Voir aussi `Class.GuiBase2d.AbsolutePosition|AbsolutePosition` et
`Class.GuiBase2d.AbsoluteRotation|AbsoluteRotation`.

GuiBase2d.AbsoluteSize

Décrit la taille réelle à l'écran d'un élément `Class.GuiBase2d`, en
pixels.

Lorsqu'il est défini sur `true`, la localisation sera appliquée à ce `Class.GuiBase2d`
et ses descendants. Les entrées utilisées pour la localisation sont le même ensemble d'
entrées retournées par `Class.LocalizationService:GetTableEntries()`. Les entrées
avec `Class.GuiBase2d.AutoLocalize|AutoLocalize` activé sont automatiquement
re-traduites après le chargement de la table cloud si nécessaire.

Voir aussi `Class.GuiBase2d.RootLocalizationTable|RootLocalizationTable`.

GuiBase2d.AutoLocalize

Lorsqu'il est défini sur `true`, la localisation sera appliquée à ce `Class.GuiBase2d`
et ses descendants.

Cette propriété est automatiquement définie sur vrai lorsqu'une table de localisation
`Class.LocalizationTable.Root` cible cet objet, ou un ancêtre de cet
objet. `Class.LocalizationTable|LocalizationTables` avec leur
propriété `Class.LocalizationTable.Root` pointant vers une instance
localisera tous les `Class.TextLabel.TextButton` qui sont des descendants de la racine
instance.

GuiBase2d.Localize

Automatiquement défini sur vrai lorsqu'une table de localisation
`Class.LocalizationTable.Root` cible cet objet, ou un ancêtre de cet
objet.

Une référence à une `Class.LocalizationTable` à utiliser pour appliquer une
localisation automatisée à ce `Class.GuiBase2d` et ses descendants.
`Class.GuiBase2d.AutoLocalize|AutoLocalize` doit être défini sur `true` sur le
`Class.GuiBase2d` et ses ancêtres pour que la localisation automatisée soit
appliquée.

Vous pouvez définir cela pour référencer une `Class.LocalizationTable` n'importe où dans le
`Class.DataModel`. L'objet `Class.GuiBase2d` et tous ses enfants
essaieront d'utiliser cette `Class.LocalizationTable` spécifique et ses ancêtres
pour le remplacement automatique de texte avant d'utiliser les tables sous
`Class.LocalizationService` dans un ordre non défini et la table cloud.

S'il n'y a pas de traduction disponible dans la table référencée, elle cherchera
une traduction dans le parent de cette table, si c'est aussi une
`Class.LocalizationTable`, et ainsi de suite.

Voir aussi `Class.LocalizationService:GetTableEntries()` qui explique comment
le `Class.GuiBase2d.RootLocalizationTable|RootLocalizationTable` est utilisé
pour la localisation automatisée.

GuiBase2d.RootLocalizationTable

Une référence à une `Class.LocalizationTable` à utiliser pour appliquer une
localisation automatisée à ce `Class.GuiBase2d` et ses descendants.

Personnalise le comportement de sélection du gamepad dans la direction vers le bas.

GuiBase2d.SelectionBehaviorDown

Personnalise le comportement de sélection du gamepad dans la direction vers la gauche.

GuiBase2d.SelectionBehaviorLeft

Personnalise le comportement de sélection du gamepad dans la direction vers la droite.

GuiBase2d.SelectionBehaviorRight

Personnalise le comportement de sélection du gamepad dans la direction vers le haut.

GuiBase2d.SelectionBehaviorUp

Permet de personnaliser la manière dont la sélection du gamepad peut se déplacer entre
les boutons, qui sont des descendants du groupe de sélection, quitter le groupe,
et sélectionner d'autres boutons.

Définir `Class.GuiBase2d.SelectionGroup|SelectionGroup` sur `true` expose
les propriétés `Class.GuiBase2d.SelectionBehaviorUp|SelectionBehaviorUp`,
`Class.GuiBase2d.SelectionBehaviorDown|SelectionBehaviorDown`,
`Class.GuiBase2d.SelectionBehaviorLeft|SelectionBehaviorLeft`, et
`Class.GuiBase2d.SelectionBehaviorRight|SelectionBehaviorRight`.
Pour ces comportements de sélection, un paramètre de
`Enum.SelectionBehavior.Escape` (par défaut) signifie que la sélection du gamepad
essaie d'abord de trouver une sélection au sein du groupe de sélection et ne se déplace
à l'extérieur que si elle ne trouve pas de bouton approprié. Alternativement, un paramètre de
`Enum.SelectionBehavior.Stop` signifie que la sélection du gamepad ne regarde que dans
le groupe de sélection et ne se déplace pas en dehors du groupe dans la direction du
comportement de sélection.

GuiBase2d.SelectionGroup

Permet la personnalisation du mouvement de sélection du gamepad.

Une classe abstraite héritée par 2D `Class.GuiObject|GuiObjects`.

GuiBase est une classe abstraite dont la plupart des objets d'interface graphique
héritent.


GuiBase

`Instance` est la classe de base pour toutes les classes de la hiérarchie des classes Roblox
qui peuvent faire partie de l'arbre `Class.DataModel`.

Il n'est pas possible de créer directement des objets `Instance` racines, mais le constructeur spécial
`Datatype.Instance.new()` crée des objets via le code, prenant le
nom de la classe comme paramètre et retournant l'objet créé.

Démontre la détection des changements dans la descendance d'une instance en se connectant à l'événement
`Class.Instance.AncestryChanged`.

Le Parent de ChangingPart est défini sur différentes valeurs au fil du temps. Le parent de
la pièce est l'ancêtre de la pièce, donc l'événement `Class.Instance.AncestryChanged`
se déclenchera chaque fois qu'il change.


Déclenche lorsque cette instance est re-parentée ou lorsque l'un de ses
ancêtres est re-parenté.

Vous pouvez utiliser cet événement pour suivre la suppression d'une instance
dans Studio, comme une suppression manuelle dans l'Explorateur ou via un
plugin. Si vous devez détecter lorsqu'une instance est détruite à l'aide de
`Class.Instance:Destroy()`, utilisez plutôt l'événement `Class.Instance.Destroying`.

Instance.AncestryChanged

child

L'instance dont la propriété `Class.Instance.Parent|Parent` a changé,
qui peut être cette instance ou un ancêtre plus lointain, **pas**
nécessairement l'instance à laquelle le gestionnaire est connecté.

parent

Déclenche lorsqu'il y a un changement dans la propriété `Class.Instance.Parent`
de cet objet ou de l'un de ses ancêtres.

Cet événement déclenche chaque fois qu'un attribut est modifié sur l'instance,
notamment lorsque l'attribut est défini sur `nil`. Le nom de l'attribut modifié
est passé à la fonction connectée.

Par exemple, le snippet de code suivant connecte la fonction `attributeChanged()`
qui se déclenche chaque fois qu'un des attributs de la pièce change:

```lua
local Workspace = game:GetService("Workspace")

local part = Workspace.Part

local function attributeChanged(attributeName)
	print(attributeName, "modifié")
end

part.AttributeChanged:Connect(attributeChanged)
```
Voir aussi `Class.Instance:GetAttributeChangedSignal()` qui renvoie un
event qui se déclenche lorsqu'un attribut spécifique donné change.

Instance.AttributeChanged

attribute

Le nom de l'attribut qui a été modifié.

Déclenche chaque fois qu'un attribut est modifié sur la `Class.Instance`.

Ce fragment imprime les noms des objets lorsqu'ils sont ajoutés à l'espace de travail :

Déclenche après qu'un objet a été parenté à cette `Class.Instance`.

Notez que, lors de l'utilisation de cette méthode sur un client pour détecter des objets créés par le
serveur, il est nécessaire d'utiliser `Class.Instance:WaitForChild()` lors
de l'indexation des descendants de ces objets. Cela est dû au fait que l'objet et ses
descendants ne sont pas garantis d'être répliqués du serveur au client
simultanément. Par exemple:

```
local Workspace = game:GetService("Workspace")

Workspace.ChildAdded:Connect(function(child)
	-- Utilisez WaitForChild() car les descendants peuvent ne pas avoir encore été répliqués
	local head = child:WaitForChild("Head")
end)
```
Notez que cet événement ne fonctionne que pour les enfants immédiats de la
`Class.Instance`. Pour un événement qui capture tous les descendants, utilisez
`Class.Instance.DescendantAdded`.

Voir aussi `Class.Instance.ChildRemoved`.

Instance.ChildAdded

La `Class.Instance` qui a été ajoutée.

Déclenche après qu'un objet a été parenté à cette `Class.Instance`.

Instance.childAdded

Ce fragment imprime les noms des objets au fur et à mesure qu'ils sont retirés du
Workspace :

Déclenche après qu'un enfant a été supprimé de cette `Class.Instance`.

Supprimé fait référence au moment où le parent d'un objet est changé de
cette `Class.Instance` à autre chose que cette `Class.Instance`. Notez que cet\événement sera également déclenché lorsqu'un enfant est détruit (à l'aide de
`Class.Instance:Destroy()`) car la fonction de destruction définit le parent d'un objet
sur `nil`.

Cet événement ne fonctionne que pour les enfants immédiats de la `Class.Instance`.
Pour un événement qui capture tous les descendants, utilisez
`Class.Instance.DescendantRemoving`.

Voir aussi `Class.Instance.ChildAdded`.

Instance.ChildRemoved

La `Class.Instance` qui a été supprimée.

Déclenche après qu'un enfant a été supprimé de cette `Class.Instance`.

Cet exemple suivant affichera le nom de tout objet ajouté au
Espace de travail :

Cet événement se déclenche après qu'un descendant a été ajouté à la `Class.Instance`.

Comme il se déclenche pour chaque descendant, la parenté d'un objet à la
`Class.Instance` déclenchera l'événement pour cet objet et tous ses
descendants individuellement.

Si vous vous préoccupez uniquement des **enfants directs** de la
`Class.Instance`, utilisez `Class.Instance.ChildAdded` à la place.

Voir aussi `Class.Instance.DescendantRemoving`.

Instance.DescendantAdded

descendant

Déclenche après qu'un descendant a été ajouté à la `Class.Instance`.

L'exemple suivant affiche le nom de tout descendant au moment où il est supprimé
du Workspace :

Cet événement se déclenche **immédiatement avant** que le parent `Class.Instance`
change de sorte qu'une instance **descendante** ne soit plus un
descendant. `Class.Instance:Destroy()|Destroy()` change le `Class.Instance.Parent|Parent`
d'une instance en `nil`, donc appeler cette méthode sur un descendant du parent
déclenchera cet événement.

Puisque cet événement se déclenche **avant** la suppression du descendant, le parent du
descendant ne sera pas modifié au moment du déclenchement de cet événement. Si le
descendant est également un **enfant direct** du parent, cet événement se déclenchera
avant `Class.Instance.ChildRemoved`.

Si un descendant a des enfants, cet événement se déclenche d'abord avec le descendant,
puis avec ses descendants.

#### Avertissement

Cet événement se déclenche avec l'objet descendant qui est en cours de suppression.
Tenter de définir le `Class.Instance.Parent|Parent` du descendant sur autre chose échouera. Voici un exemple qui démontre cela:

```
local Workspace = game:GetService("Workspace")

Workspace.DescendantRemoving:Connect(function(descendant)
	-- Ne pas manipuler le parent du descendant dans cette fonction!
	-- Cet événement se déclenche PARCE QUE le parent a été manipulé, et le changement n'est pas encore arrivé
	-- Par conséquent, il est problématique de changer le parent de cette manière:
	descendant.Parent = game
end)

local part = Instance.new("Part")
part.Parent = Workspace
part.Parent = nil
```
Voir aussi `Class.Instance.DescendantAdded|DescendantAdded`.

Instance.DescendantRemoving

La `Class.Instance` qui est en cours de suppression.

Déclenche immédiatement avant qu'un descendant de la `Class.Instance` ne soit supprimé.

Cet exemple montre comment, lors de l'utilisation du comportement de signal immédiat, une
Instance étant détruite reste en place jusqu'à ce que la fonction connectée se mette en attente.


Cet exemple démontre comment, lors de l'utilisation du comportement de signal différé, une Instance
est détruite avant que le signal ne se déclenche.


La `Class.Instance` ne sera jamais supprimée de la mémoire tant qu'une fonction connectée
l'utilise encore. Cependant, si la fonction se met en pause à tout moment,
la `Class.Instance` et ses descendants seront parentés à `nil`.

Si la propriété `Class.Workspace.SignalBehavior` est définie sur
`Enum.SignalBehavior.Immediate`, cet événement se déclenche immédiatement avant que le
`Class.Instance` ou l'un de ses ancêtres soit détruit avec
`Class.Instance:Destroy()`.

Si la propriété `Class.Workspace.SignalBehavior` est définie sur
`Enum.SignalBehavior.Deferred`, cet événement se déclenche au prochain point de
ergonomie, qui sera après que le `Class.Instance` ou l'un de ses ancêtres soit
détruit avec `Class.Instance:Destroy()`.

Avec le comportement `Enum.SignalBehavior.Deferred|Deferred`, connecter un script à son propre événement `Class.Instance.Destroying` est problématique, car le script
sera détruit avant que le rappel puisse être appelé (ce qui signifie qu'il ne s'exécutera pas).

Lors de la suppression d'une `Class.Instance` dans Studio, comme la suppression manuelle
via l'[Explorateur](/studio/explorer) ou à travers un plugin,
la `Class.Instance` n'est pas détruite. Au lieu de cela, le parent est défini sur `nil`
ce que vous pouvez suivre avec `Class.Instance.AncestryChanged`.

Instance.Destroying

Déclenche immédiatement avant (ou est différé jusqu'après) que l'instance soit
détruite via `Class.Instance:Destroy()`.

Cet événement se déclenche chaque fois qu'une propriété de style est modifiée sur l'instance,
notamment lorsque l'attribut est défini sur `nil`.

```lua
local Players = game:GetService("Players")

local player = Players.LocalPlayer
local playerGui = player.PlayerGui
local HUDContainer = playerGui:WaitForChild("HUDContainer")
local meterBar = HUDContainer.MeterBar

local function stylePropertyChanged()
	print("Les propriétés de style ont changé")
end

meterBar:StyledPropertiesChanged():Connect(stylePropertyChanged)
```

Instance.StyledPropertiesChanged

Déclenche chaque fois qu'une propriété de style est modifiée sur l'instance, y compris
lorsqu'une propriété est définie sur `nil`.

Cette méthode applique une étiquette à l'instance, sans effet si l'étiquette est
déjà appliquée. L'ajout réussi d'une étiquette déclenchera un signal créé par
`Class.CollectionService:GetInstanceAddedSignal()` avec l'étiquette donnée.

#### Avertissements

- Les étiquettes d'une instance ajoutées côté client seront supprimées si le
  serveur ajoute ou supprime plus tard une étiquette sur cette instance car le serveur
  réplique toutes les étiquettes ensemble et écrase les étiquettes précédentes.

- Lors de l'étiquetage d'une instance, il est courant que des ressources soient
  utilisées pour donner à l'étiquette sa fonctionnalité, par exemple des connexions d'événements ou des tables.
  Pour éviter les fuites de mémoire, il est bon de nettoyer cela (déconnecter,
  définir à `nil`, etc.) lorsque ce n'est plus nécessaire pour une étiquette. Faites le lorsque
  vous appelez `Class.Instance:RemoveTag()`, en appelant
  `Class.Instance:Destroy()` ou dans une fonction connectée à un signal
  renvoyé par `Class.CollectionService:GetInstanceRemovedSignal()`.

Instance:AddTag

La fonction enfants renvoie un tableau des enfants de l'objet.

Instance:children

Renvoie un tableau des enfants de l'objet.

Cette méthode détruit tous les enfants d'une instance ainsi que ses descendants.

```
local part = Instance.new("Part")

-- Ajouter des étincelles
for i = 1, 3 do
	local sparkles = Instance.new("Sparkles")
	sparkles.Parent = part

  local sc = Instance.new("Sparkles")
  sc.Parent = sparkles
end

print("Enfants:", #part:GetChildren())  --> Enfants: 3

part:ClearAllChildren()

print("Enfants:", #part:GetChildren())  --> Enfants: 0
```
Si vous ne souhaitez pas détruire **tous** les enfants et descendants, utilisez soit
`Class.Instance:GetChildren()` ou `Class.Instance:GetDescendants()` pour
parcourir ces enfants/descendants et sélectionner ceux à détruire. Par
exemple, l'échantillon de code suivant détruira tous les
`Class.BasePart|BaseParts` descendant d'un `Class.Model`:

```
local Workspace = game:GetService("Workspace")

local model = Workspace:FindFirstChild("TestModel")

for _, descendant in model:GetDescendants() do
	if descendant:IsA("BasePart") then
		descendant:Destroy()
	end
end
```

Instance:ClearAllChildren

Cette méthode détruit tous les enfants d'une instance.

Démontre le clonage d'un modèle en utilisant `Class.Instance:Clone()`.

`Clone()` crée une copie d'une instance et de tous ses descendants,
ignorant toutes les instances qui ne sont pas
`Class.Instance.Archivable|Archivable`. La copie de l'instance racine est
renvoyée par cette méthode et son `Class.Instance.Parent|Parent` est défini sur
`nil`. Notez que si l'instance elle-même a
`Class.Instance.Archivable|Archivable` défini sur `false`, cette méthode renverra
`nil`.

Si une propriété de référence telle que `Class.ObjectValue.Value` est définie dans une
instance clonée, la valeur de la propriété de la copie dépendra de la
valeur d'origine :

- Si une propriété de référence fait référence à une instance qui a également été clonée,
  la copie fera référence à la copie.
- Si une propriété de référence fait référence à une instance qui n'a **pas** été clonée,
  la même valeur est maintenue dans la copie.

Instance:Clone

Crée une copie d'une instance et de tous ses descendants, en ignorant les instances
qui ne sont pas `Class.Instance.Archivable|Archivable`.

Instance:clone

Démontre la destruction d'une Partie en utilisant la fonction `Class.Instance:Destroy()`.

Cette fonction est la manière correcte de se débarrasser des objets qui ne sont plus
nécessaires.


Définit la propriété `Class.Instance.Parent` à `nil`, verrouille la
propriété `Class.Instance.Parent`, déconnecte toutes les connexions, et appelle
`Destroy()` sur tous les enfants. Cette méthode est la bonne façon de se débarrasser des
objets qui ne sont plus nécessaires.

Se débarrasser des objets inutiles est important, car des objets et des
connexions inutiles dans un endroit utilisent de la mémoire, ce qui peut
entraîner de graves problèmes de performance dans le temps.

En tant que meilleure pratique, après avoir appelé `Destroy()` sur un objet, définissez toute
variable faisant référence à l'objet (ou à ses descendants) à `nil`. Cela
empêche votre code d'accéder à quoi que ce soit lié à l'objet.

```lua
local part = Instance.new("Part")
part.Name = "Hello, world"
part:Destroy()
-- Ne pas faire cela :
print(part.Name)  --> "Hello, world"
-- Faites cela pour empêcher la ligne ci-dessus de fonctionner :
part = nil
```
Une fois qu'un `Class.Instance` a été détruit par cette méthode, il ne peut pas être
réutilisé car la propriété `Class.Instance.Parent` est verrouillée. Pour
**supprimer temporairement** un objet au lieu de le détruire, définissez
`Class.Instance.Parent|Parent` à `nil`. Par exemple :

```
local Workspace = game:GetService("Workspace")

object.Parent = nil
task.wait(2)
object.Parent = Workspace
```
Pour détruire un objet après un temps défini, utilisez
`Class.Debris:AddItem()`.

Instance:Destroy

Définit la propriété `Class.Instance.Parent` à `nil`, verrouille la
propriété `Class.Instance.Parent`, déconnecte toutes les connexions, et appelle
`Destroy()` sur tous les enfants.

Instance:destroy

Renvoie le premier ancêtre de l'`Class.Instance` dont
`Class.Instance.Name` est égal au nom donné.

Cette méthode fonctionne vers le haut, ce qui signifie qu'elle commence par le `Class.Instance.Parent` immédiat
et remonte vers le `Class.DataModel`. Si aucun ancêtre correspondant n'est trouvé, elle renvoie `nil`.

L'extrait de code suivant trouverait le premier ancêtre de l'objet
nommé `Car`.

```
local car = object:FindFirstAncestor("Car")
```
Pour les variantes de cette méthode qui trouvent des ancêtres d'une classe spécifique,
voir `Class.Instance:FindFirstAncestorOfClass()` et
`Class.Instance:FindFirstAncestorWhichIsA()`.

Instance:FindFirstAncestor

name

Renvoie le premier ancêtre de l'`Class.Instance` dont
`Class.Instance.Name` est égal au nom donné.

Renvoie le premier ancêtre de l'`Class.Instance` dont
`Class.Object.ClassName` est égal au nom de classe donné.

Cette méthode fonctionne vers le haut, ce qui signifie qu'elle commence par le `Class.Instance.Parent` immédiat
et remonte vers le `Class.DataModel`. Si aucun ancêtre correspondant n'est trouvé, elle renvoie `nil`.

Une utilisation courante de cette méthode est de trouver le `Class.Model` auquel
un `Class.BasePart` appartient. Par exemple :

```
local model = part:FindFirstAncestorOfClass("Model")
```
Cette méthode est une variante de `Class.Instance:FindFirstAncestor()` qui
vérifie la propriété `Class.Object.ClassName` plutôt que
`Class.Instance.Name`. `Class.Instance:FindFirstAncestorWhichIsA()` existe également,
en utilisant la méthode `Class.Object:IsA()` à la place pour respecter l'héritage des classes.

Instance:FindFirstAncestorOfClass

className

Le `Class.Object.ClassName` à rechercher.

Renvoie le premier ancêtre de l'`Class.Instance` dont
`Class.Object.ClassName` est égal au nom de classe donné.

Renvoie le premier ancêtre de l'`Class.Instance` pour qui
`Class.Object:IsA()` renvoie vrai pour le nom de classe donné.

Cette méthode fonctionne vers le haut, ce qui signifie qu'elle commence par le `Class.Instance.Parent` immédiat
et remonte vers le `Class.DataModel`. Si aucun ancêtre correspondant n'est trouvé, elle renvoie `nil`.

Contrairement à `Class.Instance:FindFirstAncestorOfClass()`, cette méthode utilise
`Class.Object:IsA()` qui respecte l'héritage des classes. Par exemple :

```
print(part:IsA("Part"))  --> true
print(part:IsA("BasePart"))  --> true
print(part:IsA("Instance"))  --> true
```
Par conséquent, l'extrait de code suivant renverra le premier
ancêtre `Class.BasePart`, peu importe s'il s'agit d'un `Class.WedgePart`,
`Class.MeshPart` ou `Class.Part`.

```
local part = object:FindFirstAncestorWhichIsA("BasePart")
```
Voir aussi `Class.Instance:FindFirstAncestor()`.

Instance:FindFirstAncestorWhichIsA

Renvoie le premier ancêtre de l'`Class.Instance` pour qui
`Class.Object:IsA()` renvoie vrai pour le nom de classe donné.

Le code ci-dessous cherchera dans Workspace un objet nommé "Brick". S'il est trouvé, il changera le nom de l'objet en "Foo".

Renvoie le premier enfant de l'`Class.Instance` avec le nom donné, ou
`nil` si aucun enfant de ce type n'existe. Si l'argument optionnel `recursive` est
`true`, cette méthode recherche tous les descendants plutôt que seulement les
enfants immédiats de l'`Class.Instance`.

#### Vérification de l'existence d'un objet

`FindFirstChild()` est nécessaire si vous devez vérifier qu'un objet existe
avant de continuer. Essayer d'indexer un enfant par son nom en utilisant l'opérateur
point génère une erreur si l'enfant n'existe pas.

```lua
local Workspace = game:GetService("Workspace")

-- La ligne suivante génère une erreur si la partie n'existe pas dans l'espace de travail
Workspace.Part.Transparency = 0.5
```
Une meilleure approche est d'utiliser `FindFirstChild()` pour d'abord vérifier `Part`,
puis d'utiliser une instruction `if` pour exécuter le code qui en a besoin.

```lua
local Workspace = game:GetService("Workspace")

local part = Workspace:FindFirstChild("Part")
if part then
	part.Transparency = 0.5
end
```

#### Trouver un enfant dont le nom correspond à une propriété

Parfois, le `Class.Instance.Name|Name` d'un objet est le même que celui d'une
des propriétés de son `Class.Instance.Parent|Parent`. Lorsqu'on utilise l'opérateur point, les propriétés
dépassent les enfants s'ils ont le même nom.

Dans l'exemple suivant, un `Class.Folder` appelé `Color` est ajouté à un
`Class.Part`, qui a également la propriété `Class.Part.Color`. Remarquez que
`part.Color` fait référence à la valeur de la propriété `Datatype.Color3`, et non à l'instance de
l'enfant `Class.Folder`. Un avantage d'utiliser
`Class.Instance:FindFirstChild()|FindFirstChild()` est que l'introduction de nouvelles propriétés ne pose
pas de risque pour votre code.

```lua
local part = Instance.new("Part")
local folder = Instance.new("Folder")
folder.Name = "Color"
folder.Parent = part
local c1 = part.Color  -- La propriété
local c2 = part:FindFirstChild("Color")  -- Le dossier enfant
```

#### Remarques de performance

`Class.Instance:FindFirstChild()|FindFirstChild()` prend environ 20% plus de temps
que l'utilisation de l'opérateur point et presque 8 fois plus de temps que simplement stocker
une référence à un objet. Par conséquent, vous devriez éviter de l'appeler dans
un code dépendant de la performance tel que dans des boucles serrées ou des fonctions connectées
à `Class.RunService.Heartbeat` et `Class.RunService.PreRender`. Au lieu de cela,
stockez le résultat dans une variable, ou envisagez d'utiliser
`Class.Instance.ChildAdded|ChildAdded` ou
`Class.Instance:WaitForChild()|WaitForChild()` pour détecter quand un enfant d'un
donné nom devient disponible.

Instance:FindFirstChild

recursive

Si la recherche doit être effectuée récursivement ou non.

Renvoie le premier enfant de l'`Class.Instance` trouvé avec le nom donné.

Instance:findFirstChild

Renvoie le premier enfant de l'`Class.Instance` dont
`Class.Object.ClassName|ClassName` est égal au `className` donné.
Contrairement à `Class.Instance:FindFirstChildWhichIsA()`, cette méthode ne renvoie que
les objets dont la classe correspond à `className`, en ignorant l'héritage des classes. Si aucun
enfant correspondant n'est trouvé, cette méthode renvoie `nil`.

Instance:FindFirstChildOfClass

Renvoie le premier enfant de l'`Class.Instance` dont
`Class.Object.ClassName|ClassName` est égal au nom de classe donné.

Renvoie le premier enfant de l'`Class.Instance` pour qui
`Class.Object:IsA()` renvoie vrai pour le nom de classe donné.

Si aucun enfant correspondant n'est trouvé, cette méthode renvoie `nil`. Si l'argument
optionnel `recursive` est vrai, cette méthode recherche tous les descendants plutôt
que seulement les enfants immédiats de l'`Class.Instance`.

Contrairement à `Class.Instance:FindFirstChildOfClass()`, cette méthode utilise
`Class.Object:IsA()` qui respecte l'héritage des classes. Par exemple :

```lua
print(part:IsA("Part")) --> true
print(part:IsA("BasePart")) --> true
print(part:IsA("Instance")) --> true
```
Par conséquent, l'échantillon de code suivant renverra le premier
enfant `Class.BasePart`, peu importe s'il s'agit d'un `Class.WedgePart`,
`Class.MeshPart` ou `Class.Part`.

```
local part = object:FindFirstChildWhichIsA("BasePart")
```
Les développeurs cherchant un enfant par nom devraient utiliser
`Class.Instance:FindFirstChild()` à la place.

Instance:FindFirstChildWhichIsA

Renvoie le premier enfant de l'`Class.Instance` pour qui
`Class.Object:IsA()` renvoie vrai pour le nom de classe donné.

Renvoie le premier descendant trouvé avec le `Class.Instance.Name` donné.

Cette méthode est désactivée et ne peut pas être utilisée. Pour trouver le premier descendant
 d'une instance, envisagez d'utiliser le paramètre `recursive` sur
`Class.Instance:FindFirstChild()` à la place.

Instance:FindFirstDescendant

Renvoie le premier descendant trouvé avec le `Class.Instance.Name` donné.

Si l'`Class.Instance` est un `Class.Actor`, le `Class.Actor` lui-même est
renvoyé. Sinon, son plus proche ancêtre `Class.Actor` est renvoyé. Si aucun
ancêtre n'est un `Class.Actor`, le résultat est `nil`.

Instance:GetActor

Renvoie le `Class.Actor` associé à l'Instance, le cas échéant.

Cette méthode renvoie la valeur qui a été assignée au nom d'attribut donné. Si
aucun attribut n'a été assigné, `nil` est renvoyé.

Par exemple, l'extrait de code suivant définit et obtient ensuite la valeur de
l'attribut `InitialPosition` de l'instance :

```lua
local Workspace = game:GetService("Workspace")

local part = Workspace.Part
part:SetAttribute("InitialPosition", part.Position)

local initialPosition = instance:GetAttribute("InitialPosition")
print(initialPosition)
```

#### Voir aussi

- `Class.Instance:SetAttribute()` qui définit l'attribut avec le nom donné
a la valeur donnée.
- `Class.Instance:GetAttributes()` qui renvoie un dictionnaire de paires clé‑valeur
pour chacun des attributs de l'instance.

Instance:GetAttribute

La valeur qui a été assignée au nom d'attribut donné. Si aucun
attribut n'a été assigné, `nil` est renvoyé.

Renvoie la valeur qui a été assignée au nom d'attribut donné.

Cette méthode renvoie un événement qui se comporte exactement comme le
événement `Class.Object.Changed|Changed`, sauf qu'il ne se déclenche que lorsque l'
attribut donné change ; c'est effectivement similaire à
`Class.Object:GetPropertyChangedSignal()|GetPropertyChangedSignal()` mais
pour les attributs.

Il est généralement conseillé d'utiliser cette méthode plutôt qu'une connexion à
`Class.Object.Changed|Changed` avec une fonction qui vérifie le nom de l'attribut. Des appels subséquents à cette méthode sur le même objet avec le même
nom d'attribut renvoient le même événement.

L'exemple de code suivant renvoie un signal qui déclenchera la fonction
`attributeChanged()` lorsque l'attribut `InitialPosition` de la pièce change :

```lua
local Workspace = game:GetService("Workspace")

local part = Workspace.Part
part:SetAttribute("InitialPosition", part.Position)

local function attributeChanged()
	print("Attribut changé")
end

part:GetAttributeChangedSignal("InitialPosition"):Connect(attributeChanged)
```
Voir aussi `Class.Instance.AttributeChanged` qui se déclenche chaque fois qu'un
attribut est modifié sur l'instance.

Instance:GetAttributeChangedSignal

Le nom de l'attribut spécifié pour lequel le signal de changement est
renvoyé.

Un événement qui se déclenche lorsque l'attribut donné change.

Renvoie un événement qui se déclenche lorsque l'attribut donné change.

Cette méthode renvoie un dictionnaire de paires clé‑valeur pour chaque attribut
où la clé est le nom de l'attribut et la valeur est une valeur non‐`nil`.

Par exemple, l'extrait de code suivant affiche les attributs d'une instance
et leurs valeurs :

```lua
local Workspace = game:GetService("Workspace")

local part = Workspace.Part
part:SetAttribute("InitialPosition", part.Position)
part:SetAttribute("CanUse", true)

for name, value in part:GetAttributes() do
	print(name .. " = " .. value)
end
```
Voir aussi `Class.Instance:GetAttribute()` qui renvoie la valeur qui a été
assignée au nom d'attribut donné.

Instance:GetAttributes

Un dictionnaire de paires chaîne → variante pour chaque attribut où la
chaîne est le nom de l'attribut et la variante est une valeur non-nulle.

Renvoie un dictionnaire des attributs de l'instance.

Le code ci-dessous afficherait le nom de tous les objets actuellement dans Workspace lorsqu'il est exécuté.

Renvoie un tableau (une table indexée numériquement) contenant tous les
enfants directs de l'instance, ou chaque `Class.Instance` dont
`Class.Instance.Parent|Parent` est égal à l'objet. Le tableau peut être
itéré en utilisant soit une boucle numérique soit une boucle générique :

```lua
local Workspace = game:GetService("Workspace")

-- Exemple de boucle numérique
local children = Workspace:GetChildren()
for i = 1, #children do
	local child = children[i]
	print(child.Name .. " est enfant numéro " .. i)
end
```

```lua
local Workspace = game:GetService("Workspace")

-- Exemple de boucle générique
local children = Workspace:GetChildren()
for i, child in children do
	print(child.Name .. " est enfant numéro " .. i)
end
```
Notez que le tableau retourné n'est **pas** trié dans un ordre particulier, donc
le tri manuel (par exemple à l'aide de `Library.table.sort()`) est conseillé pour
trier les enfants renvoyés par cette méthode.

Voir aussi la méthode `Class.Instance:GetDescendants()|GetDescendants()`.

Instance:GetChildren

Renvoie un tableau contenant tous les enfants de l'instance.

Instance

`Instance` est la classe de base pour toutes les classes de la hiérarchie des classes Roblox
qui peuvent faire partie de l'arbre `Class.DataModel`.

/reference/engine/classes/DockWidgetPluginGui.yaml