The below example prints out the value of the topbar transparency when it
changes.


PlayerGui.TopbarTransparencyChangedSignal

transparency

The following line of code prints the transparency of the topbar.


PlayerGui:GetTopbarTransparency

The following line of code makes the Topbar appear fully opaque.


This code sample demonstrates how you can create a custom-styled topbar. Paste
it into a `Class.LocalScript` placed within `Class.StarterPlayerScripts`.


PlayerGui:SetTopbarTransparency

PlayerGui

PlayerGui.CurrentScreenOrientation

PlayerGui.ScreenOrientation

PlayerGui.SelectionImageObject

All GUIs returned by `Class.BasePlayerGui:GetGuiObjectsAtPosition()` are
'cloned' by the `highlightAsFrame()` local function, which creates a `Frame`
GUI positioned on top of the specified GUI that is semi-transparent and the
same `Class.GuiBase2d.AbsoluteSize` and `Class.GuiBase2d.AbsolutePosition`.

These highlights are added to the HighlightsContainer `ScreenGui` in the
Highlight folder of the player's PlayerGui folder. Both are created by the
code sample. All highlight GUIs are `Class.Instance:Destroy()`ed every time
`highlightGui()` executes.

Note that HighlightContainer's `Class.ScreenGui.DisplayOrder` is 99999, a
large number, so that it is unlikely any other GUI will render on top of the
highlight GUIs.


BasePlayerGui:GetGuiObjectsAtPosition

BasePlayerGui

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

玩家目前渲染的容器 `Class.ScreenGui|ScreenGuis` .

Class.Actor 是一個可以安全分離在自己的子線程中的代碼。

Class

Actor

Luau

Array

Dictionary

一個抽象類型的 2D 用戶界面對象。

GuiObject

Data Type

連接到特定發生時執行的對象。

RBXScriptSignal

手持設備上的遊戲螢幕方向的首選項。

Enum

Enum.ScreenOrientation

Variant

bool

number

字母、數字和符號等的一系列字符。

string

void

概覽

指南

教學

參考

資源

美術

設計

引擎

虛擬人偶

舊版本

雲端

此方式不同步且返回「操作」，這代表操作的目前狀態。它包含終點路徑，您可以取用以獲得實際回應和適用的中繼資料。詳情請參閱長期執行操作上的 [文件]({longRunningOperationsLink})。
            
以下部分描述操作完成時提供的回應和中繼資料物件。

Beta 測試終點已準備好公開使用。可能出現導致功能無法正常運作的變更，但機率不高。

建立資源時可設定此欄位，但可能無法在後續請求中修改。

此欄位可在請求中提供，但永遠不會包含在回應中。

每個 API 金鑰：每個 IP 位址每 {periodInSeconds} 秒 {maxInPeriod} 個請求

此欄位可在回應中設定，但將在請求中被忽略。

調用此端點需要以下 API 金鑰權限。有關
產生正確金鑰的更多資訊，請查看 [管理 API 金鑰]（{apiKeyReferenceDocLink}）。

根據相對基本網址的路徑，可使用下列終點。

此字串的格式為 [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。

讓您檢視體驗中的使用者限制。

讓您在體驗中編輯使用者限制。

授予讀取使用者高級會員狀態與驗證狀態的能力。

這能讓您檢視使用者的社群帳號。

這將授予讀取您個人檔案資訊的權限。

預設值：{defaultValueStart}{defaultValueEnd}

陣列是值的有序列表。陣列在儲存資料組合時很實用。

一組鍵值對，鍵可以是任何數字、字串或物件。

此函式將允許時將會立刻傳回，但在能傳回值之前可以暫停呼叫自己的執行緒。

Roblox 已不再支援或維護 {nameStart}name{nameEnd}。

Roblox 已不再支援或維護這項數學運算。

此成員未在物件瀏覽器出現，不應廣泛使用。

此成員只能透過指令列存取。從指令碼存取此成員將會導致錯誤。

此函式無法暫停呼叫自己的 Lua 執行緒。

在指令碼存取此成員將會導致錯誤。您可能可以從 Roblox Studio 的屬性視窗存取此成員。

此成員不再 Roblox Studio 的物件瀏覽器中。

您無法使用 Instance.new 建構式建立此類別的個體。

Roblox 不會跨越伺服器與用戶端界限而複製此成員。

Lua 程式碼無法存取此成員。您可能可以從 Roblox Studio 的屬性視窗變更其值。

此成員可從 OpenCloud Luau 執行任務存取。

此物件的複製行為取決於擁有的玩家。

此成員能透過指令列和外掛程式存取。從指令碼存取此成員將會導致錯誤。

此為唯讀成員。寫入此成員將會導致錯誤。

此為唯讀屬性，可以在未同步的執行緒讀取。嘗試寫入將會導致錯誤。

只有 Roblox CoreScript 可以存取此成員，Player 不可使用。

您可以安全地從多個執行緒對此屬性讀寫。

此類別為頂層 Singleton。使用 GetService 函式取得此類別的個體。

多個執行緒可以寫入此屬性，從未同步的執行緒讀取將有風險。

此函式在傳回結果前將會暫停呼叫自己的執行緒。此操作不會中斷其他指令碼。

PlayerGui

概要

屬性

方法

活動

屬性

CurrentScreenOrientation

ScreenOrientation

SelectionImageObject

方法

活動