作为关于类、成员、枚举和枚举项的通用信息的抽象属性。

ReflectionMetadataItem

当此值为 true 时，这意味着此属性/类可以在工作室中看到，例如在资源管理器中。

ReflectionMetadataItem.Browsable

此项是否可以在工作室中看到。

ReflectionMetadataItem.ClassCategory

ReflectionMetadataItem.ClientOnly

描述一个单参数函数的约束，该函数的参数类型是 `Class.Object.ClassName`。目前有两个可用的约束：

<table>
<tbody><tr>
<th>约束</th>
<th>描述</th>
</tr>
<tr>
<td>isScriptCreatable</td>
<td>指定的类必须可以使用 Instance.new 创建</td>
</tr>
<tr>
<td>isService</td>
<td>指定的类必须是服务。</td>
</tr>
</tbody></table>


ReflectionMetadataItem.Constraint

描述一个单参数函数的约束，该函数的参数类型是 `Class.Object.ClassName`。

当一个对象被弃用时，不应再用于新的脚本。

ReflectionMetadataItem.Deprecated

切换此属性是否可以从属性窗口中编辑。

ReflectionMetadataItem.EditingDisabled

ReflectionMetadataItem.EditorType

ReflectionMetadataItem.FFlag

此属性应确定一个方法是否需要使用 Roblox 主服务器上的内容。但此属性并未在应适用的地方应用。

ReflectionMetadataItem.IsBackend

模糊值，用于显示这是否依赖于后端内容。

ReflectionMetadataItem.PropertyOrder

描述此成员可以使用的上下文。如果设置为 <a href="/luau/strings">"Server"</a>，则在编辑 `Class.LocalScript` 时此成员不会可用进行自动填充。如果设置为 <a href="/luau/strings">"Client"</a>，则在编辑 `Class.Script` 时此成员不会可用进行自动填充。

ReflectionMetadataItem.ScriptContext

描述此成员可以使用的上下文。如果设置为 "Server"，则在编辑 `Class.LocalScript` 时此成员不会可用进行自动填充。如果设置为 "Client"，则在编辑 `Class.Script` 时此成员不会可用进行自动填充。

ReflectionMetadataItem.ServerOnly

ReflectionMetadataItem.SliderScaling

此属性的最大值。与 `Class.ReflectionMetadataItem.UIMinimum` 一起用于控制此属性在 `Properties` 窗口中的滑块条。

ReflectionMetadataItem.UIMaximum

此属性的最小值。与 `Class.ReflectionMetadataItem.UIMaximum` 一起用于控制此属性在 `Properties` 窗口中的滑块条。

ReflectionMetadataItem.UIMinimum

该属性滑块条可以设置的潜在值的数量，`Class.ReflectionMetadataItem.UIMinimum` 和 `Class.ReflectionMetadataItem.UIMaximum`。

ReflectionMetadataItem.UINumTicks

`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`。

您可以使用此事件跟踪在 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, "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` 中移除时触发。


下面的示例将打印任何添加到 Workspace 的对象的名称：

此事件在后代添加到 `Class.Instance` 后触发。

由于它对每个后代都触发，因此将对象作为子项添加到 `Class.Instance` 将分别为该对象及其所有后代触发该事件。

如果您只关心 `Class.Instance` 的 **直接子项**，请使用 `Class.Instance.ChildAdded`。 

另请参阅 `Class.Instance.DescendantRemoving`。


Instance.DescendantAdded

descendant

当后代添加到 `Class.Instance` 时触发。


以下示例在一个后代被移除时打印其名称
从工作区:

此事件在父级 `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` 将永远不会从内存中删除。但是，如果该函数在任何时候导致等待，`Class.Instance` 及其后代将被设置为 `nil`。

如果 `Class.Workspace.SignalBehavior` 属性设置为 `Enum.SignalBehavior.Immediate`，则此事件在 `Class.Instance` 或其祖先之一通过 `Class.Instance:Destroy()` 被销毁之前立即触发。

如果 `Class.Workspace.SignalBehavior` 属性设置为 `Enum.SignalBehavior.Deferred`，此事件将在下一个恢复点触发，该点在 `Class.Instance` 或其祖先之一被销毁后。

使用 `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.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` 的实例。


Instance:clone

演示如何使用 `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()`。


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


返回 `Class.Instance` 的第一个祖先，其 `Class.Object.ClassName` 等于给定的 className。


返回 `Class.Instance` 的第一个祖先，对于该祖先 `Class.Object:IsA()` 对给定的 className 返回 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:FindFirstChild()`。


Instance:FindFirstAncestorWhichIsA

返回 `Class.Instance` 的第一个祖先，对于该祖先 `Class.Object:IsA()` 对给定的 className 返回 true。


下面的代码将在工作区中查找名为“Brick”的对象。如果找到，它将把该对象的名称更改为“Foo”。

返回具有给定名称的 `Class.Instance` 的第一个子级，或者如果没有此类子级，则返回 `nil`。如果可选的 `recursive` 参数为 `true`，此方法将在所有后代中查找，而不仅仅是 `Class.Instance` 的直接子级。

##### 检查对象的存在性

如果你需要验证对象是否存在，在继续之前，`FindFirstChild()` 是必要的。使用点操作符按名称索引子项，如果子项不存在，则会抛出错误。

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

-- 如果 Workspace 中不存在 part，下一行将抛出错误
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 name。


返回 `Class.Instance` 的第一个子级，对于该子级 `Class.Object:IsA()` 对给定的 className 返回 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` 的第一个子级，对于该子级 `Class.Object:IsA()` 对给定的 className 返回 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

每个属性的字符串 → 变体对的字典，其中字符串是属性名称，变体是非空值。


下面代码将在运行时打印当前在工作区中的所有对象的名称。

返回一个数组（一个数字索引表），其中包含所有实例的直接子级，或每个 `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` 上调用此方法时，它将考虑所有祖先，直到包括顶部没有 `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 中通过 [属性](/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 的后代，而不是祖先。
贴花是 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`。如果在通过 [Explorer](/studio/explorer) 窗口插入的 Studio 工作流中创建的对象上调用该方法，结果可能会有所不同。

例如，查询通过 [Explorer](/studio/explorer) 插入的 `Class.TextLabel.BackgroundColor3|BackgroundColor3` 属性将返回 `true`，但查询通过 `Datatype.Instance.new()` 创建的 `Class.TextLabel` 的相同属性将返回 `false`，假设没有对其 `Class.TextLabel.BackgroundColor3|BackgroundColor3` 进行其他更改。

请注意，如果该方法返回 `true`，样式 **将** 不影响属性，因为显式修改属性具有优先级于样式。要将属性重置为其代码实例化的默认值并允许其样式，请使用 `Class.Instance:ResetPropertyToDefault()|ResetPropertyToDefault()`。


Instance:IsPropertyModified

布尔值，指示属性是否已从其
代码实例化的默认值修改。


如果存储在指定属性中的值不等于代码实例化的默认值，则返回 true。


此对象方法返回一个数组，其中包含与提供的 `selector` 字符串匹配的对象的后代。`selector` 字符串可以包含多个选择器和组合器，以匹配特性，例如类名称、实例名称、层次关系、以及实例属性和属性值的特定值。`selector` 语法与 `Class.StyleRule` 中使用的语法相似，仅在支持的语法部分上存在少量差异。

##### 选择器

<table>
<thead>
  <tr>
    <th>选择器</th>
    <th>描述</th>
    <th>示例</th>
  </tr>
</thead>
<tbody>
  <tr>
    <td><code>ClassName</code></td>
    <td>匹配指定类的实例，具有 <code>Class.Object:IsA()</code> 关系。</td>
    <td><code>SpotLight</code><br /><code>ImageButton</code><br /><code>Part</code></td>
  </tr>
  <tr>
    <td><code>.Tag</code></td>
    <td>匹配带有 <code>Class.CollectionService</code> 标签的实例。</td>
    <td><code>.Fruit</code><br /><code>.IntenseLight</code></td>
  </tr>
  <tr>
    <td><code>#Name</code></td>
    <td>匹配特定 <code>Class.Instance.Name</code> 的实例。</td>
    <td><code>#RedTree</code><br /><code>#CloseButton</code></td>
  </tr>
  <tr>
    <td><code>[property = value]</code></td>
    <td>匹配具有指定属性并且该属性具有指定值的实例。支持布尔值、数字和字符串值。字母、数字、<code>_</code> 和 <code>-</code> 可以在不加引号的情况下使用该值。
    </td>
    <td><code>[CanCollide = false]</code><br />
    <code>[Brightness = "0.5"]</code><br />
    <code>[Name = Folder10]</code><br />
    <code>[Name = "Part.10"]</code></td>
  </tr>
  <tr>
    <td width="30%"><code>[$attribute = value]</code></td>
    <td>匹配具有指定属性并且该属性具有指定值的实例。与属性选择器的限制相同。
    </td>
    <td width="30%"><code>[$MyAttribute = 10]</code></td>
  </tr>
</tbody>
</table>

注意选择器可以结合使用。例如，`Model.Apple[$Kind = "Red"][$State = 4]` 将匹配具有标签 `Apple` 设置并设置 `Kind` 属性等于字符串 `"Red"` 以及 `State` 属性等于 `4` 的 `Class.Model` 实例。

##### 组合器

<table>
<thead>
  <tr>
    <th>组合器</th>
    <th>描述</th>
    <th>示例</th>
  </tr>
</thead>
<tbody>
  <tr>
    <td><code>&gt;</code></td>
    <td>匹配是之前过滤器匹配的 <b>直接子级</b> 的实例。</td>
    <td><code>Part &gt; .SwordHandle</code></td>
  </tr>
  <tr>
    <td><code>&gt;&gt;</code></td>
    <td>匹配是之前过滤器匹配的 <b>后代</b> 的实例。</td>
    <td><code>Model &gt;&gt; .TreeOnFire</code></td>
  </tr>
  <tr>
    <td width="10%"><code>,</code></td>
    <td>指定多个独立选择器的列表以进行后代查询。</td>
    <td width="50%"><code>Part.TagA, Part[$UseForce = true]</code></td>
  </tr>
</tbody>
</table>

注意默认第一个过滤器是后代组合器 `>>`。如果选择器以 `>` 开头，则仅访问子级；例如 `>Part.Apple` 选择 **直接子级**，即为 `Class.Part` 且有标签 `Apple`。

默认组合器也可以明确指定，例如 `>>SpotLight.Red` 与 `SpotLight.Red` 相同。

仅将符合过滤器的元素放入数组中。例如，`>#ExistingChild, >#MissingChild, >#AnotherExistingChild` 将返回一个包含两个元素的数组，没有缺失子级的 `nil`。


Instance:QueryDescendants

selector

用于过滤元素的选择器字符串。


一个实例数组（如果没有任何元素匹配选择器，则为空）。


以下代码演示了一个零件如何在被移除后重新添加到数据模型中：

此方法将对象的 `Class.Instance.Parent` 设置为 `nil`，并对其所有后代执行相同操作。

如果在移除之前引用了对象，则可以在稍后检索该对象。


Instance:Remove

将对象的 `Parent` 设置为 `nil`，并对其所有后代执行相同操作。


Instance:remove

此方法从实例中移除标签。如果对象没有该标签，则不会抛出错误。成功移除标签将触发由 `Class.CollectionService:GetInstanceRemovedSignal()` 创建的信号，附带给定标签。

请注意，当标记实例时，通常会使用一些资源来赋予标签其功能。例如事件连接或表。为了防止内存泄漏，最好在不再需要标签时清理这些资源（断开连接，设置为 `nil` 等）。


Instance:RemoveTag

将属性重置为其默认值。例如，调用 `ResetPropertyToDefault("Rotation")` 对于 `Class.TextLabel` 相当于将其 `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 核心脚本（保留给 Roblox），否则不允许以 **RBX** 开头。

当尝试将属性设置为不支持的类型时，将抛出错误。

##### 另请参见

- `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()` 如果该实例 **不** 是
`Class.Instance.Archivable|Archivable` 将返回 `nil`。

在 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` 及其后代是否可以使用
`Class.Instance:Clone()` 进行克隆，并且可以被保存/发布。


`Instance` 是 Roblox 类层次结构中所有类的基础类
可以是 `Class.DataModel` 树的一部分。


/reference/engine/classes/ReflectionMetadataItem.yaml

ReflectionMetadataItem

概要

属性

方法

活动

属性

方法

活动

在此页面