`Class.UIStroke` 为文本或 UI 边框应用轮廓。一些属性可能需要启用
[改进的 UIStrokes beta](https://devforum.roblox.com/t/studio-beta-uistroke-improvements-scaling-offsets-and-more/3958036)。

主要特性包括：

- 调整 `Class.UIStroke.Color|Color` 和
  `Class.UIStroke.Thickness|Thickness` 的轮廓。
- 独立于文本或 UI 对象更改轮廓的 `Class.UIStroke.Transparency|Transparency`。
- 选择轮廓的 `Class.UIStroke.LineJoinMode|LineJoinMode`（圆形、斜角或尖角）。
- 在其父对象的边框上指定轮廓的 `Class.UIStroke.BorderStrokePosition|BorderStrokePosition` 和/或额外的
  `Class.UIStroke.BorderOffset|BorderOffset` 用于轮廓的位置。
- 通过 `Class.UIGradient` 实例为轮廓添加渐变。
- 使用 [富文本](/ui/rich-text) 标签为行内文本段添加轮廓。

有关 `Class.UIStroke` 对象的更多详细信息，请参见
[外观修改器](/ui/appearance-modifiers)。


UIStroke

当 `Class.UIStroke` 实例应用于文本对象时，此属性确定是否将轮廓应用于对象的边框，而不是文本本身。

<figure>
<img src="../../../assets/ui/ui-objects/UIStroke-As-Text-Outline.png" width="376" />
<figcaption><code>ApplyStrokeMode</code> = <code>Enum.ApplyStrokeMode.Contextual|Contextual</code></figcaption>
</figure>
<figure>
<img src="../../../assets/ui/ui-objects/UIStroke-Stroke-Mode-Border.png" width="376" />
<figcaption><code>ApplyStrokeMode</code> = <code>Enum.ApplyStrokeMode.Border|Border</code></figcaption>
</figure>


UIStroke.ApplyStrokeMode

确定是否将轮廓应用于对象的边框，而不是文本本身。


此属性指定相对于父对象的最小高度或宽度的轮廓位置的额外偏移量（`Datatype.UDim`）。

<figure>
<img src="../../../assets/ui/ui-objects/UIStroke-BorderOffset-Out.png" width="312" />
<figcaption><code>BorderOffset</code> = <code>(0.15, 0)</code></figcaption>
</figure>
<figure>
<img src="../../../assets/ui/ui-objects/UIStroke-BorderOffset-In.png" width="312" />
<figcaption><code>BorderOffset</code> = <code>(0, -16)</code></figcaption>
</figure>


UIStroke.BorderOffset

指定相对于父对象的最小高度或宽度的轮廓位置的额外偏移量。


此属性确定轮廓在其父对象边框上的位置，作为 `Enum.BorderStrokePosition` 值。

<figure>
<img src="../../../assets/ui/ui-objects/UIStroke-BorderStrokePosition-Center.png" width="312" />
<figcaption><code>BorderStrokePosition</code> = <code>Enum.BorderStrokePosition.Center|Center</code></figcaption>
</figure>
<figure>
<img src="../../../assets/ui/ui-objects/UIStroke-BorderStrokePosition-Inner.png" width="312" />
<figcaption><code>BorderStrokePosition</code> = <code>Enum.BorderStrokePosition.Inner|Inner</code></figcaption>
</figure>
<figure>
<img src="../../../assets/ui/ui-objects/UIStroke-BorderStrokePosition-Outer.png" width="312" />
<figcaption><code>BorderStrokePosition</code> = <code>Enum.BorderStrokePosition.Outer|Outer</code></figcaption>
</figure>


UIStroke.BorderStrokePosition

确定轮廓在其父对象边框上的位置。


确定 `Class.UIStroke` 的颜色。您还可以插入一个 `Class.UIGradient` 实例作为子对象以创建渐变轮廓。

<figure>
<img src="../../../assets/ui/ui-objects/UIStroke-Color-Solid.png" width="376" />
<figcaption><code>Color</code> = <code>(0, 95, 225)</code></figcaption>
</figure>
<figure>
<img src="../../../assets/ui/ui-objects/UIStroke-Color-Gradient.png" width="376" />
<figcaption><code>UIStroke</code> 带有 <code>Class.UIGradient</code> 子对象</figcaption>
</figure>


UIStroke.Color

此属性确定 `Class.UIStroke` 是否可见。当设置为 `false` 时，轮廓将不被渲染。默认值为 `true`。


UIStroke.Enabled

此属性确定如何解释角落。它接受 `Enum.LineJoinMode` 值，可为 `Enum.LineJoinMode.Round|Round`（默认）、`Enum.LineJoinMode.Bevel|Bevel` 或 `Enum.LineJoinMode.Miter|Miter`。

<figure>
<img src="../../../assets/ui/ui-objects/UIStroke-LineJoinMode-Round.png" width="376" />
<figcaption><code>LineJoinMode</code> = <code>Enum.LineJoinMode.Round|Round</code></figcaption>
</figure>
<figure>
<img src="../../../assets/ui/ui-objects/UIStroke-LineJoinMode-Bevel.png" width="376" />
<figcaption><code>LineJoinMode</code> = <code>Enum.LineJoinMode.Bevel|Bevel</code></figcaption>
</figure>
<figure>
<img src="../../../assets/ui/ui-objects/UIStroke-LineJoinMode-Miter.png" width="376" />
<figcaption><code>LineJoinMode</code> = <code>Enum.LineJoinMode.Miter|Miter</code></figcaption>
</figure>


UIStroke.LineJoinMode

此属性确定轮廓的 `Class.UIStroke.Thickness|Thickness` 是否以像素为单位测量，或相对于父对象进行缩放。有关更多详细信息，请参见 `Enum.StrokeSizingMode`。


UIStroke.StrokeSizingMode

确定轮廓的 `Class.UIStroke.Thickness|Thickness` 是否以像素为单位测量，或相对于父对象。


此属性确定轮廓的厚度，以像素为单位测量（默认）或相对于父对象进行缩放，这取决于 `Class.UIStroke.StrokeSizingMode|StrokeSizingMode`。

<figure>
<img src="../../../assets/ui/ui-objects/UIStroke-Thickness-4.png" width="376" />
<figcaption><code>Thickness</code> = <code>4</code></figcaption>
</figure>
<figure>
<img src="../../../assets/ui/ui-objects/UIStroke-Thickness-12.png" width="376" />
<figcaption><code>Thickness</code> = <code>12</code></figcaption>
</figure>

在应用到文本对象时，请注意 [缓动](/ui/animation) 此 `Class.UIStroke` 属性。这会在每帧中呈现和存储多个字形大小，可能导致性能问题或文本闪烁。


UIStroke.Thickness

此属性独立于父对象的 `Class.GuiObject.BackgroundTransparency|BackgroundTransparency` 或 `Class.TextLabel.TextTransparency|TextTransparency` 设置轮廓的不透明度。这允许您呈现"中空"的文本和边框（仅由轮廓组成）。

<figure>
<img src="../../../assets/ui/ui-objects/UIStroke-Transparency-A.png" width="376" />
<figcaption><code>Transparency</code> = <code>0.5</code> &nbsp;&middot;&nbsp; <code>Class.TextLabel.TextTransparency</code> = <code>0</code></figcaption>
</figure>
<figure>
<img src="../../../assets/ui/ui-objects/UIStroke-Transparency-B.png" width="376" />
<figcaption><code>Transparency</code> = <code>0</code> &nbsp;&middot;&nbsp; <code>Class.TextLabel.TextTransparency</code> = <code>1</code></figcaption>
</figure>


UIStroke.Transparency

独立于父对象的 `Class.GuiObject.BackgroundTransparency|BackgroundTransparency` 或 `Class.TextLabel.TextTransparency|TextTransparency` 设置轮廓的不透明度。


此属性确定轮廓相对于兄弟 `Class.UIStroke` 实例的渲染顺序。`ZIndex` 较低的将位于 `ZIndex` 较高的下方（后面）。

请注意，对于具有相同 `ZIndex` 的 `Class.UIStroke` 实例，渲染顺序是未定义的。如果渲染顺序很重要，请勿应用多个具有相同 `ZIndex` 的 `Class.UIStroke` 实例。


UIStroke.ZIndex

确定轮廓相对于兄弟 `Class.UIStroke` 实例的渲染顺序。


用户界面约束和布局类的基类；继承自
`Class.UIBase`。


UIComponent

用户界面约束和布局类的基类。


`Class.UIBase` 是 UI 布局和约束类的基类。


UIBase

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

无法直接创建根 `Instance` 对象，但特殊的 `Datatype.Instance.new()` 构造函数通过代码创建对象，
以类的名称作为参数并返回创建的对象。

演示通过连接到
`Class.Instance.AncestryChanged` 事件来检测实例祖先的变化。

ChangingPart 的父级随着时间的推移而设置为不同的值。该零件的父级是该零件的祖先，因此
`Class.Instance.AncestryChanged` 事件将在每次变化时触发。

当此实例被重新父级化或其任何祖先被重新父级化时触发。

你可以使用此事件来跟踪 Studio 中实例的删除，例如在资源管理器中手动删除或通过插件删除。如果你需要检测实例何时被 `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: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` 之后触发。

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

此事件在父级 `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()` 被销毁之前立即触发（或延迟到之后）。

演示 `Class.Instance.StyledPropertiesChanged`。


此事件在实例上的任何样式属性更改时触发，包括当属性设置为 `nil` 时。

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` 则为 `nil`。

创建实例及其所有后代的副本，忽略不为 `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()` 对于给定的 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:FindFirstAncestor()`。

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.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()` 对于给定的 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

每个属性的字符串 → 变体对的字典，其中字符串是属性名称，变体是非 `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 .. " is child number " .. i)
end
```

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

-- 通用循环示例
local children = Workspace:GetChildren()
for i, child in children do
	print(child.Name .. " is child number " .. 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`，它返回属性的默认值或修改值。

Instance:GetStyled

selector

您在实例上定位的伪实例的可选选择器。

指定属性的样式或显式修改值，
如果未样式/修改，则返回默认属性值。

返回指定属性的样式或显式修改值，
如果未样式/修改，则返回默认属性值。

演示 `Class.Instance:GetStyledPropertyChangedSignal()`。


此方法返回一个事件，其行为与 `Class.Instance.StyledPropertiesChanged|StyledPropertiesChanged` 事件完全相同，
只是在给定样式属性更改时触发。通常，使用此方法而不是连接到 `Class.Instance.StyledPropertiesChanged|StyledPropertiesChanged` 的函数来检查属性名称是个好主意。对同一对象使用相同属性名称的后续调用将返回相同的事件。

注意，此事件不会将任何参数传递给连接的函数，因此必须在脚本中直接读取更改的属性值。

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

`true` 如果实例具有给定标签，`false` 否则。

演示如何确定一个实例是否是另一个实例的祖先，使用
`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` 属性将返回 `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)` — 允许根据实例内部包含的实例选择实例。选择器列表相对于每个实例进行评估。

- `:in-radius(studs, complex-selector-list)` 选择在指定数量的 studs 内的实例。选择器列表相对于所有匹配查询的实例进行评估。它有效地评估了一个连接。

```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))"))

-- 获取在 HumanoidRootPart（玩家或 NPC）10 studs 内的 Fireball 模型
print(Workspace:QueryDescendants("Model.FireBall:in-radius(10, Model:has(> Part#HumanoidRootPart))"))
```


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

返回具有给定名称的 `Class.Instance` 的子对象。如果子对象不存在，它将使当前线程挂起，直到它存在。

Instance

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

摘要