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` es un contenedor para el código que se puede dividir con seguridad en sus propios subproceso.

Class

Actor

Luau

Array

Dictionary

Una clase abstracta para todos los objetos de interfaz de usuario 2D.

GuiObject

Data Type

Una tabla de localización es una base de datos de traducciones. Contiene cadenas de fuente y traducciones para varios idiomas.

LocalizationTable

O NormalId Enum define qual lado/rosto de uma Peça é usado.

Enum

Enum.NormalId

Um objeto que executa funções conectadas em uma ocorrência específica.

RBXScriptSignal

Opções de personalização para a seleção do gamepad quando `Class.GuiBase2d.SelectionGroup` é verdadeiro.

Enum.SelectionBehavior

Variant

Representa un valor 2D con dirección e intensidad.

Vector2

Usado por `Class.LayerCollector.ZIndexBehavior` para controlar como a propriedade `Class.GuiObject.ZIndex` se comporta para descendentes.

Enum.ZIndexBehavior

Tipo de dado tendo um valor de verdadeiro ou falso.

bool

Um número de ponto flutuante de precisão dupla.

number

Uma sequência de caracteres, como letras, números e símbolos.

string

void

Visão geral

Guias

Tutoriais

Referência

Recursos

Arte

Design

Motor

Avatar

Legado

Nuvem

Este método é assíncrono e retorna uma "Operação", que representa o estado atual da operação. Ele contém um caminho de endpoint que você pode solicitar para obter a resposta real e os metadados aplicáveis. Veja o [documentation]({longRunningOperationsLink}) em operações de longo prazo para obter mais informações.
            
As seções a seguir descrevem os objetos de resposta e metadados que são fornecidos quando uma operação se completa.

Pontos de extremidade beta estão prontos para uso público. Alterações  danosas são possíveis mas raras.

Este campo pode ser definido ao criar um recurso, mas não pode ser modificado por solicitações subsequentes.

Este campo pode ser fornecido em solicitações, mas nunca será incluído em respostas.

Por chave de API: {maxInPeriod} solicitações a cada {periodInSeconds} segundos por endereço IP

Este campo pode ser definido como respostas, mas será ignorado em solicitações.

As seguintes permissões de chave API são requeridas para chamar este endpoint. Para mais informações sobre gerar chaves apropriadas, veja [Gerenciando chaves API]({apiKeyReferenceDocLink}).

Os seguintes endpoints estão disponíveis em caminhos relativos à URL base.

Esta cadeia de caracteres está formatada como um [FieldMask](/cloud/reference/types#fieldmask).

Um valor JSON pode ser `null`, `boolean`, `string`, `number`, `array`, ou `object`.

Os seguintes escopos são necessários para que sua aplicação OAuth 2.0 use este endpoint. Para obter mais informações sobre como registrar um aplicativo OAuth 2.0, consulte [Registro do aplicativo e revisão]({oauth2ReferenceDocLink}).

Os seguintes objetos descrevem payloads que são aceitos ou retornados. Veja cada endpoint para mais informações sobre quando esses objetos são usados.

Esta cadeia de caracteres é formatada como um [Timestamp](/cloud/reference/types#timestamp).

Os seguintes escopos são necessários para que sua aplicação OAuth 2.0 use este endpoint. Para obter mais informações sobre como registrar um aplicativo OAuth 2.0, consulte [Registro e revisão do aplicativo]({oauth2ReferenceDocLink}).

Isto permite visualizar informações sobre seus ativos.

Isto permite enviar e atualizar ativos para a Roblox.

Concede a capacidade de atualizar emblemas de propriedade do usuário.

Isso permite visualizar informações sobre seus itens de comércio.

Isso permite editar suas conexões de comerciante.

Isso permite que você visualize informações sobre seus produtos da Loja do Criador.

Isso permite que você modifique informações sobre seus produtos da Loja de Criadores.

Isso permite visualizar informações sobre suas comunidades

Isso permite que você gerencie solicitações de participação da comunidade e atualizações de funções para sua conta.

Isto permite visualizar informações sobre seu inventário.

Concede acesso para gerenciar seus emblemas.

Concede acesso para gerenciar seus emblemas e gastar Robux.

Concede acesso para gerenciar seus produtos de desenvolvedor.

Concede acesso para ler informações sobre as experiências que você segue.

Concede acesso para seguir e deixar de seguir experiências em seu nome.

Concede acesso para gerenciar seus passes.

Concede acesso para gerenciar suas comunidades.

Concede permissão para ler informações da comunidade.

Concede permissões de gerenciamento de comunidade.

Concede acesso para ler e escrever suas tabelas de localização

Concede acesso para gerenciar a colaboração de equipe para todas as experiências que você possui.

Concede acesso para gerenciar suas experiências e certas informações associadas a suas experiências (por exemplo, informações de localização).

Concede acesso para ler as informações de localização das suas experiências.

Concede acesso para modificar as preferências de localização das suas experiências.

Concede acesso para gerenciar sua conta de usuário.

Concede acesso para modificar as preferências de localização do usuário.

Isto permite publicar mensagens em nome de um usuário.

Isto permite o envio de notificações da sua experiência aos usuários.

Isto permite listar segredos aliados à sua experiência.

Isto permite criar e atualizar segredos relacionados à sua experiência.

Concede acesso para ler sobre seus produtos de assinatura.

Concede a capacidade de ler informações do local.

Concede a capacidade de editar as informações do local.

Esta operação permite acesso para publicar novas versões de experiências para a Roblox.

Concede a capacidade de ler informações da experiência.

Concede a capacidade de editar informações da experiência.

Permite que você veja restrições de usuário na experiência.

Permite que você edite restrições de usuário na experiência.

Concede a capacidade de ler o status Premium e verificado do usuário.

Isso permite que você veja as contas sociais de um usuário.

Isto habilita a funcionalidade de entrada única.

Isso permite acesso à leitura das informações do seu perfil.

SurfaceGuiBase

Resumo

Propriedades

Métodos

Eventos

Propriedades

Active

Adornee

Face

Métodos

Eventos