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 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.


Instance.Changed

property

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 an Instance being destroyed remains in place
until the connected function yields.


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

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`.


Instance:GetPropertyChangedSignal

Instance:GetTags

Instance:HasTag

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.


Instance:IsA

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:isA

Instance:isDescendantOf

Instance:remove

Instance

Instance.Archivable

Instance.ClassName

Instance.Name

Instance.Parent

Instance.RobloxLocked

Instance.Sandboxed

Instance.UniqueId

Instance.archivable

Instance.className

/reference/engine/classes/SurfaceGuiBase.yaml

An `Class.Actor` is a container for code that can be safely split into its own thread.

Class

Actor

Luau

Array

Dictionary

An abstract class for all 2D user interface objects.

GuiObject

Data Type

A LocalizationTable is a database of translations. It contains source strings and translations for various languages.

LocalizationTable

The NormalId Enum sets which side/face of a Part is used.

Enum

Enum.NormalId

Objects

An object that runs connected functions upon a specific occurrence.

RBXScriptSignal

Customization options for gamepad selection when `Class.GuiBase2d.SelectionGroup` is true.

Enum.SelectionBehavior

Variant

Represents a 2D value with direction and magnitude.

Vector2

Used by `Class.LayerCollector.ZIndexBehavior` to control how the `Class.GuiObject.ZIndex` property behaves for descendants.

Enum.ZIndexBehavior

Data type having a value of either true or false.

bool

A double-precision floating-point number.

number

A sequence of characters, such as letters, numbers, and symbols.

string

void

Vue d'ensemble

Guides

Tutoriels

Référence

Ressources

Conception

Moteur

Avatar

Cloud

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 vous permet d'afficher des informations sur vos produits de la Boutique du créateur.

Cela permet d'afficher des informations sur vos groupes.

Cela vous permet de gérer les demandes d'adhésion de groupe pour votre compte.

(Héritage) Permet de mettre à jour les badges appartenant à 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.

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

Valeur par défaut : {defaultValueStart}{defaultValueEnd}

Un tableau est une liste ordonnée de valeurs. Les tableaux sont utiles pour stocker des collections de données.

Un ensemble de paires clé-valeur, où les clés peuvent être n'importe quel nombre, chaîne ou objet.

Cette fonction revient immédiatement si possible, mais peut céder le thread qui l'a appelée jusqu'à ce qu'elle puisse retourner une valeur.

{nameStart}nom{nameEnd} n'est plus supporté ou maintenu par Roblox.

Cette opération mathématique n'est plus prise en charge ou maintenue par Roblox.

Ce membre n'apparaît pas dans le navigateur d'objet et n'est pas destiné à une utilisation généralisée.

Ce membre n'est accessible que via la barre de commande. Tenter d'accéder à ce membre à partir de scripts provoque une erreur.

Cette fonction ne peut pas mettre en pause le thread Lua qui l’appelle.

Tenter d'accéder à ce membre dans les scripts provoque une erreur. Tu peux accéder à ce membre à partir de la fenêtre de propriété de Roblox Studios.

Ce membre n’apparaît pas dans le navigateur Objet de Roblox Studio.

Tu ne peux pas créer une instance de cette classe avec le constructeur Instance.new .

Roblox ne réplique pas ce membre à travers sa limite client serveur.

Le code Lua ne peut pas accéder à ce membre. Tu pourrais être en mesure de changer sa valeur depuis la fenêtre de la propriété dans Roblox Studio.

Le comportement de réplication de cet objet dépend du joueur qui le possède.

Ce membre n'est accessible que par le biais de la barre de commandes et des plugins uniquement. Tenter d'accéder à ce membre à partir de scripts provoque une erreur.

Ce membre est en lecture seule. Tenter d'écrire à ce membre provoque une erreur.

Cette propriété est en lecture seule et peut être lue en toute sécurité dans les threads non synchronisés. Toute tentative d'écriture dans cette propriété entraîne une erreur.

Ce membre n'est accessible que dans CoreScripts.

Seul Roblox CoreScripts peut accéder à ce membre, et il n’est pas utilisable par les joueurs.

Tu peux lire et écrire cette propriété en toute sécurité à partir de plusieurs threads.

Cette classe est un singleton de premier niveau. Récupére une instance de cette classe avec la fonction GetService.

Plusieurs threads peuvent potentiellement écrire dans cette propriété, donc il n'est pas sûr de lire à partir de threads non synchronisés.

Vous pouvez lire et écrire sur cette propriété en toute sécurité à partir de plusieurs threads.

Cette fonction met en pause le thread Lua qui l'a appelée jusqu'à ce qu'elle renvoie un résultat. Cela n'interrompt pas les autres scripts.

SurfaceGuiBase

Résumé

Propriétés

Méthodes

Évènements

Propriétés

Active

Adornee

Face

Méthodes

Évènements