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

개요

가이드

튜토리얼

참조

리소스

아트

디자인

엔진

Avatar

클라우드

이 필드는 리소스를 생성할 때 설정될 수 있지만 후속 요청에 의해 수정될 수는 없습니다.

이 필드는 요청에 제공될 수 있지만 응답에는 포함되지 않습니다.

각 API 키별: IP 주소당 {periodInSeconds}초마다 {maxInPeriod} 요청

이 필드는 요청에서 무시됩니다.

이 엔드포인트를 호출하려면 다음 API 키 권한이 필요합니다. 적절한 키 생성에 대한
자세한 내용은 [API 키 관리]({apiKeyReferenceDocLink})에서 확인하세요.

다음 끝점은 기준 URL과 관련된 경로에서 사용할 수 있습니다.

이 문자열은 [FieldMask](/cloud/reference/types#fieldmask) 형식으로 지정됩니다.

JSON 값은 `null`, `boolean`, `string`, `number`, `array`, `object`일 수 있습니다.

OAuth 2.0 애플리케이션에서 이 엔드포인트를 사용하려면 다음 범위가 필요합니다. OAuth 2.0 애플리케이션 등록 방법에 대한 자세한 내용은 [앱 등록 및 심사]({oauth2ReferenceDocLink})에서 확인하세요.

다음 개체는 수락되거나 반환되는 페이로드를 설명합니다. 이러한 개체가 사용되는 시기에 대한 자세한 정보는 각 개별 끝점을 참고하세요.

이 문자열은 [Timestamp](/cloud/reference/types#timestamp) 형식으로 지정됩니다.

이를 통해 애셋에 대한 정보를 볼 수 있습니다.

이를 통해 애셋을 Roblox에 업로드하고 업데이트할 수 있습니다.

Grants the ability to update Badges owned by the user

이를 통해 크리에이터 상점 상품에 대한 정보를 볼 수 있습니다.

이를 통해 크리에이터 상점 상품에 대한 정보를 수정할 수 있습니다.

이를 통해 그룹에 대한 정보를 볼 수 있습니다.

이제 계정에 대한 그룹 가입 요청을 관리할 수 있습니다.

이를 통해 인벤토리에 대한 정보를 볼 수 있습니다.

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

사용자를 대신해 메시지를 게시할 수 있는 권한이 부여됩니다.

이를 통해 체험에서 사용자에게 알림을 보낼 수 있습니다

이를 통해 체험과 관련된 시크릿을 나열할 수 있습니다.

이를 통해 체험과 관련된 시크릿을 생성하고 업데이트할 수 있습니다.

플레이스 정보를 읽을 수 있는 권한을 부여합니다.

플레이스 정보를 편집할 수 있는 권한을 부여합니다.

이 작업은 새로운 버전의 체험을 Roblox에 게시할 수 있는 권한을 부여합니다.

체험 정보를 읽을 수 있는 권한을 부여합니다.

체험 정보를 편집할 수 있는 권한을 부여합니다.

Allows you to view user restrictions in the experience.

Allows you to edit user restrictions in the experience.

사용자의 Premium 및 인증 상태를 읽을 수 있는 권한을 부여합니다.

이를 통해 사용자의 소셜 계정을 볼 수 있습니다.

이 작업은 싱글 사인온 기능을 활성화합니다

프로필 정보를 읽을 수 있는 액세스 권한을 부여합니다

기본값: {defaultValueStart}{defaultValueEnd}

배열은 순서가 지정된 값 목록입니다. 배열은 데이터 컬렉션을 저장하는 데 유용합니다.

키-값 쌍 집합으로, 이때 키는 숫자, 문자열 또는 개체일 수 있습니다.

{tuples}(와)과 마찬가지로, 값의 목록입니다.

이 함수는 가능한 경우 즉시 반환하지만, 값을 반환할 수 있을 때까지 호출한 스레드를 일시 중단할 수 있습니다.

{nameStart}이름{nameEnd}(은)는 더 이상 Roblox에서 지원하거나 유지 관리하지 않습니다.

이 수학 연산은 더 이상 Roblox에서 지원하거나 유지 관리하지 않습니다.

이 멤버는 개체 브라우저에 표시되지 않으며 널리 사용하기 위한 것이 아닙니다.

이 멤버는 명령 모음을 통해서만 액세스할 수 있습니다. 스크립트에서 이 멤버에 액세스하려고 하면 오류가 발생합니다.

이 함수는 호출한 Lua 스레드를 일시 중지할 수 없습니다.

스크립트에서 이 멤버에 액세스하려고 하면 오류가 발생합니다. Roblox Studio의 속성 창에서 이 멤버에 액세스가 가능할 수 있습니다.

이 멤버는 Roblox Studio의 개체 브라우저에 표시되지 않습니다.

Instance.new 생성자로 이 클래스의 인스턴스를 만들 수 없습니다.

Roblox는 서버-클라이언트 경계를 넘어 이 멤버를 복제하지 않습니다.

Lua 코드는 이 멤버에 액세스할 수 없습니다. Roblox Studio의 속성 창에서 값의 변경이 가능할 수 있습니다.

이 개체의 복제 동작은 개체를 소유한 플레이어에 따라 다릅니다.

이 멤버는 명령 모음 및 플러그인을 통해서만 액세스할 수 있습니다. 스크립트에서 이 멤버에 액세스하려고 하면 오류가 발생합니다.

이 멤버는 읽기 전용입니다. 이 멤버에 쓰려고 하면 오류가 발생합니다.

이 속성은 읽기 전용이며 동기화되지 않은 스레드에서 안전하게 읽을 수 있습니다. 쓰기를 시도하면 오류가 발생합니다.

이 멤버는 CoreScript에서만 액세스할 수 있습니다.

Roblox CoreScript만 이 멤버에 액세스할 수 있으며, Players는 이를 사용할 수 없습니다.

여러 스레드에서 이 속성에 안전하게 읽고 쓸 수 있습니다.

이 클래스는 최상위 Singleton입니다. GetService 함수를 사용해 이 클래스의 인스턴스를 가져옵니다.

여러 스레드가 이 속성에 쓸 수 있으므로, 동기화되지 않은 스레드에서 읽는 것은 안전하지 않습니다.

이 함수는 결과를 반환할 때까지 호출한 Lua 스레드를 일시 중지합니다. 다른 스크립트를 방해하지 않습니다.

SurfaceGuiBase

요약

속성

메서드

이벤트

속성

Active

Adornee

Face

메서드

이벤트