AdGui.OnAdEvent

eventInfo

Table d'options pour la méthode :

- `PlayerId` – L'ID utilisateur du joueur lié à l'événement publicitaire.
- `AdEventType` – Une valeur d'énumération `Enum.AdEventType` décrivant les événements du AdGui
  .

Indique si le rappel a réagi avec succès à l'événement.

Utilisé pour réagir aux événements du AdGui.

`Class.AdGui` est un `Class.SurfaceGuiBase` qui rend des publicités d'affichage immersives sur une face du `Class.Part` auquel il est orné. Lorsqu'aucune publicité n'est disponible, il affiche l'`Class.AdGui.FallbackImage` fourni par le développeur, ou une image de secours par défaut de Roblox lorsque cette propriété est vide.

Pour afficher des publicités, le `Class.AdGui` doit être orné à un bloc `Class.Part` qui est un descendant de `Class.Workspace`, doit être la seule interface utilisateur de surface sur cette face, et doit avoir au moins la taille minimale éligible. Lorsque ces conditions ne sont pas remplies, l'objet affiche une image de remplacement dans la vue d'édition de Studio et ne rend rien dans une expérience en cours d'exécution.


AdGui

Détermine la forme de la publicité rendue par le `Class.AdGui`, y compris le rapport d'aspect de la création sur la surface de la pièce. Par défaut, c'est `Enum.AdShape|HorizontalRectangle`, qui est la seule forme servie à part le sentinelle `Enum.AdShape|Undefined`.


AdGui.AdShape

Détermine la forme de la publicité affichée par le `Class.AdGui`.


La propriété active le AdGui pour diffuser des publicités vidéo.

AdGui.EnableVideoAds

Active le AdGui pour diffuser des publicités vidéo.

Une image fournie par le développeur que le `Class.AdGui` affiche lorsqu'il n'a pas de publicité servie à rendre. Par défaut, c'est une chaîne de contenu vide ; tant qu'elle est vide, le `Class.AdGui` rend une image de secours par défaut de Roblox à la place.


AdGui.FallbackImage

L'image que le `Class.AdGui` affiche lorsqu'aucune publicité n'est disponible à servir.


Une propriété de type `Datatype.Content` qui contient l'image de secours que le `Class.AdGui` affiche lorsqu'aucune publicité servie n'est disponible. C'est le stockage de contenu pour `Class.AdGui.FallbackImage` (une chaîne `TextureId` héritée) ; écrire dans l'une ou l'autre propriété met à jour le même stockage sous-jacent. Contrairement à `FallbackImage`, cette propriété accepte les [URI d'actifs](/projects/assets#asset-uris) et les références aux objets `Class.EditableImage`. Lorsqu'elle est vide, le `Class.AdGui` rend une image de secours par défaut de Roblox à la place.


AdGui.FallbackImageContent

L'équivalent `Datatype.Content` de `Class.AdGui.FallbackImage` qui prend en charge les URI d'actifs et les objets `Class.EditableImage`.


Une propriété en lecture seule qui indique si le `Class.AdGui` affiche activement une publicité servie. C'est `Enum.AdUnitStatus|Active` lorsque le `Class.AdGui` rend du contenu publicitaire, et `Enum.AdUnitStatus|Inactive` sinon.


AdGui.Status

Indique si le `Class.AdGui` affiche actuellement une publicité servie.


Une interface utilisateur basée sur la surface qui affiche des publicités immersives sur une face d'un `Class.Part` dans le monde 3D.


`Class.SurfaceGuiBase` est la classe de base `Class.LayerCollector` pour les conteneurs
 qui rendent leurs descendants `Class.GuiObject` sur une face d'un
 `Class.BasePart` dans le monde 3D. `Class.SurfaceGui` et `Class.AdGui` en héritent.

La pièce cible est définie par la propriété `Class.SurfaceGuiBase.Adornee|Adornee`;
 si aucune adornee n'est spécifiée, le conteneur se rend sur son parent lorsque
 ce parent est un `Class.BasePart`. La propriété `Class.SurfaceGuiBase.Face|Face`
 sélectionne quelle surface de la pièce l'interface utilisateur est projetée.


SurfaceGuiBase

Cette propriété détermine si le `Class.SurfaceGui` va ignorer l'entrée,
pour exemple si le parent ou la partie `Class.SurfaceGuiBase.Adornee|Adornee`
contient une classe `Class.ClickDetector` comme `Class.DragDetector`.

Notez que les éléments d'interface utilisateur interactifs comme `Class.ImageButton|ImageButtons`
et `Class.TextButton|TextButtons` à l'intérieur d'un `Class.SurfaceGui`
ne recevront l'entrée de l'utilisateur que s'ils sont parentés au `Class.PlayerGui` (la
propriété `Class.SurfaceGui.Adorneee` peut être utilisée pour cibler une partie dans le
monde 3D alors que le `Class.SurfaceGui` lui-même reste dans le
`Class.PlayerGui`). De plus, la propriété
`Class.BasePart.CanQuery|CanQuery` de la partie doit être `true` pour que l'élément
UI interactif reçoive l'entrée.

SurfaceGuiBase.Active

Détermine si le `Class.SurfaceGui` absorbe l'entrée utilisateur ; `true` par
 défaut.


`Class.BasePart` sur lequel appliquer le `Class.SurfaceGui`, remplaçant l'association
parent par défaut.

SurfaceGuiBase.Adornee

`Enum.NormalId` face du parent `Class.SurfaceGui` (ou de son
`Class.SurfaceGuiBase.Adornee|Adornee`) sur laquelle appliquer le
`Class.SurfaceGui`.

SurfaceGuiBase.Face

`Enum.NormalId` face sur laquelle appliquer le `Class.SurfaceGui`.

Classe de base pour les conteneurs qui rendent `Class.GuiObject|GuiObjects` sur une face
 d'un `Class.BasePart` dans le monde 3D.


**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 se rendent 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 se rendront les uns au-dessus des 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.
En conséquence, les descendants d'un `Class.GuiObject` doivent avoir une
valeur `Class.GuiObject.ZIndex|ZIndex` qui est au moins aussi élevée que celle du
parent, sinon ils se rendront 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 se déplace vers, quitte ou change
au sein de la `Class.GuiBase2d` connectée 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,
les informant que la sélection a
changé/entré/exité vers un `Class.GuiObject` dans leur arbre de descendants.


GuiBase2d.SelectionChanged

amISelected

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


previousSelection

newSelection

Se déclenche lorsque la sélection du gamepad se déplace vers, quitte ou change au sein de la
`Class.GuiBase2d` connectée 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 réelle en pixels à laquelle un élément
est rendu en fonction 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 de la vue `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 des 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
degrees.


`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
retraduites 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` pointée vers une instance localisera
tous les `Class.TextLabel.TextButton` qui sont des descendants de l'instance racine.


GuiBase2d.Localize

Défini automatiquement 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 indé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
la `Class.GuiBase2d.RootLocalizationTable|RootLocalizationTable` est utilisée
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 comment 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 réglage de
`Enum.SelectionBehavior.Escape` (par défaut) signifie que la sélection du gamepad
essaie d'abord de trouver une sélection dans le groupe de sélection et ne se déplace
vers l'extérieur que si elle ne trouve pas de bouton approprié. Alternativement, un réglage 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 de 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.

Se déclenche lorsque cette instance est reparentée ou lorsque l'un de ses ancêtres est
reparenté.

Vous pouvez utiliser cet événement pour suivre la suppression d'une instance dans Studio,
such as la suppression manuelle dans l'Explorateur ou via un plugin. Si vous avez besoin
de détecter quand une instance est détruite en utilisant `Class.Instance:Destroy()`,
utilisez l'événement `Class.Instance.Destroying` à la place.


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 éloigné, **pas**
nécessairement l'instance à laquelle le gestionnaire est connecté.


parent

Le nouveau parent du paramètre `child`.


Se déclenche lorsque la propriété `Class.Instance.Parent` de cet objet ou de l'un de
ses ancêtres est modifiée.


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

Par exemple, le code suivant connecte la fonction `attributeChanged()`
pour se déclencher 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, "a changé")
end

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


Instance.AttributeChanged

attribute

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


Se déclenche chaque fois qu'un attribut est modifié sur le `Class.Instance`.


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

Se déclenche après qu'un objet a été parenté à ce `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
`Class.Instance`. Pour un événement qui capture tous les descendants, utilisez
`Class.Instance.DescendantAdded`.

Voir aussi `Class.Instance.ChildRemoved`.


Instance.ChildAdded

Le `Class.Instance` qui a été ajouté.


Se déclenche après qu'un objet a été parenté à ce `Class.Instance`.


Instance.childAdded

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

Se déclenche après qu'un enfant a été supprimé de ce `Class.Instance`.

Supprimé fait référence au moment où le parent d'un objet est changé de ce
`Class.Instance` à autre chose que ce `Class.Instance`. Notez que cet
evenement se déclenchera également lorsqu'un enfant est détruit (en utilisant
`Class.Instance:Destroy()`) car la fonction de destruction définit le parent d'un objet
à `nil`.

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

Voir aussi `Class.Instance.ChildAdded`.


Instance.ChildRemoved

Le `Class.Instance` qui a été supprimé.


Se déclenche après qu'un enfant a été supprimé de ce `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é au `Class.Instance`.

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

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

Voir aussi `Class.Instance.DescendantRemoving`.


Instance.DescendantAdded

descendant

Se déclenche après qu'un descendant a été ajouté au `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'un **descendant** ne soit plus un descendant. `Class.Instance:Destroy()|Destroy()` change le `Class.Instance.Parent|Parent` d'une instance à `nil`, donc appeler cette méthode sur un
descendant du parent fera déclencher cet événement.

Puisque cet événement se déclenche **avant** la suppression du descendant, le parent du
descendant restera inchangé au moment de ce déclenchement. 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,
suivi de 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
quelque chose d'autre échouera. Voici un exemple qui démontre cela :

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

Workspace.DescendantRemoving:Connect(function(descendant)
	-- Ne manipulez pas 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

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


Se déclenche immédiatement avant qu'un descendant du `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.

Le `Class.Instance` ne sera jamais supprimé de la mémoire tant qu'une fonction connectée
l'utilise encore. Cependant, si la fonction se suspend à un moment donné,
le `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 ne 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 reprise,
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
a 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'un `Class.Instance` dans Studio, comme la suppression manuelle
via l'[Explorateur](/studio/explorer) ou via un plugin,
le `Class.Instance` n'est pas détruit. Au lieu de cela, le parent est défini sur `nil`
ce que vous pouvez suivre avec `Class.Instance.AncestryChanged`.


Instance.Destroying

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


Démontre `Class.Instance.StyledPropertiesChanged`.


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


Instance.StyledPropertiesChanged

Se 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. Ajouter une étiquette avec succès 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 certaines 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 ces ressources (déconnecter,
  définir à `nil`, etc.) lorsqu'elles ne sont plus nécessaires pour une étiquette. Faites cela lors
  de l'appel à `Class.Instance:RemoveTag()`, lors de l'appel à
  `Class.Instance:Destroy()`, ou dans une fonction connectée à un signal
  retourné par `Class.CollectionService:GetInstanceRemovedSignal()`.


Instance:AddTag

L'étiquette à appliquer à l'instance.


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 et descendants d'une instance.

```
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 ce qu'il faut détruire. Par
exemple, le 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
retourné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épend de la
valeur de l'original :

- 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

Une copie de l'instance, ou `nil` si l'instance n'est pas
`Class.Instance.Archivable|Archivable`.


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 sérieux problèmes de performance au fil du temps.

En tant que bonne pratique après avoir appelé `Destroy()` sur un objet, définissez toutes
les variables référencant 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 faites pas 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 certain temps, 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 au `Class.Instance.Parent`
immediat de l'instance et remonte vers le `Class.DataModel`. Si aucun ancêtre correspondant n'est trouvé, elle renvoie `nil`.

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

```
local car = object:FindFirstAncestor("Car")
```
Pour des variantes de cette méthode qui trouvent des ancêtres d'une classe spécifique,
veuillez consulter `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 className donné.

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

Une utilisation courante de cette méthode consiste à 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 de classe.


Instance:FindFirstAncestorOfClass

className

Le `Class.Object.ClassName` à rechercher.


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


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

Cette méthode fonctionne vers le haut, ce qui signifie qu'elle commence au `Class.Instance.Parent`
immediat de l'instance 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 de classe. Par exemple :

```
print(part:IsA("Part"))  --> true
print(part:IsA("BasePart"))  --> true
print(part:IsA("Instance"))  --> true
```
Par conséquent, le 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 className 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 nom 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. Tenter d'indexer un enfant par son nom en utilisant l'opérateur point
provoque 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 consiste à utiliser `FindFirstChild()` pour d'abord vérifier `Part`,
puis 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 propriété de son `Class.Instance.Parent|Parent`. Lors de l'utilisation de l'opérateur point, les propriétés ont la priorité sur les enfants si elles partagent un 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 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
```

#### Notes de performance

`Class.Instance:FindFirstChild()|FindFirstChild()` prend environ 20 % de temps en plus
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
nom donné devient disponible.


Instance:FindFirstChild

recursive

Que la recherche doit être effectuée de manière récursive 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 de classe. 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 className donné.

Si aucun enfant correspondant n'est trouvé, cette méthode renvoie `nil`. Si l'argument
optionnel récursif 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 de classe. Par exemple :

```lua
print(part:IsA("Part")) --> true
print(part:IsA("BasePart")) --> true
print(part:IsA("Instance")) --> true
```
Par conséquent, le 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 className 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 ancêtre `Class.Actor` le plus proche 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, le code suivant définit puis obtient 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é à 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 l'événement
`Class.Object.Changed|Changed`, sauf qu'il ne se déclenche que lorsque
l'attribut donné change ; en effet, il est similaire à
`Class.Object:GetPropertyChangedSignal()|GetPropertyChangedSignal()` mais
pour les attributs.

Il est généralement bon d'utiliser cette méthode au lieu d'une connexion à
`Class.Object.Changed|Changed` avec une fonction qui vérifie le nom de l'attribut. Les appels suivants à 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éclenche la fonction
`attributeChanged()` lorsque l'attribut `InitialPosition` de la partie 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, le code suivant affiche les attributs et valeurs d'une instance :

```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 `for` numérique ou 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 l'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 l'enfant numéro " .. i)
end
```
Notez que le tableau renvoyé n'est **pas** trié dans un ordre particulier, donc
un tri manuel (par exemple en utilisant `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

Un tableau contenant les enfants de l'instance.


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 de classes Roblox
qui peuvent faire partie de l'arbre `Class.DataModel`.
