GamepadService 在內部負責處理來自各種控制器的輸入，例如 Xbox One 或 PlayStation DualShock 控制器。它還處理與遊戲手把虛擬光標一起使用的 API。您可以透過將 `Enum.VirtualCursorMode` 設定為 `Enabled` 來為您的體驗啟用遊戲手把光標，這個設置在 `Class.StarterGui|StarterGui` 下。

在這個例子中，當使用者按下 `Enum.KeyCode.ButtonB` 時，游標會被禁用。

此函數禁用遊戲手把光標，如果它當前已啟用。

GamepadService:DisableGamepadCursor

禁用遊戲手把光標（如果當前已啟用）。

在這個範例中，當用戶按下

`Enum.KeyCode.ButtonA` 時，游標將被啟用，
起始按鈕為這個腳本的父物件。

此函數若遊戲手把光標當前已禁用則啟用它。如果光標已經啟用，調用該 API 將更新光標的位置。該函數接受 `Class.GuiObject|GuiObject` 參數，但有些無效情況。請注意，若要將光標設置為默認位置，必須將 `nil` 作為參數傳入。不提供任何參數將導致錯誤。

<table>
  <thread>
    <tr>
      <th>輸入 GuiObject</th>
      <th>光標起始位置</th>
    </tr>
  </thread>
  <tbody>
    <tr>
      <td><code>Nil</code></td>
      <td>默認位置</td>
    </tr>
    <tr>
      <td>不是 GuiObject</td>
      <td>光標不顯示，錯誤</td>
    </tr>
    <tr>
      <td>不是 BasePlayerGui 的子項</td>
      <td>光標不顯示，錯誤</td>
    </tr>
    <tr>
      <td>GuiObject 的 Visible 2 設置為 false 或任何父級的可見性設置為 false</td>
      <td>默認位置，並顯示警告</td>
    </tr>
    <tr>
      <td>ScreenGui 1 的子項，Enabled 1 設置為 false</td>
      <td>默認位置，並顯示警告</td>
    </tr>
    <tr>
      <td>BillboardGui 4 或 SurfaceGui 的子項</td>
      <td>默認位置，並顯示警告</td>
    </tr>
    <tr>
      <td>GuiObject 在視口外（或者，gui 物件的任何部分在螢幕外）</td>
      <td>默認位置，並顯示警告</td>
    </tr>
    <tr>
      <td>ScrollingFrame 的子項，裁剪設置為 false: GuiObject 在捲動框外（捲動框的物件子項且不在螢幕上可見）</td>
      <td>默認位置，並顯示警告</td>
    </tr>
    <tr>
      <td>ScrollingFrame 的子項，裁剪設置為 true: GuiObject 在捲動框窗口外但在視口內</td>
      <td>GuiObject 移入捲動框並使光標居中於物件</td>
    </tr>
    <tr>
      <td>GuiObject 在框內且可見</td>
      <td>光標以 GuiObject 為中心開始</td>
    </tr>
  </tbody>
</table>


GamepadService:EnableGamepadCursor

guiObject

啟用遊戲手把光標或更新其位置。

GamepadService

這個布林值是一個只讀變數，維護遊戲手把虛擬光標的狀態。您可以讀取此屬性，但不能寫入。

GamepadService.GamepadCursorEnabled

GamepadService 在內部負責處理來自各種控制器的輸入，例如 Xbox One 或 PlayStation DualShock 控制器。

`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

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

此代碼範例演示了 `Class.Instance:GetFullName()` 的行為。

它展示了當在不在 `DataModel` 階層中的物件上調用該函數時的行為，
並且還顯示了返回值如何不轉義特殊字符。

這段代碼示例在 Lua 中重新實作了 `Class.Instance:GetFullName()` 函數。


返回描述實例的祖先的字符串。該字符串是物件的 `Class.Instance.Name|Name` 和其祖先的串聯，以句點分隔。`Class.DataModel` (`game`) 不被考慮。例如，`Class.Workspace` 中的 `Class.Part` 可能返回 `Class.Workspace.Part`。

當在不是 `Class.DataModel` 的後代上調用此方法時，此方法考慮了所有祖先，直到包括沒有 `Class.Instance.Parent|Parent` 的最上層的一個。

此方法對於日誌記錄和調試非常有用。您不應該嘗試解析返回的字符串以用於任何有用的操作；此方法不會在物件名稱中轉義句點（或任何其他符號）。換句話說，儘管其輸出通常看似有效的 Luau 標識符，但不保證它是有效的。

Instance:GetFullName

返回描述實例的祖先的字符串。

此方法返回指定屬性樣式或明確修改的值，否則返回屬性的默認值（如果沒有樣式/修改）。這與直接訪問屬性值稍有不同，例如 `[GuiObject].Rotation`，這返回屬性的默認或修改值。

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

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

local coreSheet = ReplicatedStorage:FindFirstChild("CoreSheet")
local rule = coreSheet:FindFirstChildWhichIsA("StyleRule")
rule.Selector = "TextButton"

-- 引用一個按鈕
local button = HUDContainer:FindFirstChildWhichIsA("TextButton")

print(button:GetStyled("Rotation")) --> 0 (默認值)
print(button.Rotation) --> 0 (默認值)

-- 根據樣式規則屬性應用旋轉
rule:SetProperty("Rotation", 30)

print(button:GetStyled("Rotation")) --> 30 (根據規則的樣式值)
print(button.Rotation) --> 0 (默認值)

-- 明確修改/覆蓋樣式屬性
button.Rotation = 45

print(button:GetStyled("Rotation")) --> 45 (修改過的值)
print(button.Rotation) --> 45 (修改過的值)
```

Instance:GetStyled

selector

要針對實例中定位的伪實例的可選選擇器。

指定屬性樣式或明確修改的值，否則返回屬性的默認值（如果沒有樣式/修改）。

返回指定屬性樣式或明確修改的值，否則返回屬性的默認值（如果沒有樣式/修改）。

此方法返回一個事件，該事件的行為與 `Class.Instance.StyledPropertiesChanged|StyledPropertiesChanged` 事件完全相同，只不過它僅在特定樣式屬性更改時引發。通常使用此方法而不是連接到 `Class.Instance.StyledPropertiesChanged|StyledPropertiesChanged` 的函數，這樣會檢查屬性名稱。對於同一物件及相同屬性名稱，後續調用該方法將返回相同的事件。

請注意，該事件不會將任何參數傳遞給已連接的函數，因此必須直接在腳本中讀取更改屬性的值。

```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:GetStyledPropertyChangedSignal("AnchorPoint"):Connect(stylePropertyChanged)
```

Instance:GetStyledPropertyChangedSignal

property

要監聽更改的樣式屬性的名稱。

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

此方法返回應用於給定實例的標籤數組，以字符串形式表示。您可以在 Studio 中的 [屬性](/studio/properties) 窗口中或在運行時使用 `Class.Instance:AddTag()|AddTag()` 添加標籤。

當您同時希望對實例上的多個標籤執行某些操作時，此方法非常有用。然而，使用此方法檢查單個標籤的存在是低效的；相反，使用 `Class.Instance:HasTag()|HasTag()` 來檢查特定標籤。

Instance:GetTags

獲取應用於實例的所有標籤的數組。

此方法返回 `true`，如果提供的標籤已添加到該物件中。您可以在 Studio 中的 [屬性](/studio/properties) 窗口中或在運行時使用 `Class.Instance:AddTag()|AddTag()` 添加標籤。

Instance:HasTag

示範如何使用
`Class.Instance:IsAncestorOf()`
來判斷一個實例是否是另一個實例的祖先。

Workspace 和 SpawnLocation 是 SpawnLocation 的貼圖的祖先。
Workspace 是 SpawnLocation 的祖先。

SpawnLocation 和其貼圖是 Workspace 的後裔，而不是祖先。
Decal 是 SpawnLocation 的後裔，不是祖先。


如果 `Class.Instance` 是給定後代的祖先，則返回 true。

如果物件的 `Class.Instance.Parent` 或其父物件的 `Class.Instance.Parent` 設置為 `Class.Instance`，則認為該 `Class.Instance` 是物件的祖先。

另見 `Class.Instance:IsDescendantOf()`。

Instance:IsAncestorOf

如果 `Class.Instance` 是給定後代的祖先，則為 true。

如果 `Class.Instance` 是給定後代的祖先，則返回 true。

如果 `Class.Instance` 是給定祖先的後代，則返回 true。

注意 `IsDescendantOf()` 不能使用 `nil` 參數來檢查物件是否已被移除。

另見 `Class.Instance:IsAncestorOf()`。

Instance:IsDescendantOf

ancestor

如果 `Class.Instance` 是給定祖先的後代，則為 true。

如果 `Class.Instance` 是給定祖先的後代，則返回 true。

Instance:isDescendantOf

此方法指示特定屬性是否已經從代碼實例化的默認值進行了修改。如果在通過代碼（`Datatype.Instance.new()`）新創建的實例上調用此方法，則會返回 `false`。如果在通過 Studio 工作流（例如 [Explorer](/studio/explorer) 窗口插入）新創建的物件調用此方法，則結果可能會有差異。

例如，查詢由 [Explorer](/studio/explorer) 插入`Class.TextLabel.BackgroundColor3|BackgroundColor3` 屬性的 `Class.TextLabel` 將返回 `true`，但如果通過 `Datatype.Instance.new()` 創建的 `Class.TextLabel` 的相同屬性將返回 `false`，前提是沒有對其 `Class.TextLabel.BackgroundColor3|BackgroundColor3` 進行其他更改。

注意，此方法僅對服務和用戶可創建的實例返回有用的結果。實例的系統填充屬性的返回值如 `Class.PackageLink` 是未定義的行為。

同樣請注意，如果此方法返回 `true`，則樣式將 **不** 影響該屬性，因為明確修改屬性優先於對其進行樣式設定。要將屬性重置為其代碼實例化的默認值並允許對其進行樣式，應使用 `Class.Instance:ResetPropertyToDefault()|ResetPropertyToDefault()`。

Instance:IsPropertyModified

布爾值，指示該屬性是否從其代碼實例化的默認值中進行了修改。

返回 `true`，如果存儲在指定屬性中的值不等於代碼實例化的默認值。

此物件方法返回一個包含所有匹配所提供的 `selector` 字串的物件後代的陣列。`selector` 可以包括多個選擇器和組合器，以匹配例如類別名稱、實例名稱和階層關係等特徵，以及實例屬性和屬性的特定值。`selector` 的語法與 `Class.StyleRule` 中使用的類似，僅在某些支持的語法部分上有所不同。

#### 選擇器

- `ClassName` — 匹配指定類別的實例，基於 `Class.Object:IsA()` 關係。
- `.Tag` — 匹配被 `Class.CollectionService` 標記的實例。
- `#Name` — 匹配特定 `Class.Instance.Name` 的實例。
- `[property = value]` — 匹配具有指定屬性的實例，且該屬性具有指定值。支持布林值、數字和字串值。字母、數字、`_` 和 `-` 可以直接使用，而不需要將值放在引號中。
- `[$attribute]` — 匹配具有指定 [attribute](/studio/properties#instance-attributes) 的實例。
- `[$attribute = value]` — 匹配具有指定屬性**且**該屬性具有指定值的實例。與屬性選擇器的限制相同。如果想要檢查某個屬性是否缺失，請不要將查詢設為 `nil`；而是使用 `:not` 偽類別，如 `:not([$attribute])`。

選擇器也可以組合。例如，`Model.Apple[$Variety = Fuji][$Flavor = 4]` 將匹配標記為 `Apple` 的 `Class.Model` 實例，並且具有 `Variety` 屬性的值等於 `Fuji` 以及 `Flavor` 屬性的值等於 `4`。

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

-- 獲取所有 MeshPart 後代
print(Workspace:QueryDescendants("MeshPart"))

-- 獲取所有標記為 "Fruit" 的後代
print(Workspace:QueryDescendants(".Fruit"))

-- 獲取所有名稱為 "RedTree" 的後代
print(Workspace:QueryDescendants("#RedTree"))

-- 獲取所有 CanCollide 屬性設為 false 的後代
print(Workspace:QueryDescendants("[CanCollide = false]"))

-- 獲取所有指定了 "FuelCapacity" 屬性的後代
print(Workspace:QueryDescendants("[$FuelCapacity]"))
-- 獲取所有 "FuelCapacity" 屬性設為 75 的後代
print(Workspace:QueryDescendants("[$FuelCapacity = 75]"))
```

#### 組合器

組合器讓您可以混合基本選擇器，以匹配更深的階層關係。

- `>` — 匹配是前一個過濾器匹配的**直接子項**的實例。

- `>>` — 匹配是前一個過濾器匹配的**後代**的實例。這是預設的第一個過濾器，意味著 `SpotLight.Red` 與 `>> SpotLight.Red` 是相同的。

- `,` — 指定一組多個獨立選擇器，用於後代查詢。僅返回匹配過濾器的元素；在查詢列表中不會包括 `nil` 的未匹配項。

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

-- 獲取所有標記為 "SwordPart" 的模型的直接子項
print(Workspace:QueryDescendants("Model > .SwordPart"))

-- 獲取所有是 Part 且標記為 "Apple" 的直接子項
print(Workspace:QueryDescendants("> Part.Apple"))

-- 獲取任何模型的後代，屬性 "OnFire" 設為 true
print(Workspace:QueryDescendants("Model >> [$OnFire = true]"))

-- 獲取標記為 "SwordPart" 的 MeshPart 後代或具有屬性 "OnFire" 設為 true
print(Workspace:QueryDescendants("MeshPart.SwordPart, MeshPart[$OnFire = true]"))
```

#### 偽類別選擇器

- `:not(complex-selector-list)` — 允許選擇**不**匹配其中任何選擇器的實例，實際上對選擇器進行否定。由於內部表達式是一組複雜的選擇器，因此可以根據多個條件進行過濾。

- `:has(relative-selector-list)` — 允許根據包含的實例進行選擇。選擇器列表相對於每個實例進行評估。

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

-- 獲取所有不是 SpotLight 類別的後代
print(Workspace:QueryDescendants(":not(SpotLight)"))
-- 獲取所有不是 SpotLight 或 PointLight 類別的後代
print(Workspace:QueryDescendants(":not(SpotLight, PointLight)"))
-- 獲取所有沒有屬性 "OnFire" 的後代
print(Workspace:QueryDescendants(":not([$OnFire])"))
-- 獲取所有除了被標記為 "SwordPart" 的模型的子項的後代
print(Workspace:QueryDescendants(":not(Model > .SwordPart)"))

-- 獲取包含工具實例作為其後代的後代
print(Workspace:QueryDescendants(":has(Tool)"))
-- 獲取標記為 "SwordPart" 的直接子項的 MeshPart 後代
print(Workspace:QueryDescendants("MeshPart:has(> .SwordPart)"))

-- 獲取具有直接子項不是 SurfaceAppearance 或 Texture 類別的 MeshPart 後代
print(Workspace:QueryDescendants("MeshPart:has(> :not(SurfaceAppearance, Texture))"))
```


Instance:QueryDescendants

用於過濾元素的選擇器字符串。

匹配選擇器的實例數組（如果沒有匹配的則為空）。

返回一個包含所有匹配 `selector` 字串的實例後代的陣列。


以下代碼示範了如何在被移除後，將一個部件重新添加到數據模型中：

此方法將物件的 `Class.Instance.Parent` 設置為 `nil`，並對其所有後代執行相同操作。

如果在移除之前參考了物件，可以稍後檢索該物件。

Instance:Remove

將物件的 `Parent` 設置為 `nil`，並對其所有後代執行相同操作。

Instance:remove

此方法從實例中移除標籤。如果該物件沒有該標籤，則不會拋出錯誤。成功移除標籤將觸發由 `Class.CollectionService:GetInstanceRemovedSignal()` 創建的信號，其中包含給定的標籤。

請注意，在對實例標籤時，通常會使用某些資源來賦予標籤其功能，例如事件連接或表格。為了防止內存洩漏，當不再需要該標籤時，最好清除這些資源（斷開連接、設置為 `nil` 等）。

Instance:RemoveTag

將屬性重置為其默認值。例如，在 `Class.TextLabel` 上調用 `ResetPropertyToDefault("Rotation")` 相當於將 `Class.TextLabel.Rotation|Rotation` 設置為 `0`（該屬性的默認值）。此方法可以確保樣式會覆蓋該屬性的默認值。

Instance:ResetPropertyToDefault

此方法將具有給定名稱的屬性設置為給定值。如果提供的值為 `nil`，則該屬性將被移除，因為默認情況下返回 `nil`。

例如，以下代碼片段將實例的 `InitialPosition` 屬性設置為 `Datatype.Vector3|Vector3.new(0, 10, 0)`：

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

local part = Workspace.Part
part:SetAttribute("InitialPosition", Vector3.new(0, 10, 0))
```

#### 限制

命名要求和限制：

- 名稱必須僅使用字母數字字符。
  - 您還可以包括句點、破折號、斜線和底線。
- 不允許空格或唯一符號（如 @、~、!）。
- 字符串必須不超過 100 個字符。
- 名稱不得以 **RBX** 開頭，除非調用者是 Roblox 內部腳本（保留給 Roblox 使用）。

在嘗試將屬性設置為不支持的類型時，將拋出錯誤。

#### 另見

- `Class.Instance:GetAttribute()`，返回已分配給給定屬性名稱的值。
- `Class.Instance:GetAttributes()`，返回實例的每個屬性的鍵值對字典。

Instance:SetAttribute

value

將具有給定名稱的屬性設置為給定值。

以下代碼會等待一個名為 "Part" 的實例被添加到

    Workspace。

返回具有給定名稱的 `Class.Instance` 的子項。如果子項不存在，將暫停當前線程直到它存在。如果指定了 `timeOut` 參數，則此方法將在指定的秒數後超時並返回 `nil`。

#### 主要用途

`Class.Instance:WaitForChild()|WaitForChild()` 在 `Class.LocalScript` 中處理客戶端代碼時極其重要。Roblox 引擎不保證從服務器複製到客戶端對象的時間或順序。此外，如果體驗的 `Class.Workspace.StreamingEnabled` 設置為 true，則與玩家角色距離較遠的 `Class.BasePart|BaseParts` 可能不會被流式傳輸到客戶端，這可能會導致在索引尚未存在於客戶端的對象時腳本中斷。

#### 注意

- 如果在調用時具有給定名稱的子項存在，則此方法不會暫停。
- `Class.Instance:FindFirstChild()` 是假定存在的對象的更高效替代方案，使用 `Class.Instance:WaitForChild()|WaitForChild()`。
- 如果此方法的調用超過 5 秒而沒有返回，且未指定 `timeOut` 參數，將會在輸出中打印警告，指示線程可能無限期暫停。

Instance:WaitForChild

childName

timeOut

返回具有給定名稱的 `Class.Instance` 的子項。如果子項不存在，將暫停當前線程直到它存在。

Instance

此屬性決定在經驗發布或保存時，或當 `Class.Instance:Clone()|Clone()` 在其中一個實例的祖先上被調用時，該實例是否應包括在內。如果直接在實例上調用 `Class.Instance:Clone()|Clone()`，則返回 `nil` 如果該實例 **不是** `Class.Instance.Archivable|Archivable`。

在 Studio 中使用 **Duplicate** 或 **Copy**/**Paste** 選項複製物件將忽略其自身的 `Class.Instance.Archivable|Archivable` 屬性並將 `Class.Instance.Archivable|Archivable` 設置為 `true`。

```
local part = Instance.new("Part")
print(part:Clone())  --> Part
part.Archivable = false
print(part:Clone())  --> nil
```

Instance.Archivable

決定是否可以使用 `Class.Instance:Clone()` 將 `Class.Instance` 及其後代複製，並可以保存/發布。

Instance.archivable

此實例內允許用於腳本的能力集。要使這些能力生效，必須啟用 `Class.Instance.Sandboxed` 屬性。

此屬性由實驗性功能使用。詳情請參見 [腳本能力](/scripting/capabilities)。

Instance.Capabilities

容器內允許用於腳本的能力集。

一個非唯一標識符的 `Class.Instance`。名稱用於保持物件層級組織，並允許腳本訪問特定物件。實例的名稱不能超過 100 個字符大小。

物件的名稱通常用於通過數據模型層級訪問物件，使用以下方法：

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

local baseplate = Workspace.Baseplate
local baseplate = Workspace["Baseplate"]
local baseplate = Workspace:FindFirstChild("BasePlate")
```
為了使物件在使用點運算子 (`.`) 時可訪問，其名稱必須以底線或字母開頭，名稱的其餘部分只能包含字母、數字或底線（不允許其他特殊字符）。如果物件的名稱不遵循此語法，則無法使用點運算子訪問該物件，且 Luau 將不會將其名稱解釋為標識符。

如果有多個相同名稱的物件是兄弟關係，任何嘗試根據該名稱索引物件的操作將僅返回其中一個物件，類似於 `Class.Instance:FindFirstChild()`，但不一定是所需的物件。如果需要通過代碼訪問特定物件，建議為其賦予唯一名稱或保證其兄弟物件沒有相同名稱。

另請參見 `Class.Instance:GetFullName()` 獲取包括物件層級的全名。

Instance.Name

一個非唯一標識符的 `Class.Instance`。

`Parent` 屬性決定 `Class.Instance` 的層級父母。討論此屬性設置時，通常使用以下術語：

- 當物件的 `Parent` 設置為該物件時，該物件是另一個物件的 **子物件** 或 **被父化**。

- `Class.Instance` 的 **後代** 是該物件的子物件，以及子物件的後代。

- `Class.Instance` 的 **祖先** 是所有該實例的祖先物件。

正是 `Parent` 屬性使許多其他 API 成員獲得其名稱，例如 `Class.Instance:GetChildren()|GetChildren()` 和 `Class.Instance:FindFirstChild()|FindFirstChild()`。此屬性還用於管理物件是否存在於經驗中，或需要被移除。只要物件的父母在 `Class.DataModel` 中、保存在變數中，或被另一個物件的屬性引用，該物件將保持在經驗中；否則該物件將自動被移除。

調用 `Class.Instance:Destroy()|Destroy()` 將使 `Class.Instance` 及其所有後代的 `Parent` 設置為 `nil`，並且還會 **鎖定** `Parent` 屬性。設定銷毀的物件的 `Parent` 時會引發錯誤。

使用 `Datatype.Instance.new()` 創建的新物件將不會有父母，通常不會可見或運作，直到設置其父母。

#### 物件複製

由伺服器創建的物件不會復製到客戶端，直到其被父化到某些被複製的物件上。當創建物件並設置多個屬性時，建議最後設置 `Parent` 屬性。這樣確保物件僅複製一次，而不是複製多次屬性更改。

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

-- 最後設置新實例的父母（建議）
local part = Instance.new("Part")
part.Position = Vector3.new(0, 10, 0)
part.Parent = Workspace
```
不過，如果正在將部件父化到尚未設置其父母的 `Class.Model`，則將每個部件父化至該模型是可接受的，因為模型不會被複製。

Instance.Parent

決定 `Class.Instance` 的層級父母。

Instance.PredictionMode

此屬性曾用於保護 `Class.CoreGui` 服務中的物件，以免被未經授權的用戶更改。現在已被淘汰，且不會做任何事情。

Instance.RobloxLocked

一個已經被淘汰的屬性，以前用來保護 `Class.CoreGui` 物件。

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

/reference/engine/classes/GamepadService.yaml