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

Class.Actor는 코드를 자체 스레드로 안전하게 분할할 수 있는 컨테이너입니다.

Class

Actor

Luau

Array

Dictionary

모든 2D 사용자 인터페이스 개체에 대한 개요 클래스.

GuiObject

인스턴스에 대한 빌더를 보관합니다.

Data Type

LocalizationTable 은 번역 데이터베이스입니다. 여기에는 다양한 언어에 대한 원본 문자열과 번역이 포함됩니다.

LocalizationTable

NormalId 열에는 부품의 어느 측면/얼굴이 사용되는지 설정합니다.

Enum

Enum.NormalId

특정 발생 시 연결된 함수를 실행하는 개체입니다.

RBXScriptSignal

Class.GuiBase2d.SelectionGroup가 진실인 경우 게임 패드 선택 옵션.

Enum.SelectionBehavior

Variant

방향과 크기를 가진 2D 값을 나타냅니다.

Vector2

Class.GuiObject.ZIndex 속성을 하위 자식에게 제어하는 데 사용됩니다.

Enum.ZIndexBehavior

값이 true 또는 false인 데이터 형식입니다.

bool

두 자릿수 부동 소수점 숫자입니다.

number

문자, 숫자 및 기호와 같은 시퀀스.

string

void

개요

가이드

튜토리얼

참조

리소스

아트

디자인

엔진

아바타

레거시(기존)

클라우드

비동기적 방식으로, 현재 작업 상태를 나타내는 '작업'을 반환합니다. 여기에는 투표를 진행하여 실제 응답과 적용 가능한 메타데이터를 얻을 수 있는 엔드포인트 경로가 포함됩니다. 자세한 정보는 장기 작업에 관한 [설명서]({longRunningOperationsLink})에서 확인하세요.
            
아래 섹션은 작업 완료 시 제공되는 응답 및 메타데이터 개체에 대한 설명입니다.

베타 끝점이 공개적으로 사용될 준비가 되었습니다. 중대한 변경이 발생할 수 있지만 가능성은 낮습니다.

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

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

각 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에 업로드하고 업데이트할 수 있습니다.

사용자가 소유한 배지를 업데이트할 수 있는 권한을 부여합니다.

이를 통해 상거래 아이템에 대한 정보를 볼 수 있습니다.

이를 통해 상거래 판매자 연결을 편집할 수 있습니다.

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

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

이를 통해 커뮤니티에 대한 정보를 볼 수 있습니다.

이를 통해 계정에 대한 커뮤니티 가입 요청 및 역할 업데이트를 관리할 수 있습니다.

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

내 배지를 관리할 수 있는 액세스 권한을 부여합니다.

내 배지를 관리하고 Robux를 사용할 수 있는 액세스 권한을 부여합니다.

내 개발자 상품을 관리할 수 있는 액세스 권한을 부여합니다.

팔로우 중인 체험에 대한 정보를 읽을 수 있는 액세스 권한을 부여합니다.

나를 대신해 체험을 팔로우 및 언팔로우할 수 있는 권한을 부여합니다.

내 패스를 관리할 수 있는 액세스 권한을 부여합니다.

내 커뮤니티를 관리할 수 있는 권한을 부여합니다.

커뮤니티 정보를 읽을 수 있는 권한을 부여합니다.

커뮤니티 관리 권한을 부여합니다.

내 로컬라이제이션 테이블을 읽고 쓸 수 있는 액세스 권한을 부여합니다

소유한 모든 체험의 팀 공동 작업을 관리할 수 있는 권한을 부여합니다.

체험 및 체험과 관련된 특정 정보를 관리할 자격을 부여합니다(예: 로컬라이제이션 정보).

내 체험의 로컬라이제이션 정보를 읽을 수 있는 액세스 권한을 부여합니다.

내 체험의 로컬라이제이션 기본 설정을 수정할 수 있는 액세스 권한을 부여합니다.

내 사용자 계정을 관리할 수 있는 권한을 부여합니다.

사용자 로컬라이제이션 기본 설정을 수정할 수 있는 액세스 권한을 부여합니다.

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

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

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

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

구독 상품에 대해 읽을 수 있는 액세스 권한을 부여합니다.

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

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

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

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

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

체험에서 사용자 제한을 볼 수 있습니다.

체험에서 사용자 제한을 편집할 수 있습니다.

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

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

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

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

SurfaceGuiBase

요약

속성

메서드

이벤트

속성

Active

Adornee

Face

메서드

이벤트