GamePassService是一个支持使用_资产ID_的遗留游戏通行证的服务。
`Class.MarketplaceService`应用于所有新的游戏通行证。

有关游戏通行证的更多信息，请参见
[游戏通行证](/production/monetization/passes)。


以下示例将打印最近加入的玩家是否拥有 ID 为 103728213 的通行证。

此函数与新的游戏通行证无效；请使用
`Class.MarketplaceService:UserOwnsGamePassAsync()`代替。

此函数如果`Class.Player`拥有指定的遗留游戏通行证，则返回`true`。此函数的结果可能会被缓存，这意味着不应依赖其提供最新结果。

有关更多信息，请参见[通行证](/production/monetization/passes)。

#### 遗留游戏通行证

历史上，Roblox上的游戏通行证都与**资产ID**相关联。虽然此类游戏通行证仍然具有资产ID，但现在它们还具有**通行证ID**。所有新创建的游戏通行证**仅**具有通行证ID。

您使用**资产ID**还是**通行证ID**决定了您可以使用的API成员。

<table>
    <thead>
        <tr>
            <td></td>
            <td>资产ID（遗留）</td>
            <td>通行证ID（当前）</td>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td>验证拥有权</td>
            <td><code>Class.GamePassService:PlayerHasPass()</code></td>
            <td><code>Class.MarketplaceService:UserOwnsGamePassAsync()</code></td>
        </tr>
        <tr>
            <td>提示购买</td>
            <td><code>Class.MarketplaceService:PromptPurchase()</code></td>
            <td><code>Class.MarketplaceService:PromptGamePassPurchase()</code></td>
        </tr>
        <tr>
            <td>提示的购买完成</td>
            <td><code>Class.MarketplaceService.PromptPurchaseFinished</code></td>
            <td><code>Class.MarketplaceService.PromptGamePassPurchaseFinished</code></td>
        </tr>
    </tbody>
</table>


GamePassService:PlayerHasPass

player

gamePassId

游戏通行证的_资产ID_。这**不是**_游戏通行证ID_
（见上文）。


`Class.Player`是否拥有游戏通行证。


如果`Class.Player`拥有指定的**遗留**游戏通行证，则返回`true`。与新的游戏通行证无效。


GamePassService

与遗留游戏通行证系统相关的服务。请使用
`Class.MarketplaceService`进行所有新工作。


`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` 不同的东西。请注意，当子项被销毁时（使用 `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()` 被销毁之前立即触发（或推迟到之后）。

此事件在实例上的任何样式属性被更改时触发，包括当某个属性被设置为 `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` 的第一个祖先，
对于给定的 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
```
更好的方法是在先检查 `Part` 的情况下使用 `FindFirstChild()`，
然后使用 `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.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`。如果可选的 `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()` 对于给定的 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("属性已更改")
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

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/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 的后代，而不是祖先。
贴图是 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`。

Instance:isDescendantOf

此方法指示特定属性是否已从代码实例化的默认值进行了修改。
如果在通过代码新创建的实例上调用此方法（`Datatype.Instance.new()`），则该方法将返回 `false`。
如果在通过工作室工作流创建的对象上调用此方法，结果可能会有所不同。

例如，查询 `Class.TextLabel.BackgroundColor3|BackgroundColor3` 属性
通过 [Explorer](/studio/explorer) 窗口插入的 `Class.TextLabel` 将返回 `true`，
但查询通过 `Datatype.Instance.new()` 创建的同一属性将返回 `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]` — 匹配具有指定的
  [属性](/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")

-- 获取任何 Model 的直接子项，这些子项标记为 "SwordPart"
print(Workspace:QueryDescendants("Model > .SwordPart"))

-- 获取直接子项为 Part 并标记为 "Apple"
print(Workspace:QueryDescendants("> Part.Apple"))

-- 获取任何 Model 的后代，其属性 "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" 的 Model 子项以外的后代
print(Workspace:QueryDescendants(":not(Model > .SwordPart)"))

-- 获取包含 Tool 实例作为自身后代的后代
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()` 如果该实例 **不** 是 `Class.Instance.Archivable|Archivable` 将返回 `nil`。

使用 **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.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` 的 **祖先** 是实例的所有父对象。

许多其他 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` 的层次父对象。

Instance.PredictionMode

此属性用于保护 `Class.CoreGui` 服务中的对象，防止用户以未授权的方式进行更改。它已经被弃用，
并且没有任何作用。

Instance.RobloxLocked

一个已弃用的属性，曾用于保护 `Class.CoreGui` 对象。

将实例变为 **沙盒容器**，这是一个实验性功能，
限制特定容器内脚本可以执行的操作。有关详细信息，请参见
[脚本功能](/scripting/capabilities)。

Instance.Sandboxed

启用后，实例只能访问其 `Capabilities`
列表中的功能。

该实例的唯一标识符，与 `Class.Instance.Name`
不同，它不一定是唯一的。

Instance.UniqueId

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

/reference/engine/classes/GamePassService.yaml