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

Panoramica

Guide

Tutorial

Referenza

Risorse

Arte

Design

Motore

Avatar

Cloud

This field may be set when creating a resource, but may not be modified by subsequent requests.

This field may be provided in requests, but will never be included in responses.

Per chiave API: {maxInPeriod} richieste ogni {periodInSeconds} secondi per indirizzo IP

This field may be set on responses, but will be ignored in requests.

Per chiamare questo endpoint sono richiesti i seguenti permessi della chiave API. Per maggiori informazioni
sulla generazione delle chiavi corrette, vedere [Gestione delle chiavi API]({apiKeyReferenceDocLink}).

I seguenti endpoint sono disponibili nei percorsi relativi all'URL di base.

Questa stringa è formattata come [Timestamp](/cloud/reference/types#timestamp).

Un valore JSON può essere `null`, `boolean`, `string`, `number`, `array`, or `object`.

Per utilizzare questo endpoint sono necessari i seguenti ambiti per la tua applicazione OAuth 2.0. Per ulteriori informazioni su come registrare un'applicazione OAuth 2.0, vedere [Registrazione e revisione dell'app]({oauth2ReferenceDocLink}).

Gli oggetti seguenti descrivono i payloads accettati o restituiti. Per maggiori informazioni su quando vengono utilizzati questi oggetti, consultare ogni singolo endpoint.

Questo permette di visualizzare informazioni sui tuoi beni.

Questo permette di caricare e aggiornare gli asset su Roblox.

Grants the ability to update Badges owned by the user

This allows you to view information about your Creator Store products.

This allows you to modify information about your Creator Store products.

Questo permette di vedere le informazioni sui tuoi Gruppi.

This allows you to manage group join requests for your account.

(Legacy) Grants the ability to update Badges owned by the user

Ciò garantisce la possibilità di pubblicare messaggi per conto degli utenti.

This allows sending notifications from your experience to users

Questo permette di elencare i segreti associati alla tua esperienza.

Ciò consente di creare e aggiornare i segreti associati alla tua esperienza.

Grants the ability to read place information.

Grants the ability to edit place information.

Questa operazione consente di pubblicare nuove versioni di esperienze a Roblox.

Grants the ability to read experience information.

Grants the ability to edit experience information.

Consente di visualizzare le restrizioni degli utenti nell'esperienza.

Grants the ability to read user's premium and verified status.

This allows you to view a user's social accounts.

Questo garantisce l'accesso alla lettura delle informazioni del tuo profilo

Valore predefinito: {defaultValueStart}{defaultValueEnd}

An array is an ordered list of values. Arrays are useful for storing collections of data.

A set of key-value pairs, where the keys can be any number, string, or object.

Questa funzione restituisce immediatamente, se possibile, ma può restituire il thread che lo ha chiamato fino a quando non può restituire un valore.

{nameStart}nome{nameEnd} non è più supportato o mantenuto da Roblox.

Questa operazione matematica non è più supportata o mantenuta da Roblox.

Questo membro non appare nel browser degli oggetti e non è destinato ad un uso diffuso.

Questo membro è accessibile solo tramite la barra dei comandi. Il tentativo di accedere a questo membro dagli script provoca un errore.

Questa funzione non può mettere in pausa il thread di Lua che l'ha chiamato.

Il tentativo di accedere a questo membro negli script causa un errore. Potresti essere in grado di accedere a questo membro dalla finestra delle proprietà di Roblox Studio.

Questo membro non appare nel browser degli oggetti di Roblox Studio.

Non è possibile creare un'istanza di questa classe con il Instance.new constructor.

Roblox non replica questo membro attraverso il suo confine server-client.

Il codice Lua non può accedere a questo membro. Potresti cambiare il suo valore dalla finestra di proprietà in Roblox Studio.

Il comportamento di replica di questo oggetto dipende dal giocatore che lo possiede.

Questo membro è accessibile solo attraverso la barra dei comandi e solo i plugin. Tentando di accedere a questo membro dagli script provoca un errore.

Questo membro è in sola lettura. Tentando di scrivere a questo membro causa un errore.

This property is read-only and is safe to read in unsynchronized threads. Attempting to write to it causes an error.

Questa proprietà è in sola lettura ed è sicura da leggere in thread non sincronizzati. Tentando di scriverci causa un errore.

Questo membro è accessibile solo in CoreScripts.

Solo Roblox CoreScripts può accedere a questo membro e non è utilizzabile dai giocatori.

È possibile leggere e scrivere a questa proprietà in modo sicuro da più thread.

Questa classe è un singleton di primo livello. Recupera un'istanza di questa classe con la funzione GetService.

Più thread possono potenzialmente scrivere su questa proprietà, quindi non è sicuro leggere da thread non sincronizzati.

You can read and write to this property safely from multiple threads.

Questa funzione interrompe il thread di Lua che lo chiamava fino a quando non restituisce un risultato. Questo non interrompe altri script.

SurfaceGuiBase

Sommario

Proprietà

Metodi

Eventi

Proprietà

Active

Adornee

Face

Metodi

Eventi