AssetPatchSettings

AssetPatchSettings.ContentId

AssetPatchSettings.OutputPath

AssetPatchSettings.PatchId

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

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


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

ChangingPart 的 Parent 隨著時間的推移而設置為不同的值。部分的父級是該部分的祖先，因此每當它變更時，`Class.Instance.AncestryChanged` 事件就會觸發。

物件的 `Class.Instance.Parent` 屬性或其祖先之一被更改時觸發。

此事件包括兩個參數：`child` 指向實際更改了 `Class.Instance.Parent` 的 `Class.Instance`，而 `parent` 指向此實例的新的 `Class.Instance.Parent`。

你可以使用此事件跟蹤 Studio 中實例的刪除情況，例如在資源管理器中進行手動刪除或通過插件進行刪除。如果需要檢測何時通過 `Class.Instance:Destroy()` 毀掉實例，請改用 `Class.Instance.Destroying` 事件。


Instance.AncestryChanged

child

其 `Class.Instance.Parent` 已更改的 `Class.Instance`。


parent

其 `Class.Instance.Parent` 被更改的 `Class.Instance` 的新 `Class.Instance.Parent`。


物件的 `Class.Instance.Parent` 屬性或其祖先之一被更改時觸發。


此事件每當實例的任何屬性更改時觸發，包括設置屬性為 `nil`。更改的屬性名稱將傳遞到連接的函數。

例如，以下代碼片段將 `attributeChanged()` 函數連接到當部分的任何屬性更改時觸發：

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

local part = Workspace.Part

local function attributeChanged(attributeName)
	print(attributeName, "已更改")
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` 時觸發。


這段程式碼會在物件從

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

當一個子物件從此 `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` 時，將觸發此事件。


Instance.childAdded

此方法將標記應用於該實例，若該標記已應用將不會有任何效果。成功地添加標記將觸發由 `Class.CollectionService:GetInstanceAddedSignal()` 創建的信號。

##### 警告

- 客戶端添加的實例標記將被丟棄，如果伺服器稍後對該實例添加或移除標記，因為伺服器將所有標記一起複製並覆蓋先前的標記。

- 標記實例時，通常會使用某些資源來賦予標記其功能，例如事件連接或表格。為了防止內存泄漏，當標記不再需要時，進行清理（斷開連接，設置為 `nil` 等）是個好主意。在呼叫 `Class.Instance:RemoveTag()`、呼叫 `Class.Instance:Destroy()` 或在連接到 `Class.CollectionService:GetInstanceRemovedSignal()` 返回的信號中的函數時執行此操作。


Instance:AddTag

此函數摧毀該實例的所有子物件和後代。

```
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.BasePart|BaseParts` 從 `Class.Model` 繼承下來的物件：

```
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` 的實例。


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

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

將 `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()`。


返回 `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.Object.ClassName`。


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


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

此函數向上工作，意味著它從實例的直接 `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` 的第一個祖先，對於給定的 className， `Class.Object:IsA()` 返回 true。


以下將在工作區中尋找名為"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` 的屬性相同。在使用點運算子時，如果屬性與子物件共享名稱，則屬性優先於子物件。

在以下示例中，將名為 `Color` 的 `Class.Folder` 添加到 `Class.Part`，而該 `Class.Part` 也有 `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` 的第一個子物件。


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


Instance:FindFirstChildOfClass

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


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

如果找不到匹配的子物件，則此函數返回 `nil`。如果可選的遞歸參數為 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` 的第一個子物件，對於給定的 className， `Class.Object:IsA()` 返回 true。


返回具有給定 `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")

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

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

-- 通用 for 循環示例
local children = Workspace:GetChildren()
for i, child in children do
	print(child.Name .. " 是子物件編號 " .. i)
end
```
子物件按照設置其 `Class.Instance.Parent|Parent` 屬性的順序進行排序。

另請參見 `Class.Instance:GetDescendants()|GetDescendants` 函數。


Instance:GetChildren

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


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

- 該項是受保護的。在 `Class.Script` 或 `Class.LocalScript` 中嘗試使用會導致錯誤。
- 調試 ID 是用於調試過程中的 ID。它允許調試器在應用程序處理每條指令之前讀取它。 Roblox 中的所有物件都像過程一樣運行，每次都執行可根據需要進行調試的指令（或「代碼」）。
- 這對於需要區分類似物件的插件（例如分享同一名稱的物件）可能會有所幫助。


Instance:GetDebugId

scopeLength

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


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

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


Instance:GetDescendants

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

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

'此代碼範例重新實作了`Class.Instance:GetFullName()`函數
    在
    Lua。'

返回描述實例祖先的字符串。該字符串由 `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

指定屬性的樣式或明確修改的值，或者如果尚未進行樣式/修改則返回默認屬性值。


返回指定屬性的樣式或明確修改的值，或者如果尚未進行樣式/修改則返回默認屬性值。


此方法返回了一個事件，行為完全類似 `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/properties) 窗口或在運行時使用 `Class.Instance:AddTag()|AddTag()` 來添加標籤。

當你想對實例上多個標籤做某些操作時，此方法非常有用。然而，使用此方法檢查單個標籤的存在性效率較低；相反，使用 `Class.Instance:HasTag()|HasTag()` 來檢查特定標籤。


Instance:GetTags

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


此方法返回 `true`，如果提供的標籤已被添加到該物件。你可以在工作室中 [屬性](/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: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。


如果存儲在指定屬性中的值等於程式碼實例化的默認值，則返回 true。例如，如果輸出的 `Class.TextLabel.TextSize|TextSize` 屬性為 `8`，則對該標籤呼叫 `IsPropertyModified("TextSize")` 將返回 `false`，因為 `8` 是使用 `Instance.new("TextLabel")` 創建該標籤時 `Class.TextLabel.TextSize` 的默認值，而不是通過工作室插入工作流插入的。

注意，如果此方法返回 `true`，則樣式將 **不影響** 該屬性，因為明確修改屬性會優先於樣式。 


Instance:IsPropertyModified

指示屬性是否被修改的布林值。


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


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

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

如果在移除之前引用了該物件，則可以在稍後的時間檢索該物件。


Instance:Remove

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


此方法從實例中移除標籤。如果物件沒有該標籤，則不會引發錯誤。成功移除標籤將觸發由 `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 個字符。
- 除非調用者是 Roblox 核心腳本，否則名稱不允許以 **RBX** 開頭（保留給 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()` 是對於預計存在的物件的更高效替代方案。
- 如果對此方法的呼叫在 5 秒內未返回且未指定 `timeOut` 參數，則控制台將打印警告以提示該線程可能會無限期暫停。


Instance:WaitForChild

childName

timeOut

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


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


Instance:children

Instance:clone

Instance:destroy

Instance:findFirstChild

Instance:getChildren

Instance:isDescendantOf

Instance:remove

Instance

此屬性判斷在經驗發佈或保存時，或在呼叫 `Class.Instance:Clone()|Clone()` 時，該實例是否應包含在內。如果直接在實例上呼叫 `Class.Instance:Clone()|Clone()`，則如果該實例 **不是** `Class.Instance.Archivable|Archivable`，將返回 `nil`。

在 Studio 中使用 **複製** 或 **複製**/**粘貼** 選項來複製物件將忽略其自身的 `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` 及其後代是否可以使用 `Class.Instance:Clone()` 進行複製，以及是否可以保存/發佈。


此實例內允許用於腳本的功能集。要使功能生效，必須啟用 `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` 的 **祖先** 是實例所屬的所有物件。

許多其他 API 成員的名稱都是來自 `Parent` 屬性，例如 `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` 的階層父物件。


此屬性曾用於保護 `Class.CoreGui` 服務中的物件，防止用戶未經授權地更改。該屬性已被棄用，且不再執行任何功能。


Instance.RobloxLocked

已棄用的屬性，曾用於保護 `Class.CoreGui` 物件。


將實例設置為 **沙盒容器**，這是一個實驗性功能，限制了特定容器內腳本可以執行的操作。請參見 [腳本功能](/scripting/capabilities) 獲取更多詳細信息。


Instance.Sandboxed

實例的唯一標識符，與 `Class.Instance.Name` 不同，不一定唯一。


Instance.UniqueId

Instance.archivable

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


Object 是 Roblox 類別層級結構中所有類別的基礎類別。每一個
Roblox 引擎定義的其他類別都繼承 Object 的所有成員。
不可能直接創建 Object。



此範例展示了普通物件和 `Value` 物件上 `Changed` 事件的細微差別。

此範例代碼演示了父物件中的 Changed 事件觸發。

這個事件在對象屬性變更後立即觸發，並且它
適用於大多數用途（見下方限制）。被改變的屬性的新值**不**以參數形式傳遞，
因此必須通過使用 `object[property]` 來訪問。
例如：

```
object.Changed:Connect(function(property)
	print("新屬性的值是", object[property])
end)
```

如果你只對某一特定屬性的變化感興趣，考慮使用
`Class.Object:GetPropertyChangedSignal()|GetPropertyChangedSignal()`
方法。

對於 `Class.ValueBase` 對象，例如 `Class.IntValue` 和
`Class.StringValue`，只有當對象的 `Value`
屬性變更時，這個事件才會觸發。要檢測 `Class.ValueBase` 對象的其他變化，
請改用 `Class.Object:GetPropertyChangedSignal()|GetPropertyChangedSignal()`。

#### 限制

這個事件**不**會因物理相關的變更而觸發，例如
當 `Class.BasePart.CFrame|CFrame`、
`Class.BasePart.AssemblyLinearVelocity|AssemblyLinearVelocity`、
`Class.BasePart.AssemblyAngularVelocity|AssemblyAngularVelocity`、
`Class.BasePart.Position|Position` 或
`Class.BasePart.Orientation|Orientation` 的屬性由重力改變時。
要檢測這些屬性的變化，考慮使用基於物理的事件，例如
`Class.RunService.PreSimulation`。

此外，這個事件可能不會對每一次頻繁的屬性修改都觸發，
或者對於這些屬性根本不會觸發。建議進行仔細測試，
檢查影響遊戲邏輯的屬性變化。


Object.Changed

在對象屬性變更後立即觸發，並有一些限制。



此代碼範例展示了如何在變更事件發生之前保存一個值，以便獲取有關變更的更多信息。

此代碼範例展示了 `Changed` 事件和由 `GetPropertyChangedSignal` 返回的事件之間的等價性。

這個方法返回一個與 `Class.Object.Changed|Changed` 事件的行為完全相同的事件，
不過它僅在給定屬性變更時觸發。通常建議使用這個方法，
而不是與檢查屬性名稱的函數連接到 `Class.Object.Changed|Changed`。
對同一對象以相同屬性名稱後續調用此方法將返回相同事件。

`Class.ValueBase` 對象，例如 `Class.IntValue` 和 `Class.StringValue`，
使用一個修改過的 `Class.Object.Changed|Changed` 事件，
該事件會在其 `Value` 屬性內容改變時觸發。因此，這個方法提供了一種檢測這些對象其他屬性變化的方法。

注意，這個事件不會將任何參數傳遞給連接的函數，
因此必須在腳本內部直接讀取被改變的屬性值。

#### 限制

這個方法返回的事件**不**會因物理相關的變化而觸發，
例如當 `Class.BasePart.CFrame|CFrame`、
`Class.BasePart.AssemblyLinearVelocity|AssemblyLinearVelocity`、
`Class.BasePart.AssemblyAngularVelocity|AssemblyAngularVelocity`、
`Class.BasePart.Position|Position` 或
`Class.BasePart.Orientation|Orientation` 的屬性由重力改變時。
要檢測這些屬性的變化，考慮使用基於物理的事件，例如 `Class.RunService.PreSimulation`。

此外，返回的事件可能不會對每一頻繁變動的屬性變更觸發，或者對於這些屬性根本不會觸發。
建議仔細測試影響遊戲邏輯的屬性變化。


Object:GetPropertyChangedSignal

一個信號，在屬性變更時觸發。



獲得當對象的指定屬性更改時觸發的事件。



展示如何使用 `Class.Instance:IsA()` 確定工作區的類別

工作區的類別為 ''Workspace''，因此第一個陳述為真。

工作區的類別不是 ''BasePart''，因此第二個陳述為假。

工作區繼承自實例，因此其類別為 ''Instance''，所以第三個陳述為真。

IsA 在對象的類別**等同於**或**子類別**於給定類別時返回 true。這個函數類似於
其他語言中的 **instanceof** 操作符，是一種
[type introspection](https://en.wikipedia.org/wiki/Type_introspection) 的形式。
要忽略類別繼承，直接測試 `Class.Object.ClassName|ClassName` 屬性。
對於檢查原生 Luau 數據類型（數字、字串等），使用函數 `type` 和 `typeof`。

最常見的情況下，這個函數用於測試一個對象是否是某種
部件，例如 `Class.Part` 或 `Class.WedgePart`，這些都繼承自
`Class.BasePart`（一個抽象類別）。例如，如果你的目的是
將角色的所有肢體變更為相同顏色，你可以使用
`Class.Instance:GetChildren()|GetChildren` 來迭代
子對象，然後使用 IsA 來過濾掉缺乏 `Datatype.BrickColor` 屬性的非 `Class.BasePart` 對象：

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

local function paintFigure(character, color)
	-- 迭代角色的子對象
	for _, child in character:GetChildren() do
		-- 過濾掉非部件對象，例如 Shirt、Pants 和 Humanoid
		-- R15 使用 MeshPart，R6 使用 Part，所以我們使用 BasePart 來檢測兩者：
		if child:IsA("BasePart") then
			child.BrickColor = color
		end
	end
end
paintFigure(Players.Player.Character, BrickColor.new("Bright blue"))
```

由於所有類別都繼承自 `Class.Object`，
調用 `object:IsA("Object")` 將始終返回 true。


Object:IsA

如果一個對象的類別與給定類別匹配或繼承，則返回 true。



Object

Object 是 Roblox 類別層級結構中所有類別的基礎類別。



/reference/engine/classes/AssetPatchSettings.yaml

AssetPatchSettings

概要

屬性

方法

活動

屬性

方法

活動

此頁面