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

Ein `Class.Actor` ist ein Container für Code, der sicher in seinem eigenen Thread aufgeteilt werden kann.

Class

Actor

Luau

Array

Dictionary

Eine abstrakte Klasse für alle 2D-Benutzeroberflächenobjekte.

GuiObject

Halten Sie den Konstruktor für Instanzen.

Data Type

Ein LocalizationTable ist eine Datenbank von Übersetzungen. Er enthält Quellzeilen und Übersetzungen für verschiedene Sprachen.

LocalizationTable

Die NormalId-Liste setzt die Seite/ das Gesicht eines Teils ein.

Enum

Enum.NormalId

Ein Objekt, das bei einem bestimmten Ereignis verbundene Funktionen ausführt.

RBXScriptSignal

Anpassungsoptionen für die Spielpad-Auswahl, wenn `Class.GuiBase2d.SelectionGroup` wahr ist.

Enum.SelectionBehavior

Variant

Repräsentiert einen 2D-Wert mit Richtung und Magnitude.

Vector2

Class.layerCollector.ZIndexBehavior verwendet, um zu kontrollieren, wie sich die `Class.GuiObject.ZIndex` Eigenschaft für Nachkommen verhält.

Enum.ZIndexBehavior

Datentyp mit einem Wert von "wahr" oder "falsch".

bool

Eine doppelte Präzisionsschwimmkomma-Zahl.

number

Eine Reihe von Zeichen, wie Buchstaben, Zahlen und Symbole.

string

void

Übersicht

Anleitungen

Tutorials

Referenz

Ressourcen

Kunst

Design

Engine

Avatar

Legacy

Cloud

Diese Methode ist asynchron und gibt eine `Operation` zurück, die den aktuellen Status der Operation darstellt. Sie enthält einen Endpunktpfad, den du abfragen kannst, um die tatsächliche Antwort und die entsprechenden Metadaten zu erhalten. Weitere Informationen findest du in der [Dokumentation]({longRunningOperationsLink}).

Die folgenden Abschnitte beschreiben die Antwort- und Metadatenobjekte, die bereitgestellt werden, wenn eine Operation abgeschlossen ist.

Beta-Endpunkte sind bereit für die öffentliche Nutzung. Bahnbrechende Änderungen sind möglich, aber selten.

Dieses Feld kann beim Erstellen einer Ressource festgelegt werden, kann jedoch durch spätere Anfragen nicht geändert werden.

Dieses Feld kann in Anfragen zur Verfügung gestellt werden, wird aber niemals in Antworten enthalten sein.

Pro API-Schlüssel: {maxInPeriod} Anfoderungen pro {periodInSeconds} Sekunden pro IP-Adresse

Dieses Feld kann in Antworten zur Verfügung gestellt werden, wird aber bei Anfragen ignoriert.

Die folgenden API-Schlüssel-Berechtigungen werden benötigt, um diesen Endpunkt aufzurufen. Für weitere
Informationen zur Erzeugung korrekter Schlüssel siehe [API-Schlüssel verwalten]({apiKeyReferenceDocLink}).

Die folgenden Endpunkte sind bei Pfaden relativ zur Basis-URL verfügbar.

Dieser String ist als [FieldMask](/cloud/reference/types#fieldmask) formatiert.

Ein JSON-Wert kann `null`, `boolean`, `string`, `number`, `array` oder `object` sein.

Um diesen Endpunkt nutzen zu können, werden folgende Anwendungsbereiche für deine OAuth 2.0 App benötigt. Weitere Informationen zur Registrierung einer OAuth 2.0-App findest du unter [App Registration and Review]({oauth2ReferenceDocLink}).

Die folgenden Objekte beschreiben Nutzlasten, die akzeptiert oder zurückgegeben werden. Die einzelnen Endpunkte zeigen weitere Informationen darüber an, wann diese Objekte verwendet werden.

Dieser String ist als [Zeitstempel](/cloud/reference/types#timestamp) formatiert.

Dies ermöglicht das Anzeigen von Informationen über deine Objekte.

Dies ermöglicht das Hochladen und Aktualisieren von Objekten auf Roblox.

Bietet die Möglichkeit, die Abzeichen des Nutzers zu aktualisieren.

Dies ermöglicht das Anzeigen von Informationen über deine Handelsartikel.

Dies ermöglicht das Bearbeiten deiner Kommerzhändlerverbindungen.

Hiermit kannst du Informationen zu deinen Creator-Store-Produkten ansehen.

Hiermit kannst du Informationen zu deinen Creator-Store-Produkten ändern.

Dies ermöglicht das Anzeigen von Informationen über deine Gruppen.

Damit kannst du Gruppenbeitrittsanfragen für dein Konto verwalten.

Dies ermöglicht das Anzeigen von Informationen über dein Inventar.

Gewährt Zugriff auf die Verwaltung deiner Abzeichen.

Gewährt Zugriff auf die Verwaltung deiner Abzeichen und das Ausgeben von Robux.

Gewährt Zugriff auf die Verwaltung deiner Entwicklerprodukte.

Gewährt Zugriff zum Lesen von Informationen über die Erlebnisse, denen du folgst.

Gewährt Zugriff zum Folgen und Entfolgen von Erlebnissen in deinem Namen.

Gewährt Zugriff auf die Verwaltung deiner Pässe.

Gewährt Zugriff auf die Verwaltung deiner Gruppen.

Gewährt die Erlaubnis, Gruppeninformationen zu lesen.

Gewährt Gruppenverwaltungsberechtigungen.

Gewährt Zugriff zum Lesen und Schreiben deiner Lokalisierungstabellen

Gewährt Zugriff auf die Verwaltung der Teamzusammenarbeit für alle deine Erlebnisse.

Gewährt Zugriff auf die Verwaltung deiner Erlebnisse und bestimmte Informationen, die mit deinem Erlebnis verbunden sind (z.B. Lokalisierungsinformationen).

Gewährt Zugriff zum Lesen der Lokalisierungsinformationen deiner Erlebnisse.

Gewährt Zugriff zum Ändern der Lokalisierungspräferenzen deiner Erlebnisse.

Gewährt Zugriff auf die Verwaltung deines Nutzerkontos.

Gewährt Zugriff zum Ändern der Lokalisierungspräferenzen des Nutzers.

Dies gewährt die Fähigkeit, Nachrichten im Namen von Nutzern zu veröffentlichen.

Damit können Benachrichtigungen an Nutzer von deinem Erlebnis aus gesendet werden.

Damit kannst du Geheimnisse auflisten, die mit deinem Erlebnis verbunden sind.

Damit kannst du Geheimnisse erstellen und aktualisieren, die mit deinem Erlebnis verbunden sind.

Ermöglicht den Zugriff auf deine Abonnementprodukte.

Gewährt die Fähigkeit, Ortsinformationen zu lesen.

Gewährt die Fähigkeit, Ortsinformationen zu bearbeiten.

Dieser Vorgang ermöglicht den Zugriff, neue Versionen von Erlebnissen auf Roblox zu veröffentlichen.

Gewährt die Fähigkeit, Erlebnisinformationen zu lesen.

Gewährt die Fähigkeit, Erlebnisinformationen zu bearbeiten.

Ermöglicht es dir, Benutzerbeschränkungen im Erlebnis zu sehen.

Ermöglicht es dir, Benutzerbeschränkungen im Erlebnis zu bearbeiten.

Gewährt die Fähigkeit, den Premium- und Verifizierungs-Status der Nutzer zu lesen.

Hiermit kannst du die sozialen Konten von Nutzern ansehen.

Dies aktiviert Single Sign-On-Funktionalität.

Dies gewährt Zugriff auf das Lesen deiner Profilinformationen.

SurfaceGuiBase

Zusammenfassung

Eigenschaften

Methoden

Ereignisse

Eigenschaften

Active

Adornee

Face

Methoden

Ereignisse