SurfaceGuiBase

SurfaceGuiBase.Active

SurfaceGuiBase.Adornee

SurfaceGuiBase.Face

LayerCollector:GetLayoutNodeTree

LayerCollector

LayerCollector.Enabled

LayerCollector.ResetOnSpawn

LayerCollector.ZIndexBehavior

This example shows how to use `Class.GuiBase2d.SelectionChanged` to set the
color of a background frame depending on if the gamepad selection has a child
GuiObject focused in a hierarchy that looks like this:

<img src="/assets/engine-api/classes/GuiBase2d/Gamepad-SelectionChanged.png" />

You can add code to change the background color of backgroundWindow to green
when buttons 1, 2 or 3 are selected and change to red when other buttons
outside the frame are selected. This helps you to add any new buttons to the
backgroundWindow without updating the code.


GuiBase2d.SelectionChanged

amISelected

previousSelection

newSelection

GuiBase2d

This code sample shows how a UI element's size, position and rotation can be
copied without parenting a "copycat" to the original. It uses the
Absolute-family of properties to orient a "copycat" Frame that covers on the
screen space that the original does.


GuiBase2d.AbsolutePosition

GuiBase2d.AbsoluteRotation

GuiBase2d.AbsoluteSize

GuiBase2d.AutoLocalize

GuiBase2d.Localize

GuiBase2d.RootLocalizationTable

GuiBase2d.SelectionBehaviorDown

GuiBase2d.SelectionBehaviorLeft

GuiBase2d.SelectionBehaviorRight

GuiBase2d.SelectionBehaviorUp

GuiBase2d.SelectionGroup

GuiBase

Demonstrates detecting changes to an instance's ancestry by connecting to the `Class.Instance.AncestryChanged` event.

The ChangingPart's Parent is set to different values overtime. The parent of the part is the part's ancestor, so the `Class.Instance.AncestryChanged` event will fire whenever it changes.


Instance.AncestryChanged

child

parent

Instance.AttributeChanged

attribute

This snippet prints the names of objects as they are added to the Workspace:


Instance.ChildAdded

This snippet prints the names of objects as they are removed from the
Workspace:


Instance.ChildRemoved

This following example will print the name of any object that is added to the
Workspace:


Instance.DescendantAdded

descendant

The following example prints the name of any descendant as it is being removed
from the Workspace:


Instance.DescendantRemoving

This sample demonstrates how, when using Immediate signal behavior, an Instance being destroyed remains in place until the connected function yields.


This sample demonstrates how, when using Deferred signal behavior,
an Instance is destroyed before the signal fires.


Instance.Destroying

Instance.childAdded

Instance:AddTag

This example creates a Part and adds a few sparkle objects to the part. Then
it calls Part:ClearAllChildren() to remove all of the children.


Instance:ClearAllChildren

Demonstrates cloning a model using `Class.Instance:Clone()`.

Instance:Clone

Demonstrates destroying a Part using the `Class.Instance:Destroy()` function.

This function is the correct way to dispose of objects that are no longer required.


Instance:Destroy

Instance:FindFirstAncestor

name

Instance:FindFirstAncestorOfClass

className

Instance:FindFirstAncestorWhichIsA

The below would look in Workspace for an object name "Brick". If found, it
will change the name of the object to "Foo".


Instance:FindFirstChild

recursive

Instance:FindFirstChildOfClass

Instance:FindFirstChildWhichIsA

Instance:FindFirstDescendant

Instance:GetActor

Instance:GetAttribute

Instance:GetAttributeChangedSignal

Instance:GetAttributes

The below would print the name of all objects currently in Workspace when ran.


Instance:GetChildren

Instance:GetDebugId

scopeLength

GetDescendants is often used to do something to all the descendants that are a
particular type of object. The code in this example uses GetDescendants and
`Class.Instance:IsA()` to find all of the parts in the workspace and turns
them green.


Instance:GetDescendants

This code sample demonstrates the behavior of `Class.Instance:GetFullName()`.
It shows how the function behaves when called on an object not in the
`DataModel` hierarchy, and it also shows how the return value does not escape
special characters.


This code sample re-implements the `Class.Instance:GetFullName()` function in
Lua.


Instance:GetFullName

Instance:GetStyled

Instance:GetTags

Instance:HasTag

Demonstrates determining if one instance is the ancestor of another using `Class.Instance:IsAncestorOf()`

Workspace and SpawnLocation are ancestors of the SpawnLocation's decal.
Workspace is an ancestor of SpawnLocation.

SpawnLocation and its decal are descendants of Workspace, not ancenstors.
Decal is a descendant to SpawnLocation, not an ancestor.


Instance:IsAncestorOf

Instance:IsDescendantOf

ancestor

The following code demonstrates how a part can be re-added to the DataModel
after being removed:


Instance:Remove

Instance:RemoveTag

Instance:SetAttribute

value

The following code waits for an instance named "Part" to be added to
Workspace.


Instance:WaitForChild

childName

timeOut

Instance:children

Instance:clone

Instance:destroy

Instance:findFirstChild

Instance:getChildren

Instance:isDescendantOf

Instance:remove

Instance

Instance.Archivable

Instance.Capabilities

Instance.Name

Instance.Parent

Instance.RobloxLocked

Instance.Sandboxed

Instance.UniqueId

Instance.archivable

This sample demonstrates the subtleties of the Changed event on normal objects
and "-Value" objects.


This code sample demonstrates the Changed event firing within a parent object.


Object.Changed

property

This code sample demonstrates how to save a value before a changed event fires
on it in order to get more information about a change.


This code sample demonstrates the equivalence of the `Changed` event and event
returned by `GetPropertyChangedSignal`.


Object:GetPropertyChangedSignal

Demonstrates determining the class of Workspace using `Class.Instance:IsA()`

Workspace is of class 'Workspace', so the first statement is true.
Workspace is not of class 'BasePart', so the second statement is false.
Workspace inherits from Instance and therefore is of class 'Instance', so the third statement is true.


Object:IsA

Object:isA

Object

Object.ClassName

Object.className

/reference/engine/classes/SurfaceGuiBase.yaml

Un `Class.Actor` est un conteneur pour le code qui peut être divisé en toute sécurité en son propre fil.

Class

Actor

Luau

Array

Dictionary

Une classe abstraite pour tous les objets d'interface utilisateur 2D.

GuiObject

Contient le constructeur pour les instances.

Data Type

Une table de localisation est une base de données de traductions. Elle contient des chaînes source et des traductions pour diverses langues.

LocalizationTable

L'Index normalisé id est défini pour chaque côté/visage d'une partie.

Enum

Enum.NormalId

Un objet qui exécute des fonctions connectées à une occurrence spécifique.

RBXScriptSignal

Options de personnalisation pour le choix du gamepad lorsque `Class.GuiBase2d.SelectionGroup` est vrai.

Enum.SelectionBehavior

Variant

Représente une valeur 2D avec une direction et une magnitude.

Vector2

Utilisé par `Class.LayerCollector.ZIndexBehavior` pour contrôler la façon dont la propriété `Class.GuiObject.ZIndex` se comporte pour les descendants.

Enum.ZIndexBehavior

Type de données ayant une valeur de vrai ou de faux.

bool

number

Une séquence de caractères, tels que les lettres, les chiffres et les symboles.

string

void

Vue d'ensemble

Guides

Tutoriels

Référence

Ressources

Design

Moteur

Avatar

Legacy

Cloud

Cette méthode est asynchrone et retourne une `Operation`, qui représente l'état courant de l'opération. Il contient un chemin de terminaison que vous pouvez interroger pour obtenir la vraie réponse et les métadonnées applicables. Voir la [documentation]({longRunningOperationsLink}) sur les opérations à long terme pour plus d’informations.
            
Les sections suivantes décrivent la réponse et les objets de métadonnées qui sont fournis lorsqu'une opération se termine.

Les points de terminaison bêta sont prêts à être utilisés publiquement. Des modifications sont possibles mais rares.

Ce champ peut être défini lors de la création d'une ressource, mais ne peut pas être modifié par des requêtes ultérieures.

Ce champ peut être fourni dans les demandes, mais ne sera jamais inclus dans les réponses.

Par clé API : {maxInPeriod} demande toutes les {periodInSeconds} secondes par adresse IP

Ce champ peut être défini sur les réponses, mais sera ignoré dans les demandes.

Les autorisations suivantes de la clé API sont requises pour appeler ce point de terminaison. Pour plus
d'informations sur la génération de clés appropriées, voir [Gestion des clés d'API] ({apiKeyReferenceDocLink}).

Les points de terminaison suivants sont disponibles à des chemins relatifs à l'URL de base.

Cette chaîne est formatée comme un [FieldMask](/cloud/reference/types#fieldmask).

Une valeur JSON peut être `null`, `boolean`, `string`, `number`, `array`, ou `object`.

Les champs d'application suivants sont nécessaires pour que votre application OAuth 2.0 puisse utiliser ce point de terminaison. Pour plus d'informations sur l'enregistrement d'une application OAuth 2.0, voir [Enregistrement et révisions des applis]({oauth2ReferenceDocLink}).

Les objets suivants décrivent les charges utiles qui sont acceptées ou renvoyées. Voir chaque point de terminaison individuel pour plus d'informations sur l'utilisation de ces objets.

Ce string est formatée en tant que [Timestamp](/cloud/reference/types#timestamp).

Les champs d'application suivants sont nécessaires pour que votre application OAuth 2.0 puisse utiliser ce point de terminaison. Pour plus d'informations sur l'enregistrement d'une application OAuth 2.0, voir [Enregistrement et révision d'une application]. ({oauth2ReferenceDocLink}).

Cela permet de consulter des informations sur vos contenus.

Il permet de télécharger et de mettre à jour des actifs sur Roblox.

Permet de mettre à jour les badges appartenant à l'utilisateur.

Cela permet de visualiser des informations sur vos articles commerciaux.

Cela permet de modifier vos connexions commerciales.

Cela vous permet d'afficher des informations sur vos produits de la Boutique du créateur.

Cela permet d'afficher des informations sur vos communautés.

Cela vous permet de gérer les demandes d'adhésion de la communauté et les mises à jour des rôles pour votre compte.

Donne accès à la gestion de tes badges.

Donne accès à la gestion de vos badges et à l'utilisation de robux.

Donne accès à la gestion de vos produits développeurs.

Permet d'accéder à la lecture d'informations sur les expériences que vous suivez.

Permet de suivre et d'annuler des expériences en votre nom.

Donne accès à la gestion de tes passes.

Donne accès à la gestion de tes communautés.

Donne la permission de lire les informations de la communauté.

Donne des autorisations de gestion de la communauté.

Donne accès à la lecture et à l'écriture de vos tables de localisation

Donne accès à la gestion de la collaboration en équipe pour toutes tes expériences.

Donne accès à la gestion de vos expériences et de certaines informations associées à vos expériences (par exemple des informations de localisation).

Permet de lire les informations de localisation de vos expériences.

Permet de modifier les préférences de localisation de vos expériences.

Donne accès à la gestion de votre compte utilisateur.

Permet l'accès pour modifier les préférences de localisation de l'utilisateur.

Cela permet de publier des messages au nom des utilisateurs.

Cela permet d'envoyer des notifications de votre expérience aux utilisateurs.

Cela permet d'énumérer les secrets liés à ton expérience.

Cela permet de créer et de mettre à jour des secrets liés à ton expérience.

Permet d'accéder aux informations sur les produits de votre abonnement.

Donne la capacité de lire les informations sur les lieux.

Donne la possibilité d'éditer les informations du lieu.

Cette opération donne accès à la publication de nouvelles versions d'expériences à Roblox.

Donne la possibilité de lire des informations sur l'expérience.

Donne la possibilité de modifier les informations d'expérience.

Permet de voir les restrictions de l'utilisateur dans l'expérience.

Vous permet de modifier les restrictions d'utilisateur dans l'expérience.

Donne la possibilité de lire le statut premium et vérifié de l'utilisateur.

Cela vous permet de voir les comptes sociaux d'un utilisateur.

Cela active la fonctionnalité Single Sign-On.

Cela vous donne accès à la lecture des informations de votre profil.

SurfaceGuiBase

Résumé

Propriétés

Méthodes

Évènements

Propriétés

Active

Adornee

Face

Méthodes

Évènements