`Class.SurfaceGui` 允許將 UI 對象渲染到零件的
表面上，並且允許進行基本的用戶互動。類似於 `Class.Decal|Decals` 和 `Class.Texture|Textures`，子母與 `Class.SurfaceGui` 的 UI
對象（例如 `Class.TextLabel|TextLabels` 和
`Class.ImageLabel|ImageLabels`）面朝它們所在表面的相同方向，可通過
`Class.SurfaceGui.Face|Face` 屬性進行編輯。

<img src="/assets/ui/in-experience/SurfaceGui-Diagram.jpg" width="800" alt="在一個 3D 部件上使用 SurfaceGui 並帶有 ImageLabel 子元素以描繪屏幕控制台的圖示。" />

請注意，像 `Class.ImageButton|ImageButtons` 和
`Class.TextButton|TextButtons` 這樣的交互式 UI 元素，如果它們不在 `Class.PlayerGui` 中，則將不會接收用戶輸入，這通常是通過將 `Class.SurfaceGui` 放在 `Class.StarterGui` 中來進行的（`Class.SurfaceGui.Adornee|Adornee` 屬性可用於定位 3D 世界中的部件，而 `Class.SurfaceGui` 本身仍然保留在 `Class.PlayerGui` 中）。此外，該零件的 `Class.BasePart.CanQuery|CanQuery` 屬性必須為 `true`，以便交互式 UI 元素可以接收輸入。

請參閱 [體驗中的 UI](/ui/in-experience-containers#surface-ui) 以獲取有關使用 `Class.SurfaceGui` 容器的指南。

##### 緩存行為

為了幫助提高性能，`Class.SurfaceGui` 的外觀會被緩存，直到觸發以下情況之一，之後在下一幀渲染時將重新計算其外觀。

- 有後代被添加到或移除掉 `Class.SurfaceGui`。
- `Class.SurfaceGui` 的任何後代的屬性發生更改。
- `Class.SurfaceGui` 本身的屬性發生變更。


SurfaceGui

此屬性決定 `Class.SurfaceGui` 是否始終渲染在其他 3D 對象之上。

當設置為 `false`（默認值）時，`Class.SurfaceGui` 像其他
3D 內容一樣渲染，並且會被其他 3D 對象遮擋。當設置為 `true` 時，
`Class.SurfaceGui` 始終渲染在 3D 內容之上，外觀發生顯著變化：

- 顏色與它們在 `Class.ScreenGui` 中的外觀相匹配。
- 在高 DPI 設備上，文本可能顯得更銳利。
- `Class.SurfaceGui.LightInfluence|LightInfluence` 被視為 `0`。
- `Class.SurfaceGui.Brightness|Brightness` 沒有影響。


SurfaceGui.AlwaysOnTop

決定 `Class.SurfaceGui` 是否始終渲染在其他 3D 對象之上。


此屬性決定在 `Class.SurfaceGui.LightInfluence|LightInfluence` 為 `0` 時，`Class.SurfaceGui` 容器的光源強度縮放因素。默認情況下，這個屬性為 `1`，可以設置為 `0` 到 `1000` 之間的任何數字。通過修改此屬性，`Class.SurfaceGui` 的表觀亮度可以更好地與其環境匹配。例如，可以通過將 `Class.SurfaceGui.Brightness|Brightness` 增加到 `10` 來在黑暗的房間裡提高視頻廣告牌的亮度。

請注意，`Class.SurfaceGui.Brightness|Brightness` 在 Studio 中不可訪問，並在 `Class.SurfaceGui.LightInfluence|LightInfluence` 為 `1` 或 `Class.SurfaceGui.AlwaysOnTop|AlwaysOnTop` 為 `true` 時不會產生影響。


SurfaceGui.Brightness

決定在 `Class.SurfaceGui.LightInfluence|LightInfluence` 為 `0` 時，`Class.SurfaceGui` 容器的光源強度縮放因素。


在「虛擬像素」中給出一個「虛擬螢幕」的大小，使 `Class.SurfaceGui|SurfaceGuis` 與 `Class.ScreenGui|ScreenGuis` 像素對像素兼容。


SurfaceGui.CanvasSize

當設置為 `true` （默認值）時，落在 `Class.SurfaceGui` 畫布邊界之外的 `Class.GuiObject|GuiObjects` 的部分不會被繪製。

即使此屬性為 `false`，完全在畫布之外的 `Class.GuiObject|GuiObjects` 也不會被渲染。


SurfaceGui.ClipsDescendants

決定落在 `Class.SurfaceGui` 畫布邊界之外的 `Class.GuiObject|GuiObjects` 的部分是否會被繪製。


控制 `Class.SurfaceGui` 受環境照明影響的程度，範圍從 `0` 到 `1`。設置為 `1` 意味著周圍的光源對外觀有完全的控制，而設置為 `0` 則意味著光線不會有任何影響。


SurfaceGui.LightInfluence

控制 `Class.SurfaceGui` 受環境照明影響的程度。


此屬性控制 `Class.SurfaceGui` 在距離相機多遠的情況下會被顯示，之後將停止渲染。值為 `0` 表示無限制，將無限遠地渲染。默認值 `1000` 在大多數情況下工作良好。

對於出現在戶外的 `Class.SurfaceGui|SurfaceGuis`，建議將 `Class.SurfaceGui.MaxDistance|MaxDistance` 設置得足夠高，以確保容器的 UI 在顯示或消失的時候在屏幕上呈現的大小足夠小，以最小化突兀的瞬間出現/消失效果。


SurfaceGui.MaxDistance

控制 `Class.SurfaceGui` 能夠顯示的最遠距離，在此距離之前停止渲染。


此屬性決定用於每個世界空間螺栓的像素密度，以渲染 `Class.SurfaceGui` 的內容。如果保持相同大小，則較高的值將導致其中的各種 `Class.GuiObject|GuiObjects` 顯得較小。相反，較低的值將導致物體顯得較大。然而，如果通過使用 `Class.UIScale`、`Class.GuiObject.Size`、`Class.TextLabel.TextSize` 或類似的方式進行了比例縮放，則此屬性允許使用更高的定義。

根據您預期的玩家觀察 `Class.SurfaceGui` 的距離選擇值是很重要的。請注意，較大的像素密度可能會對性能產生負面影響，尤其是在裝飾的部件表面足夠大時。


SurfaceGui.PixelsPerStud

決定用於每個世界空間螺栓的像素密度，以渲染 `Class.SurfaceGui` 的內容。


當設置為 `Enum.SurfaceGuiSizingMode.PixelsPerStud`（默認值）時，`Class.SurfaceGui` 根據 `Class.SurfaceGui.PixelsPerStud|PixelsPerStud` 與表面的大小在螺栓中進行變量大小渲染。

當設置為 `Enum.SurfaceGuiSizingMode.FixedSize` 時，`Class.SurfaceGui` 通過 `Class.SurfaceGui.CanvasSize|CanvasSize` 設置固定大小。


SurfaceGui.SizingMode

決定 `Class.SurfaceGui` 是固定大小渲染還是隨著其在螺栓中的大小進行縮放。


設置左鍵單擊開始作用於 `Class.SurfaceGui` 而不是持有的 `Class.Tool` 的距離。如果角色位於 `Class.SurfaceGui` 的這個距離內，則 `Class.Tool` 將不會在單擊時激活。


SurfaceGui.ToolPunchThroughDistance

設置左鍵單擊開始作用於 `Class.SurfaceGui` 而不是持有的 `Class.Tool` 的距離。


將這個 `Class.SurfaceGui` 與同一面上的其他對象進行層次化（更改這個不會視覺上將 `Class.SurfaceGui` "提升" 或 "沉沒" 從表面）。


SurfaceGui.ZOffset

將此 `Class.SurfaceGui` 與同一面上的其他 `Class.SurfaceGui|SurfaceGuis` 進行層次化。


用於渲染在零件表面的 GuiObjects 的容器。


SurfaceGuiBase

此屬性決定 `Class.SurfaceGui` 是否會接受輸入，
例如如果父項或 `Class.SurfaceGuiBase.Adornee|Adornee` 部件
包含 `Class.ClickDetector` 類別如 `Class.DragDetector`。

請注意，像 `Class.ImageButton|ImageButtons`
和 `Class.TextButton|TextButtons` 這類的互動 UI 元素
僅在它們的父項為 `Class.PlayerGui` 時才會接收用戶輸入（`Class.SurfaceGui.Adorneee` 屬性可以用來針對 3D 世界中的部分，
而 `Class.SurfaceGui` 本身仍然在 `Class.PlayerGui` 中）。此外，部分的
`Class.BasePart.CanQuery|CanQuery` 屬性必須為 `true`，
才可使互動 UI 元素接收輸入。


SurfaceGuiBase.Active

`Class.BasePart` 用來應用 `Class.SurfaceGui`，覆寫預設的父項關聯。


SurfaceGuiBase.Adornee

`Enum.NormalId` `Class.SurfaceGui` 父項（或其 `Class.SurfaceGuiBase.Adornee|Adornee`）的面朝向，應用 `Class.SurfaceGui`。


SurfaceGuiBase.Face

`Enum.NormalId` 面朝向，應用 `Class.SurfaceGui`。


**LayerCollector** 是 2D UI 容器的基類，這些容器渲染 `Class.GuiObject` 的子類，
例如 `Class.ScreenGui`。

為了提高性能，`Class.LayerCollector` 的外觀會被快取，直到發生以下事件中的一個：

- 添加或移除了一個子類。
- 子類的屬性發生變更。
- `Class.LayerCollector` 本身的屬性發生變更。

LayerCollector:GetLayoutNodeTree

LayerCollector

切換此 `Class.LayerCollector` 的可見性。當為 `false` 時，
UI 內容將不會渲染、處理用戶輸入或響應更改。

LayerCollector.Enabled

切換此 `Class.LayerCollector` 的可見性。

當設置為 `false` 且此 `Class.LayerCollector` 是 `Class.StarterGui` 的直接子類時，
它只會複製到每個玩家的 `Class.PlayerGui` 一次，並且在玩家的角色重生時不會被刪除。

當設置為 `true` （默認值），或如果此 `Class.LayerCollector` 是 `Class.StarterGui` 的
**間接** 子類時，當玩家的角色重生時，它將被複製到每個玩家的 `Class.PlayerGui`，並且
當玩家的角色再次重生時，它將刪除自己。

LayerCollector.ResetOnSpawn

確定每次玩家的角色重生時，`Class.LayerCollector` 是否重置（刪除自己並
重新複製到玩家的 `Class.PlayerGui`）。

控制此 `Class.LayerCollector` 所有後代上的 `Class.GuiObject.ZIndex` 如何行為。

使用 `Enum.ZIndexBehavior.Sibling`（預設值），子物件總是渲染在父物件之上，並且 `Class.GuiObject.ZIndex|ZIndex` 用於決定單個 UI 物件的子物件將如何重疊渲染的順序。

`Enum.ZIndexBehavior.Global` 根據 `Class.GuiObject.ZIndex|ZIndex` 對所有後代進行排序，然後使用層級順序打破平局。因此，`Class.GuiObject` 的後代需要有一個至少和父物件一樣高的 `Class.GuiObject.ZIndex|ZIndex` 值，否則他們將渲染在父物件下面。


LayerCollector.ZIndexBehavior

控制此 `Class.LayerCollector` 所有後代上的 `Class.GuiObject.ZIndex` 如何行為。


2D UI 容器的基類，該容器在層中渲染 `Class.GuiObject|GuiObjects`

`Class.GuiBase2d` 是由 2D `Class.GuiObject|GuiObjects` 繼承的抽象類別。


當遊戲手柄的選擇移動到、離開或在連接的 `Class.GuiBase2d` 或任何子代 `Class.GuiObject|GuiObjects` 中更改時，將觸發此事件。當選擇高亮移動到 `Class.GuiObject` 時，事件將從該 `Class.GuiObject` 冒泡到其所有祖先，告知他們選擇已更改/進入/離開其子代樹中的 `Class.GuiObject`。


GuiBase2d.SelectionChanged

amISelected

如果新的選擇與附加的 GuiBase2d 匹配，則為 true。


previousSelection

newSelection

當遊戲手柄的選擇移動到、離開或在連接的 `Class.GuiBase2d` 或任何子代 `Class.GuiObject|GuiObjects` 中更改時觸發。


GuiBase2d

`Class.GuiBase2d.AbsolutePosition|AbsolutePosition` 是一個唯讀屬性，提供 `Class.GuiBase2d` 元素的螢幕位置，以像素為單位。這表示元素的實際像素位置，取決於其祖先的大小和位置。請注意，`Class.GuiBase2d.AbsolutePosition|AbsolutePosition` 始終代表 `Class.GuiBase2d` 元素的左上角。

如果 `Class.GuiBase2d` 位於 `Class.ScreenGui` 中，則 `Class.GuiBase2d.AbsolutePosition|AbsolutePosition` 屬性使用 `Enum.ScreenInsets|CoreUISafeInsets` 視口座標系統。該座標系統的原點位於 Roblox 頂部工具欄的左下角。請注意，這與 `Class.InputObject.Position` 屬性使用的座標系統相同。

<img src="/assets/engine-api/classes/GuiBase2d/AbsolutePositionCoordinateSystem.png" width="840" alt="顯示 AbsolutePosition 座標系統原點的圖示." />

另請參考 `Class.GuiBase2d.AbsoluteRotation|AbsoluteRotation` 和 `Class.GuiBase2d.AbsoluteSize|AbsoluteSize`。


GuiBase2d.AbsolutePosition

描述 `Class.GuiBase2d` 元素的實際螢幕位置，以像素為單位。


`Class.GuiBase2d.AbsoluteRotation|AbsoluteRotation` 是一個唯讀屬性，描述 `Class.GuiBase2d` 元素的實際螢幕旋轉，以度為單位。它不會進行邊界檢查，因此其值可能不在 `0` 到 `360` 的範圍內。

另請參考 `Class.GuiBase2d.AbsolutePosition|AbsolutePosition` 和 `Class.GuiBase2d.AbsoluteSize|AbsoluteSize`。


GuiBase2d.AbsoluteRotation

描述 `Class.GuiBase2d` 元素的實際螢幕旋轉，以度為單位。


`Class.GuiBase2d.AbsoluteSize|AbsoluteSize` 是一個唯讀屬性，描述 `Class.GuiBase2d` 元素的實際螢幕大小，以像素為單位。

另請參考 `Class.GuiBase2d.AbsolutePosition|AbsolutePosition` 和 `Class.GuiBase2d.AbsoluteRotation|AbsoluteRotation`。


GuiBase2d.AbsoluteSize

描述 `Class.GuiBase2d` 元素的實際螢幕大小，以像素為單位。


當設置為 `true` 時，本 `Class.GuiBase2d` 及其子代將應用本地化。用於本地化的條目與 `Class.LocalizationService:GetTableEntries()` 返回的條目相同。啟用 `Class.GuiBase2d.AutoLocalize|AutoLocalize` 的條目在雲表格加載後會自動重新翻譯（如果需要）。

另請參考 `Class.GuiBase2d.RootLocalizationTable|RootLocalizationTable`。


GuiBase2d.AutoLocalize

當設置為 `true` 時，本 `Class.GuiBase2d` 及其子代將應用本地化。


當本地化表格的 `Class.LocalizationTable.Root` 針對此物件或其祖先時，此屬性自動設置為 true。具有 `Class.LocalizationTable.Root` 屬性指向實例的 `Class.LocalizationTable|LocalizationTables` 將對根實例的所有 `Class.TextLabel.TextButton` 子代進行本地化。


GuiBase2d.Localize

當本地化表格的 `Class.LocalizationTable.Root` 針對此物件或其祖先時，自動設置為 true。


引用要用於對本 `Class.GuiBase2d` 及其子代進行自動化本地化的 `Class.LocalizationTable`。`Class.GuiBase2d.AutoLocalize|AutoLocalize` 必須在 `Class.GuiBase2d` 及其祖先上設置為 `true`，以應用自動化本地化。

您可以在 `Class.DataModel` 中的任何位置設置此引用，以引用 `Class.LocalizationTable`。`Class.GuiBase2d` 物件及其所有子女將嘗試使用該特定的 `Class.LocalizationTable` 及其祖先進行自動文本替換，然後使用 `Class.LocalizationService` 下的表格，順序不定，然後使用雲表格。

如果在引用的表格中沒有可用的翻譯，它會查找該表格的父級中是否也有 `Class.LocalizationTable`，以此類推。

另請參考 `Class.LocalizationService:GetTableEntries()`，該方法解釋了 `Class.GuiBase2d.RootLocalizationTable|RootLocalizationTable` 如何用於自動化本地化。


GuiBase2d.RootLocalizationTable

引用要用於對本 `Class.GuiBase2d` 及其子代進行自動化本地化的 `Class.LocalizationTable`。


自定義遊戲手柄在向下方向的選擇行為。


GuiBase2d.SelectionBehaviorDown

自定義遊戲手柄在向左方向的選擇行為。


GuiBase2d.SelectionBehaviorLeft

自定義遊戲手柄在向右方向的選擇行為。


GuiBase2d.SelectionBehaviorRight

自定義遊戲手柄在向上方向的選擇行為。


GuiBase2d.SelectionBehaviorUp

允許自定義遊戲手柄在選擇群組中的按鈕之間如何移動，離開群組，並選擇其他按鈕。

將 `Class.GuiBase2d.SelectionGroup|SelectionGroup` 設置為 `true` 會顯露 `Class.GuiBase2d.SelectionBehaviorUp|SelectionBehaviorUp`、`Class.GuiBase2d.SelectionBehaviorDown|SelectionBehaviorDown`、`Class.GuiBase2d.SelectionBehaviorLeft|SelectionBehaviorLeft` 和 `Class.GuiBase2d.SelectionBehaviorRight|SelectionBehaviorRight` 屬性。對於這些選擇行為，設置為 `Enum.SelectionBehavior.Escape`（預設值）意味著遊戲手柄選擇首先嘗試在選擇群組內查找選擇，只有在未找到合適按鈕時才移動到外部。或者，設置為 `Enum.SelectionBehavior.Stop` 意味著遊戲手柄選擇僅在選擇群組內查找，並且不會從選擇行為方向移動到群組外部。


GuiBase2d.SelectionGroup

允許自定義遊戲手柄選擇移動方式。


由 2D `Class.GuiObject|GuiObjects` 繼承的抽象類別。


GuiBase 是一個抽象類別，大多數圖形使用者介面物件
繼承自此類別。


GuiBase

`Instance` 是 Roblox 類別階層中所有類別的基礎類別，可以是 `Class.DataModel` 樹的一部分。

無法直接創建根 `Instance` 物件，但特殊的 `Datatype.Instance.new()` 建構函數通過代碼創建物件，以類別名稱作為參數並返回所創建的物件。

展示如何通過連接到 `Class.Instance.AncestryChanged` 事件來檢測實例的祖先變化。

ChangingPart 的 Parent 隨著時間設置為不同的值。部分的父項是該部分的祖先，因此每當發生變化時，`Class.Instance.AncestryChanged` 事件將被觸發。


當此實例被重新父級化或其任何祖先被重新父級化時觸發。

您可以使用此事件來跟踪 Studio 中實例的刪除，例如在 Explorer 中的手動刪除或通過插件。如果您需要檢測實例是否使用 `Class.Instance:Destroy()` 被銷毀，請使用 `Class.Instance.Destroying` 事件。

Instance.AncestryChanged

child

其 `Class.Instance.Parent|Parent` 屬性改變的實例，可以是這個實例或更遠的祖先，**不一定**是處理程序連接的實例。

parent

當此對象或其任何祖先的 `Class.Instance.Parent` 屬性發生變更時觸發。

這個事件在實例上的任何屬性發生變更時觸發，包括當屬性被設置為 `nil` 時。變更的屬性的名稱將傳遞到連接的函數。

例如，以下代碼片段連接 `attributeChanged()` 函數，使其在部件的任一屬性變更時觸發：

```lua
local Workspace = game:GetService("Workspace")

local part = Workspace.Part

local function attributeChanged(attributeName)
	print(attributeName, "changed")
end

part.AttributeChanged:Connect(attributeChanged)
```
另見 `Class.Instance:GetAttributeChangedSignal()`，該方法返回在特定給定屬性變更時觸發的事件。

Instance.AttributeChanged

attribute

每當 `Class.Instance` 上的屬性發生變更時觸發。

當物件被加入到工作區時，此片段會打印物件名稱：

當一個對象被父級化到此 `Class.Instance` 後觸發。

注意，在客戶端使用此方法來檢測服務器創建的對象時，索引這些對象的後代時需要使用 `Class.Instance:WaitForChild()`。這是因為對象及其後代不保證會同時從服務器流複製到客戶端。例如：

```
local Workspace = game:GetService("Workspace")

Workspace.ChildAdded:Connect(function(child)
	-- 使用 WaitForChild() 因為後代可能尚未複製
	local head = child:WaitForChild("Head")
end)
```
注意，此事件僅僅對 `Class.Instance` 的直接子項有效。若要捕獲所有後代的事件，請使用 `Class.Instance.DescendantAdded`。

另見 `Class.Instance.ChildRemoved`。

Instance.ChildAdded

當一個對象被父級化到此 `Class.Instance` 後觸發。

Instance.childAdded

這段程式碼會在物件從

工作空間中移除時，印出其名稱：

當一個子項從此 `Class.Instance` 中被移除後觸發。

移除是指對象的父項從這個 `Class.Instance` 更改為其他不是這個 `Class.Instance` 的對象。注意，當子項被銷毀（使用 `Class.Instance:Destroy()`）時，這個事件也會觸發，因為銷毀函數將對象的父項設置為 `nil`。

此事件僅僅對 `Class.Instance` 的直接子項有效。若要捕獲所有後代的事件，請使用 `Class.Instance.DescendantRemoving`。

另見 `Class.Instance.ChildAdded`。

Instance.ChildRemoved

當一個子項從此 `Class.Instance` 中被移除後觸發。

以下範例會打印任何被添加到

工作空間的物件名稱:

這個事件在後代被添加到 `Class.Instance` 後觸發。

由於它會對每個後代觸發，將一個對象父級化到 `Class.Instance` 將會依次觸發此對象及其所有後代的事件。

如果您只關心 `Class.Instance` 的 **直接子項**，則應改用 `Class.Instance.ChildAdded`。

另見 `Class.Instance.DescendantRemoving`。

Instance.DescendantAdded

descendant

當一個後代被添加到 `Class.Instance` 後觸發。

以下範例在任何後代被移除時打印其名稱

從 Workspace 中：

這個事件在父項 `Class.Instance` 的改變前 **立即觸發**，使得 **後代** 實例不再是後代。`Class.Instance:Destroy()|Destroy()` 將會將實例的 `Class.Instance.Parent|Parent` 更改為 `nil`，因此在父級後代上調用該方法將導致此事件被觸發。

由於此事件在後代移除 **之前** 被觸發，因而在此事件觸發時，後代的父項將保持不變。如果後代也是父項的 **直接子項**，則此事件將在 `Class.Instance.ChildRemoved` 之前被觸發。

如果一個後代有子項，此事件將首先與後代一起觸發，然後隨後代一同觸發其後代。

#### 警告

此事件與正在被移除的後代對象一起觸發。
嘗試將後代的 `Class.Instance.Parent|Parent` 設置為其他對象將會失敗。以下是一個演示這一點的示例：

```
local Workspace = game:GetService("Workspace")

Workspace.DescendantRemoving:Connect(function(descendant)
	-- 在此函數中不要操作後代的父項！
	-- 此事件因為父項被操作而觸發，而變更尚未發生
	-- 因此，這樣更改父項是有問題的：
	descendant.Parent = game
end)

local part = Instance.new("Part")
part.Parent = Workspace
part.Parent = nil
```
另見 `Class.Instance.DescendantAdded|DescendantAdded`。

Instance.DescendantRemoving

在 `Class.Instance` 的一個後代被移除之前立即觸發。

此範例展示了在使用即時信號行為時，
被銷毀的實例會保持在原地，直到連接的函數掛起。


此範例展示了當使用延遲信號行為時，實例
在信號觸發之前被摧毀。


只要有連接的函數仍在使用，`Class.Instance` 將永遠不會從內存中刪除。然而，如果函數在任何時候暫停，`Class.Instance` 及其後代將會被設置為其父項為 `nil`。

如果 `Class.Workspace.SignalBehavior` 屬性設置為 `Enum.SignalBehavior.Immediate`，則此事件將在 `Class.Instance` 或其任何祖先被 `Class.Instance:Destroy()` 銷毀之前立即觸發。

如果 `Class.Workspace.SignalBehavior` 屬性設置為 `Enum.SignalBehavior.Deferred`，則此事件將在下次恢復點觸發，即在 `Class.Instance` 或其任何祖先被 `Class.Instance:Destroy()` 銷毀之後。

使用 `Enum.SignalBehavior.Deferred|Deferred` 行為，將腳本連接到其自己的 `Class.Instance.Destroying` 事件是有問題的，因為腳本將在回調被調用之前銷毀（這意味著它將不會執行）。

在 Studio 中刪除 `Class.Instance` 時，例如通過 [Explorer](/studio/explorer) 手動刪除或通過插件，`Class.Instance` 不會被銷毀。相反，父項被設置為 `nil`，您可以通過 `Class.Instance.AncestryChanged` 來跟蹤此變更。

Instance.Destroying

在實例通過 `Class.Instance:Destroy()` 被銷毀之前立即觸發（或推遲到之後）。

此事件每當實例的任何樣式屬性發生變更時觸發，包括當屬性被設置為 `nil` 時。

```lua
local Players = game:GetService("Players")

local player = Players.LocalPlayer
local playerGui = player.PlayerGui
local HUDContainer = playerGui:WaitForChild("HUDContainer")
local meterBar = HUDContainer.MeterBar

local function stylePropertyChanged()
	print("樣式屬性已更改")
end

meterBar:StyledPropertiesChanged():Connect(stylePropertyChanged)
```

Instance.StyledPropertiesChanged

每當實例的任何樣式屬性發生變化，包括當屬性被設置為 `nil` 時，都會觸發。

此方法為實例應用標籤，如果標籤已經應用則不會有任何效果。成功添加標籤將觸發由 `Class.CollectionService:GetInstanceAddedSignal()` 創建的信號，其中包含給定的標籤。

#### 警告

- 客戶端添加的實例標籤將被刪除，如果伺服器稍後在該實例上添加或刪除標籤，因為伺服器會一起復製所有標籤並覆蓋以前的標籤。

- 在對實例標籤時，通常會使用某些資源來賦予標籤功能，例如事件連接或表格。為了防止記憶體洩漏，當不再需要該標籤時，最好清除這些資源（斷開連接，設置為 `nil` 等）。在調用 `Class.Instance:RemoveTag()`、調用 `Class.Instance:Destroy()` 或在連接到 `Class.CollectionService:GetInstanceRemovedSignal()` 返回的信號的函數時執行此操作。

Instance:AddTag

子物件函數返回物件的子物件數組。

Instance:children

此方法銷毀所有實例的子物件和後代。

```
local part = Instance.new("Part")

-- 添加一些閃光
for i = 1, 3 do
	local sparkles = Instance.new("Sparkles")
	sparkles.Parent = part

  local sc = Instance.new("Sparkles")
  sc.Parent = sparkles
end

print("Children:", #part:GetChildren())  --> Children: 3

part:ClearAllChildren()

print("Children:", #part:GetChildren())  --> Children: 0
```
如果您不希望銷毀 **所有** 子物件和後代，請使用 `Class.Instance:GetChildren()` 或 `Class.Instance:GetDescendants()` 來循環遍歷這些子物件/後代並選擇要銷毀的物件。例如，以下代碼示例將銷毀所有來自 `Class.Model` 的 `Class.BasePart|BaseParts`：

```
local Workspace = game:GetService("Workspace")

local model = Workspace:FindFirstChild("TestModel")

for _, descendant in model:GetDescendants() do
	if descendant:IsA("BasePart") then
		descendant:Destroy()
	end
end
```

Instance:ClearAllChildren

此方法銷毀所有實例的子物件。

演示如何使用 `Class.Instance:Clone()` 來克隆模型。

`Clone()` 創建實例及所有其後代的副本，忽略所有不是 `Class.Instance.Archivable|Archivable` 的實例。根實例的副本由此方法返回，其 `Class.Instance.Parent|Parent` 設置為 `nil`。請注意，如果實例本身的 `Class.Instance.Archivable|Archivable` 設置為 `false`，則此方法將返回 `nil`。

如果在被複製的實例中設置了參考屬性，例如 `Class.ObjectValue.Value`，則副本的屬性值取決於原物件的值：

- 如果參考屬性參考的是也被複製的實例，則副本將參考該副本。
- 如果參考屬性參考的是未被複製的實例，則在副本中維持相同的值。

Instance:Clone

創建實例及所有其後代的副本，忽略不是 `Class.Instance.Archivable|Archivable` 的實例。

Instance:clone

演示如何使用 `Class.Instance:Destroy()` 函數摧毀一個 Part。

這個函數是處理不再需要的物件的正確方法。


將 `Class.Instance.Parent` 屬性設置為 `nil`，鎖定 `Class.Instance.Parent` 屬性，斷開所有連接，並在所有子物件上調用 `Destroy()`。此方法是正確的方法來處置不再需要的物件。

處置不必要的物件非常重要，因為多餘的物件和連接在場所中會使用内存，進而導致隨著時間的推移而產生嚴重的性能問題。

作為最佳實踐，在調用 `Destroy()` 後將任何引用該物件（或其後代）的變數設置為 `nil`。這可以防止你的代碼訪問與該物件相關的任何內容。

```lua
local part = Instance.new("Part")
part.Name = "Hello, world"
part:Destroy()
-- 不要這樣做：
print(part.Name)  --> "Hello, world"
-- 這樣做以防止上面這行代碼運行：
part = nil
```
一旦 `Class.Instance` 被此方法銷毀，將被鎖定的 `Class.Instance.Parent` 屬性無法重用。要 **暫時** 移除物件而不是銷毀它，請將 `Class.Instance.Parent|Parent` 設置為 `nil`。例如：

```
local Workspace = game:GetService("Workspace")

object.Parent = nil
task.wait(2)
object.Parent = Workspace
```
要在設置的時間後銷毀物件，請使用 `Class.Debris:AddItem()`。

Instance:Destroy

將 `Class.Instance.Parent` 屬性設置為 `nil`，鎖定 `Class.Instance.Parent` 屬性，斷開所有連接，並在所有子物件上調用 `Destroy()`。

Instance:destroy

返回 `Class.Instance` 的第一個祖先，其 `Class.Instance.Name` 等於給定名稱。

此方法向上工作，意味著它從實例的直接 `Class.Instance.Parent` 開始，向 `Class.DataModel` 上升。如果未找到匹配的祖先，則返回 `nil`。

以下代碼片段將查找名為 `Car` 的物件的第一個祖先。

```
local car = object:FindFirstAncestor("Car")
```
欲尋找特定類別的祖先的此方法的變體，請參見 `Class.Instance:FindFirstAncestorOfClass()` 和 `Class.Instance:FindFirstAncestorWhichIsA()`。

Instance:FindFirstAncestor

name

返回 `Class.Instance` 的第一個祖先，其 `Class.Instance.Name` 等於給定名稱。

返回 `Class.Instance` 的第一個祖先，其 `Class.Object.ClassName` 等於給定的 className。

此方法向上工作，意味著它從實例的直接 `Class.Instance.Parent` 開始，向 `Class.DataModel` 上升。如果未找到匹配的祖先，則返回 `nil`。

此方法的常見用途是查找 `Class.BasePart` 所屬的 `Class.Model`。例如：

```
local model = part:FindFirstAncestorOfClass("Model")
```
此方法是 `Class.Instance:FindFirstAncestor()` 的變體，檢查 `Class.Object.ClassName` 屬性，而不是 `Class.Instance.Name`。 `Class.Instance:FindFirstAncestorWhichIsA()` 也存在，使用 `Class.Object:IsA()` 方法以尊重類別繼承。

Instance:FindFirstAncestorOfClass

className

返回 `Class.Instance` 的第一個祖先，其 `Class.Object.ClassName` 等於給定的 className。

返回 `Class.Instance` 的第一個祖先，該祖先對應於 `Class.Object:IsA()` 返回 true 的給定 className。

此方法向上工作，意味著它從實例的直接 `Class.Instance.Parent` 開始，向 `Class.DataModel` 上升。如果未找到匹配的祖先，則返回 `nil`。

與 `Class.Instance:FindFirstAncestorOfClass()` 不同，此方法使用 `Class.Object:IsA()`，尊重類別繼承。例如：

```
print(part:IsA("Part"))  --> true
print(part:IsA("BasePart"))  --> true
print(part:IsA("Instance"))  --> true
```
因此，以下代碼示例將返回第一個 `Class.BasePart` 祖先，無論它是 `Class.WedgePart`、`Class.MeshPart` 還是 `Class.Part`。

```
local part = object:FindFirstAncestorWhichIsA("BasePart")
```
另見 `Class.Instance:FindFirstAncestor()`。

Instance:FindFirstAncestorWhichIsA

返回 `Class.Instance` 的第一個祖先，該祖先對應於 `Class.Object:IsA()` 返回 true 的給定 className。

以下將在工作區中尋找名為"Brick"的物件。如果找到，它將把物件的名稱改為"Foo"。

返回 `Class.Instance` 的第一個子物件，該物件具有給定名稱，或者如果不存在這樣的子物件則返回 `nil`。如果可選的 `recursive` 參數為 `true`，此方法將搜索所有後代而不僅限於 `Class.Instance` 的直接子物件。

#### 檢查物件的存在性

如果您需要驗證物件在繼續之前是否存在，則 `FindFirstChild()` 是必需的。嘗試使用點運算子通過名稱索引子物件，如果該子物件不存在，則會拋出錯誤。

```lua
local Workspace = game:GetService("Workspace")

-- 如果部件在工作區中不存在，以下行會報錯
Workspace.Part.Transparency = 0.5
```
更好的方法是使用 `FindFirstChild()` 首先檢查 `Part`，然後使用 `if` 語句運行需要它的代碼。

```lua
local Workspace = game:GetService("Workspace")

local part = Workspace:FindFirstChild("Part")
if part then
	part.Transparency = 0.5
end
```

#### 查找名稱與屬性匹配的子物件

有時候，物件的 `Class.Instance.Name|Name` 與其 `Class.Instance.Parent|Parent` 的屬性相同。在使用點運算子時，如果它們共享名稱，則屬性將優先於子物件。

在以下示例中，對 `Class.Part` 添加了一個名為 `Color` 的 `Class.Folder`，而它還擁有 `Class.Part.Color` 屬性。注意 `part.Color` 是指 `Datatype.Color3` 屬性值，而不是子 `Class.Folder` 實例。使用 `Class.Instance:FindFirstChild()|FindFirstChild()` 的好處是，新屬性的引入不會對您的代碼造成風險。

```lua
local part = Instance.new("Part")
local folder = Instance.new("Folder")
folder.Name = "Color"
folder.Parent = part
local c1 = part.Color  -- 屬性
local c2 = part:FindFirstChild("Color")  -- 子文件夾
```

#### 性能注意事項

`Class.Instance:FindFirstChild()|FindFirstChild()` 所需時間約比使用點運算子長 20%，而且幾乎長 8 倍於簡單地存儲物件引用。因此，應避免在與性能相關的代碼中調用它，例如在緊密循環中或連接到 `Class.RunService.Heartbeat` 和 `Class.RunService.PreRender` 的函數中。相反，將結果存儲在變數中，或者考慮使用 `Class.Instance.ChildAdded|ChildAdded` 或 `Class.Instance:WaitForChild()|WaitForChild()` 來檢測特定名稱的子物件何時可用。

Instance:FindFirstChild

recursive

返回第一個子物件，該物件具有給定名稱的 `Class.Instance`。

Instance:findFirstChild

返回 `Class.Instance` 的第一個子物件，其 `Class.Object.ClassName|ClassName` 等於給定的 `className`。與 `Class.Instance:FindFirstChildWhichIsA()` 不同，此方法僅返回其類別與 `className` 匹配的物件，忽略類別繼承。如果未找到匹配子物件，則此方法返回 `nil`。

Instance:FindFirstChildOfClass

返回 `Class.Instance` 的第一個子物件，其 `Class.Object.ClassName|ClassName` 等於給定的類名。

返回 `Class.Instance` 的第一個子物件，該子物件符合 `Class.Object:IsA()` 返回 true 的給定 className。

如果未找到匹配子物件，則此方法返回 `nil`。如果可選的 `recursive` 參數為 true，則此方法搜索所有後代，而不僅限於 `Class.Instance` 的直接子物件。

與 `Class.Instance:FindFirstChildOfClass()` 不同，此方法使用 `Class.Object:IsA()`，尊重類別繼承。例如：

```lua
print(part:IsA("Part")) --> true
print(part:IsA("BasePart")) --> true
print(part:IsA("Instance")) --> true
```
因此，以下代碼示例將返回第一個 `Class.BasePart` 子物件，無論它是 `Class.WedgePart`、`Class.MeshPart` 還是 `Class.Part`。

```
local part = object:FindFirstChildWhichIsA("BasePart")
```
希望通過名稱查找子物件的開發人員應使用 `Class.Instance:FindFirstChild()`。

Instance:FindFirstChildWhichIsA

返回 `Class.Instance` 的第一個子物件，該子物件符合 `Class.Object:IsA()` 返回 true 的給定 className。

返回第一個後代，該後代符合給定 `Class.Instance.Name`。

此方法被禁用且無法使用。要查找實例的第一個後代，請考慮在 `Class.Instance:FindFirstChild()` 上使用 `recursive` 參數。

Instance:FindFirstDescendant

返回第一個後代，該後代符合給定 `Class.Instance.Name`。

如果 `Class.Instance` 是 `Class.Actor`，則返回 `Class.Actor` 本身。否則，返回其最近的祖先 `Class.Actor`。如果沒有祖先是 `Class.Actor`，結果為 `nil`。

Instance:GetActor

返回與實例相關聯的 `Class.Actor`，如果有的話。

此方法返回分配給給定屬性名稱的值。如果未分配屬性，則返回 `nil`。

例如，以下代碼片段設置並獲取實例的 `InitialPosition` 屬性的值：

```lua
local Workspace = game:GetService("Workspace")

local part = Workspace.Part
part:SetAttribute("InitialPosition", part.Position)

local initialPosition = instance:GetAttribute("InitialPosition")
print(initialPosition)
```

#### 另見

- `Class.Instance:SetAttribute()`，用於將具有給定名稱的屬性設置為給定值。
- `Class.Instance:GetAttributes()`，返回實例的每個屬性的鍵值對字典。

Instance:GetAttribute

已分配給給定屬性名稱的值。如果未分配屬性，則返回 `nil`。

返回分配給給定屬性名稱的值。

此方法返回一個事件，該事件的行為與 `Class.Object.Changed|Changed` 事件完全相同，只不過它僅在特定給定屬性更改時引發；有效地類似於 `Class.Object:GetPropertyChangedSignal()|GetPropertyChangedSignal()`，但僅針對屬性。

通常使用此方法而不是連接到 `Class.Object.Changed|Changed` 的函數，這樣會檢查屬性名稱。對於同一物件及相同屬性名稱，後續調用該方法將返回相同的事件。

以下代碼示例返回一個信號，當部件的 `InitialPosition` 屬性更改時會觸發 `attributeChanged()` 函數：

```lua
local Workspace = game:GetService("Workspace")

local part = Workspace.Part
part:SetAttribute("InitialPosition", part.Position)

local function attributeChanged()
	print("Attribute changed")
end

part:GetAttributeChangedSignal("InitialPosition"):Connect(attributeChanged)
```
另見 `Class.Instance.AttributeChanged`，這在實例上的任何屬性更改時觸發。

Instance:GetAttributeChangedSignal

指定的屬性名稱，其變更信號正在返回。

當給定屬性更改時觸發的事件。

返回在給定屬性更改時引發的事件。

此方法返回每個屬性的鍵值配對的字典，其中鍵是屬性名稱，值是非 `nil` 值。

例如，以下代碼段輸出實例的屬性和值：

```lua
local Workspace = game:GetService("Workspace")

local part = Workspace.Part
part:SetAttribute("InitialPosition", part.Position)
part:SetAttribute("CanUse", true)

for name, value in part:GetAttributes() do
	print(name .. " = " .. value)
end
```
另見 `Class.Instance:GetAttribute()`，返回已分配給給定屬性名稱的值。

Instance:GetAttributes

屬性的字典，其中鍵是屬性名稱，變體是非 `nil` 值的鍵值對。

下面的代碼會在執行時打印出當前在工作區中的所有物件名稱。

返回一個數組（數字索引表），包含所有實例的直接子物件，或每個 `Class.Instance`，其 `Class.Instance.Parent|Parent` 等於該物件。可以使用數字或通用 `for` 循環對該數組進行迭代：

```lua
local Workspace = game:GetService("Workspace")

-- 數字循環示例
local children = Workspace:GetChildren()
for i = 1, #children do
	local child = children[i]
	print(child.Name .. " 是子物件號 " .. i)
end
```

```lua
local Workspace = game:GetService("Workspace")

-- 通用循環示例
local children = Workspace:GetChildren()
for i, child in children do
	print(child.Name .. " 是子物件號 " .. i)
end
```
請注意，返回的數組 **不** 以任何特定順序進行排序，因此建議在使用此方法返回的子物件進行排序時進行手動排序（例如使用 `Library.table.sort()`）。

另見 `Class.Instance:GetDescendants()|GetDescendants()` 方法。

Instance:GetChildren

返回包含所有實例子物件的數組。

Instance:getChildren

返回由 Roblox 內部使用的調試 ID 的編碼字符串。請注意：

- 此項目是受保護的。在 `Class.Script` 或 `Class.LocalScript` 中使用它將導致錯誤。
- 調試 ID 是在調試過程中使用的 ID。它允許調試工具在應用程序處理指令之前讀取每條指令。所有 Roblox 中的物件都像進程一樣運行，每個都運行指令（或"代碼"）以便於需要時調試。
- 這對於需要區分彼此相似物件的插件很有幫助（例如，共享相同名稱的物件）。

Instance:GetDebugId

scopeLength

返回由 Roblox 內部使用的調試 ID 的編碼字符串。

GetDescendants 通常用於對所有子孫物件進行某些操作，這些物件是特定類型的物件。這個示例中的程式碼使用 GetDescendants 和 `Class.Instance:IsA()` 來找到工作區中的所有部件並將它們變成綠色。

此物件方法返回一個數組，該數組包含該物件的所有後代。與 `Class.Instance:GetChildren()` 不同，此方法查找該物件的所有子物件、每個子物件的每個子物件，依此類推。

請注意，返回的數組 **不** 以任何特定順序進行排序，因此建議在使用此方法返回的後代進行排序時進行手動排序（例如使用 `Library.table.sort()`）。也請考慮使用 `Class.Instance:QueryDescendants()|QueryDescendants()` 方法通過選擇器和組合子來查詢後代。

Instance:GetDescendants

返回包含實例的所有後代的數組。

Instance

`Instance` 是 Roblox 類別階層中所有類別的基礎類別，可以是 `Class.DataModel` 樹的一部分。

/reference/engine/classes/SurfaceGui.yaml