GuiMain

ScreenGui

ScreenGui.ClipToDeviceSafeArea

ScreenGui.DisplayOrder

ScreenGui.IgnoreGuiInset

ScreenGui.SafeAreaCompatibility

ScreenGui.ScreenInsets

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

The original name of the `Class.ScreenGui`. This class functions identically
to the ScreenGui, and should not be used.


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

Objects

An object that runs connected functions upon a specific occurrence.

RBXScriptSignal

Describes how descendants of a `Class.ScreenGui` adapt to screens with cutouts.

Enum

Enum.SafeAreaCompatibility

Insets associated with various screen safe areas.

Enum.ScreenInsets

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

Overview

Guides

Tutorials

Reference

Resources

Design

Engine

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 API Key: {maxInPeriod} requests every {periodInSeconds} seconds per IP Address

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

The following API key permissions are required to call this endpoint. For more
information on generating proper keys, see [Managing API Keys]({apiKeyReferenceDocLink}).

The following endpoints are available at paths relative to the base URL.

This string is formatted as a [FieldMask](/cloud/reference/types#fieldmask).

A JSON value can be `null`, `boolean`, `string`, `number`, `array`, or `object`.

The following scopes are required for your OAuth 2.0 application to use this endpoint. For more information on how to register an OAuth 2.0 application, see [App Registration and Review]({oauth2ReferenceDocLink}).

The following objects describe payloads that are accepted or returned. See each individual endpoint for more information on when these objects are used.

This string is formatted as a [Timestamp](/cloud/reference/types#timestamp).

This allows viewing information about your assets.

This allows uploading and updating assets to Roblox.

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

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

This allows viewing information about your groups.

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

This allows viewing information about your inventory.

This grants the ability to publish messages on behalf of users.

This allows sending notifications from your experience to users

This allows listing secrets associated with your experience.

This allows creating and updating secrets associated with your experience.

Grants the ability to read place information.

Grants the ability to edit place information.

This operation grants access to publish new versions of experiences to Roblox.

Grants the ability to read experience information.

Grants the ability to edit experience information.

Allows you to view user restrictions in the experience.

Allows you to edit user restrictions in the experience.

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

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

This enables Single Sign-On functionality

This grants access to read your profile information

Default Value: {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.

GuiMain

Summary

Properties

Methods

Events

Properties

Methods

Events