UIBase

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

`UIBase` is the base class for UI layout and constraint classes.


An `Class.Actor` is a container for code that can be safely split into its own thread.

Class

Actor

Luau

Array

Dictionary

Data Type

An object that runs connected functions upon a specific occurrence.

RBXScriptSignal

Variant

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

Tổng Quan

Hướng Dẫn

Tham Khảo

Tài Nguyên

Nghệ Thuật

Thiết Kế

Động Cơ

Avatar

Đám Mây

Phương pháp này không đồng bộ và trả về một "Hoạt Động" cho biết trạng thái hiện tại của hoạt động. Phương pháp chứa một đường dẫn điểm cuối mà bạn có thể thăm dò để nhận về phản hồi thực tế và siêu dữ liệu hiện hành. Xem [tài liệu] ({longRunningOperationsLink}) về các hoạt động kéo dài để biết thêm thông tin.
            
Các phần dưới đây mô tả những phản hồi và siêu dữ liệu có được khi một hoạt động hoàn thành.

Các đầu cuối beta đã sẵn sàng cho việc sử dụng công khai. Có thể xuất hiện những thay đổi bất ngờ, nhưng trường hợp này rất hiếm.

Trường này có thể được đặt khi tạo tài nguyên, nhưng không thể được sửa đổi bởi các yêu cầu tiếp theo.

Trường này có thể được cung cấp trong các yêu cầu, nhưng sẽ không bao giờ được đưa vào các phản hồi.

Mỗi Khóa API: {maxInPeriod} yêu cầu mỗi {periodInSeconds} giây cho mỗi Địa Chỉ IP

Trường này có thể được đặt thành các phản hồi, nhưng sẽ bị bỏ qua trong các yêu cầu.

Cần có các quyền khóa API sau đây để gọi điểm cuối này. Để biết thêm
thông tin về cách tạo các khóa thích hợp, xem [Quản lý Khóa API] ({apiKeyReferenceDocLink}).

Các điểm cuối sau đây có trong đường dẫn liên quan đến URL cơ sở.

Chuỗi này được định dạng là [Mặt nạ trường](/cloud/reference/types#timestamp).

Giá trị JSON có thể là `null`, `boolean`, `string`, `number`, `array` hoặc `object`.

Cần có các phạm vi sau đây để ứng dụng OAuth 2.0 của bạn sử dụng điểm cuối này. Để biết thêm thông tin về cách đăng ký ứng dụng OAuth 2.0, hãy xem [Đăng Ký và Đánh Giá Ứng Dụng]({oauth2ReferenceDocLink}).

Các đối tượng sau đây mô tả payload được chấp nhận hoặc bị trả về. Xem từng điểm cuối để biết thêm thông tin về thời điểm sử dụng các đối tượng này.

Chuỗi này được định dạng là [Dấu thời gian](/cloud/reference/types#timestamp).

Không có mô tả nào được cung cấp.

Điều này cho phép bạn xem thông tin về tài sản của mình.

Điều này cho phép bạn tải lên và cập nhật tài sản vào Roblox.

Cấp khả năng cập nhật huy hiệu mà người dùng sở hữu.

Điều này cho phép bạn xem thông tin về vật phẩm thương mại của mình.

Điều này cho phép bạn chỉnh sửa các kết nối người bán thương mại.

Điều này cho phép bạn xem thông tin về các sản phẩm trong Cửa Hàng Nhà Sáng Tạo của bạn.

Điều này cho phép bạn sửa đổi thông tin về các sản phẩm trong Cửa Hàng Nhà Sáng Tạo của bạn.

Điều này cho phép bạn xem thông tin về nhóm của mình.

Điều này cho phép bạn quản lý các yêu cầu tham gia nhóm cho tài khoản của bạn.

Điều này cho phép bạn xem thông tin về kho của mình.

Cấp quyền truy cập để quản lý huy hiệu của bạn.

Cấp quyền để quản lý huy hiệu của bạn và chi tiêu robux.

Cấp quyền quản lý các sản phẩm phát triển của bạn.

Cấp quyền đọc thông tin về các trải nghiệm mà bạn đang theo dõi.

Cấp quyền thay mặt bạn theo dõi và bỏ theo dõi các trải nghiệm.

Cấp quyền truy cập để quản lý vé của bạn.

Cấp quyền truy cập để quản lý các nhóm của bạn.

Cấp quyền để đọc thông tin nhóm.

Cấp quyền để đọc và ghi các bảng bản địa hóa của bạn

Cấp quyền truy cập để quản lý hoạt động cộng tác đội cho tất cả các trải nghiệm của bạn.

Cấp quyền truy cập để quản lý các trải nghiệm của bạn và một số thông tin cụ thể gắn liền với các trải nghiệm đó (ví dụ: thông tin bản địa hóa).

Cấp quyền để đọc thông tin bản địa hóa của các trải nghiệm của bạn.

Cấp quyền để sửa đổi các tùy chọn bản địa hóa trải nghiệm của bạn.

Cấp quyền truy cập để quản lý tài khoản người dùng của bạn.

Cấp quyền để sửa đổi các tùy chọn bản địa hóa của người dùng.

Điều này cho phép bạn đăng tải tin nhắn thay mặt cho người dùng.

Điều này cho phép gửi các thông báo từ trải nghiệm của bạn đến người dùng.

Điều này cho phép bạn liệt kê mã liên quan đến trải nghiệm của bạn.

Điều này cho phép bạn tạo và cập nhật mã liên quan đến trải nghiệm của bạn.

Cấp quyền để đọc về các trang bị đặc quyền của bạn.

Cấp khả năng đọc thông tin địa điểm.

Cấp khả năng chỉnh sửa thông tin địa điểm.

Thao tác này cấp quyền đăng tải các phiên bản mới của trải nghiệm cho Roblox.

Cấp khả năng đọc thông tin trải nghiệm.

Cấp khả năng chỉnh sửa thông tin trải nghiệm.

Cho phép bạn xem các hạn chế của người dùng trong trải nghiệm.

Cho phép bạn chỉnh sửa các hạn chế người dùng trong trải nghiệm.

Cấp khả năng đọc trạng thái premium và trạng thái đã xác thực của người dùng.

Điều này cho phép bạn xem các tài khoản mạng xã hội của người dùng.

Điều này cho phép kích hoạt chức năng Đăng Nhập Một Lần.

Điều này cho phép người dùng đọc thông tin hồ sơ của bạn.

Giá Trị Mặc Định: {defaultValueStart}{defaultValueEnd}

Mảng là danh sách các giá trị được sắp xếp theo thứ tự. Mảng rất hữu ích để lưu trữ các bộ dữ liệu.

Một tập hợp các cặp giá trị khóa, trong đó khóa có thể là bất kỳ số, chuỗi hoặc đối tượng nào.

Chẳng hạn {tuples}, một danh sách các giá trị.

Hàm này sẽ trả về kết quả ngay lập tức nếu có thể, nhưng cũng có khả năng tạm dừng luồng đã gọi hàm cho đến khi hàm có giá trị để trả về.

{nameStart}tên{nameEnd} không còn được hỗ trợ hoặc duy trì bởi Roblox.

Phép toán này không còn được hỗ trợ hoặc duy trì bởi Roblox.

Thành phần này không xuất hiện trong trình duyệt đối tượng và không dành cho mục đích sử dụng rộng rãi.

Chỉ có thể truy cập thành phần thông qua thanh lệnh. Việc sử dụng thành phần này trong kịch bản sẽ gây ra lỗi.

Hàm này không thể tạm dừng luồng Lua đã gọi hàm.

Việc cố gắng truy cập thành phần này trong kịch bản sẽ gây ra lỗi. Tuy nhiên, bạn có thể truy cập thành phần này từ cửa sổ thuộc tính của Roblox Studio.

Thành phần này không xuất hiện trong Trình duyệt Đối tượng của Roblox Studio.

Bạn không thể tạo một phiên bản của lớp này với hàm khởi tạo Instance.new.

Roblox không sao chép thành phần này qua ranh giới máy chủ - máy khách.

Mã Lua không thể truy cập thành phần này. Bạn có thể thay đổi giá trị của nó từ cửa sổ thuộc tính trong Roblox Studio.

Thành viên này có thể truy cập từ các nhiệm vụ thực thi OpenCloud Luau.

Hành vi sao chép của đối tượng này phụ thuộc vào người chơi sở hữu nó.

Có thể truy cập thành phần thông qua thanh lệnh và plugin. Việc sử dụng thành phần này trong tập lệnh sẽ gây ra lỗi.

Thành phần này ở dạng chỉ đọc. Việc cố ghi vào thành phần này sẽ gây ra lỗi.

Thuộc tính này ở dạng chỉ đọc và có thể đọc an toàn trên các luồng không đồng bộ. Việc cố gắng ghi vào thuộc tính này sẽ gây ra lỗi.

Chỉ có thể truy cập thành phần này trong CoreScripts.

Chỉ Roblox CoreScripts mới có thể truy cập thành phần này, và Người Chơi không thể truy cập được.

Bạn có thể đọc và ghi vào thuộc tính này một cách an toàn từ nhiều luồng.

Lớp này là một singleton hàng đầu. Hãy lấy một phiên bản của lớp này bằng hàm GetService.

Nhiều luồng có thể ghi thuộc tính này, vì vậy việc đọc từ các luồng không đồng bộ sẽ là một việc không an toàn.

Hàm này sẽ tạm dừng luồng Lua đã gọi hàm cho đến khi hàm này trả về một kết quả. Tuy nhiên, việc tạm dừng này không ảnh hưởng đến các kịch bản khác đang chạy.

UIBase

Tóm Tắt

Thuộc Tính

Phương Pháp

Sự Kiện

Thuộc Tính

Phương Pháp

Sự Kiện