一个 `InputBinding` 定义了应触发父级 `Class.InputAction` 的硬件绑定，例如按键、游戏手柄按钮或在触摸设备上的点击。可以有多个 `InputBinding` 实例归属到一个 `Class.InputAction`。

通过将父 `Class.InputAction` 更新为给定状态并触发适当的信号（`Class.InputAction.Pressed|Pressed`，`Class.InputAction.Released|Released`，`Class.InputAction.StateChanged|StateChanged`）以编程方式更新。

此方法只能在 `Class.InputBinding.Type|Type` 设置为 `Enum.InputBindingType|Scriptable` 的绑定上调用。在 `Enum.InputBindingType|Automatic` 绑定上调用将抛出错误。

`state` 参数必须与父 `Class.InputAction` 的 `Class.InputAction.Type|Type` 匹配：

- `Enum.InputActionType|Bool` 期望一个 `boolean`
- `Enum.InputActionType|Direction1D` 期望一个 `number`
- `Enum.InputActionType|Direction2D` 期望一个 `Datatype.Vector2`
- `Enum.InputActionType|Direction3D` 期望一个 `Datatype.Vector3`
- `Enum.InputActionType|ViewportPosition` 期望一个 `Datatype.Vector2`

传递不匹配的类型将导致错误。此方法遵循与硬件输入相同的去重规则，连续使用相同状态值的调用将不会重新触发事件。

父 `Class.InputAction` 必须是 `Class.InputAction.Enabled|Enabled`，且其祖先 `Class.InputContext` 也必须为 `Class.InputContext.Enabled|Enabled`，否则调用将被静默忽略。

InputBinding:Fire

state

要应用的状态值；必须与父动作的 `Class.InputAction.Type|Type` 匹配。

通过此绑定以编程方式更新父 `Class.InputAction` 状态。

InputBinding

指定一个备用的 `Enum.KeyCode` 用于发送方向性的
"后向" 输入到 `Class.InputAction:GetState()|GetState()` 和
父级 `Class.InputAction` 的 `Class.InputAction.StateChanged|StateChanged` 事件。
仅在父级动作的 `Class.InputAction.Type|Type` 为 `Enum.InputActionType|Direction3D`
时适用，在这种情况下，发送的值将是一个 `Datatype.Vector3`，其
`Datatype.Vector3.Z|Z` 分量介于 `0` 和 `1` 之间。

InputBinding.Backward

指定用于将方向性 "向后" 输入派发到父级 `Class.InputAction` 的备用 `Enum.KeyCode`。

确定绑定是否仅在组合的复合方向向量超过最大幅度 `1` 时进行标准化。这可以防止对角线复合输入（例如同时按下 `Class.InputBinding.Up|Up` 和 `Class.InputBinding.Right|Right`）产生大于 `1` 的幅度，确保无论按下哪个键，移动速度保持一致。默认值为 `true`。

此属性仅在父操作的 `Class.InputAction.Type|Type` 为 `Enum.InputActionType|Direction1D`、`Enum.InputActionType|Direction2D` 或 `Enum.InputActionType|Direction3D` 时适用。

当输入轴应保持相互独立时，例如 3D 自由相机移动，或当组合输入的原始值可能超过 `1`（例如鼠标滚轮速度）并且您希望自己处理缩放时，请将此设置为 `false`。


InputBinding.ClampMagnitudeToOne

指定绑定如何将复合方向输入标准化为最大幅度 `1`。


一个自定义的 `Datatype.Content` 图像资产，直观地表示此绑定（例如游戏手柄按钮图像或风格化的键图形）。

当为空（默认值）时，不提供自定义图像。开发者可以使用 `Class.UserInputService:GetImageForKeyCode()` 获取适合平台的图像。将此与 `Class.InputAction.PreferredBinding` 一起使用，以构建自动反映玩家活动输入设备的按键绑定 UI，而无需手动解析要显示的绑定图像。


InputBinding.DisplayImage

要为此绑定显示的自定义图像资产。


一个自定义字符串，覆盖在 UI 元素中显示的此绑定的名称，例如在键提示中显示 "FIGHT" 而不是默认键名 "F"。

当为空（默认值）时，不提供自定义名称。开发者可以使用 `Class.UserInputService:GetStringForKeyCode()` 获取适合平台的键名。将此与 `Class.InputAction.PreferredBinding` 一起使用，以构建自动反映玩家活动输入设备的按键绑定 UI，而无需手动解析要显示的绑定名称。


InputBinding.DisplayName

指定用于将方向性 "下" 输入分派到 `Class.InputAction:GetState()|GetState()` 和父 `Class.InputAction` 的 `Class.InputAction.StateChanged|StateChanged` 事件的备用 `Enum.KeyCode`。

当父操作的 `Class.InputAction.Type|Type` 为 `Enum.InputActionType|Direction1D` 时，分派的值将是 `0` 和 `-1` 之间的数字。

当父操作的 `Class.InputAction.Type|Type` 为 `Enum.InputActionType|Direction2D` 时，分派的值将是一个 `Datatype.Vector2`，其 `Datatype.Vector2.Y|Y` 组件在 `0` 和 `-1` 之间。

当父操作的 `Class.InputAction.Type|Type` 为 `Enum.InputActionType|Direction3D` 时，分派的值将是一个 `Datatype.Vector3`，其 `Datatype.Vector3.Y|Y` 组件在 `0` 和 `-1` 之间。

当父操作的 `Class.InputAction.Type|Type` 为 `Enum.InputActionType|Bool` 时不适用。


InputBinding.Down

指定用于将方向性 "下" 输入分派到父 `Class.InputAction` 的备用 `Enum.KeyCode`。


指定用于将方向性 "前" 输入分派到 `Class.InputAction:GetState()|GetState()` 和父 `Class.InputAction` 的 `Class.InputAction.StateChanged|StateChanged` 事件的备用 `Enum.KeyCode`。仅在父操作的 `Class.InputAction.Type|Type` 为 `Enum.InputActionType|Direction3D` 时适用，此时分派的值将是一个 `Datatype.Vector3`，其 `Datatype.Vector3.Z|Z` 组件在 `0` 和 `-1` 之间。


InputBinding.Forward

指定用于将方向性 "前" 输入分派到父 `Class.InputAction` 的备用 `Enum.KeyCode`。


指定触发父 `Class.InputAction` 的 `Enum.KeyCode`。代码类型应与输入操作的 `Class.InputAction.Type|Type` 匹配，例如 `Enum.KeyCode.E` 对于 `Enum.InputActionType|Bool` 类型的操作，或 `Enum.KeyCode.Thumbstick1` 对于 `Enum.InputActionType|Direction2D` 类型的操作。类型不匹配将导致 `Class.InputAction` 不被触发，或者 `Class.InputAction.StateChanged|StateChanged` 事件将接收一个转换值。


InputBinding.KeyCode

指定触发父 `Class.InputAction` 的 `Enum.KeyCode`。


指定用于将方向性 "左" 输入分派到 `Class.InputAction:GetState()|GetState()` 和父 `Class.InputAction` 的 `Class.InputAction.StateChanged|StateChanged` 事件的备用 `Enum.KeyCode`。

当父操作的 `Class.InputAction.Type|Type` 为 `Enum.InputActionType|Direction2D` 时，分派的值将是一个 `Datatype.Vector2`，其 `Datatype.Vector2.X|X` 组件在 `0` 和 `-1` 之间。

当父操作的 `Class.InputAction.Type|Type` 为 `Enum.InputActionType|Direction3D` 时，分派的值将是一个 `Datatype.Vector3`，其 `Datatype.Vector3.X|X` 组件在 `0` 和 `-1` 之间。

当父操作的 `Class.InputAction.Type|Type` 为 `Enum.InputActionType|Direction1D` 或 `Enum.InputActionType|Bool` 时不适用。


InputBinding.Left

指定用于将方向性 "左" 输入分派到父 `Class.InputAction` 的备用 `Enum.KeyCode`。


InputBinding.PointerIndex

触发 `Class.InputAction` 的数值，`Class.InputAction.Type|Type` 为 `Enum.InputActionType|Bool`，例如当游戏手柄触发器如 `Enum.KeyCode.ButtonL2` 超过 `0.5`（按下到一半）时。默认值为 `0.5`。

此属性必须大于或等于 `Class.InputBinding.ReleasedThreshold|ReleasedThreshold`，否则将被限制为 `Class.InputBinding.ReleasedThreshold|ReleasedThreshold`。


InputBinding.PressedThreshold

触发 `Class.InputAction` 的数值，`Class.InputAction.Type|Type` 为 `Enum.InputActionType|Bool`。


指定作为绑定所需修饰符的 `Enum.KeyCode`。只有在此输入在 `Class.InputBinding.KeyCode|KeyCode`、`Class.InputBinding.UIButton|UIButton` 或复合方向之前被按下时，`Class.InputBinding` 才会触发父 `Class.InputAction`。

`Class.InputBinding.PrimaryModifier|PrimaryModifier` 和 `Class.InputBinding.SecondaryModifier|SecondaryModifier` 之间没有顺序要求。如果同时设置了这两个属性，则必须同时按下这两个修饰符以激活绑定，但按下的顺序无关紧要。

如果设置为 `Enum.KeyCode.Unknown`，则不需要主要修饰符。


InputBinding.PrimaryModifier

指定必须按下的主要 `Enum.KeyCode` 以激活绑定。


触发 `Class.InputAction` 的数值，`Class.InputAction.Type|Type` 为 `Enum.InputActionType|Bool`，例如当游戏手柄触发器如 `Enum.KeyCode.ButtonL2` 低于 `0.5`（按下不到一半）时。默认值为 `0.2`。

此属性必须小于或等于 `Class.InputBinding.PressedThreshold|PressedThreshold`，否则将被限制为 `Class.InputBinding.PressedThreshold|PressedThreshold`。


InputBinding.ReleasedThreshold

一个数值，通过应用二次响应曲线来控制游戏手柄摇杆输入的灵敏度。通常用于相机控制，使小的摇杆输入更精确，同时快速提升以允许更大的移动和更高幅度的输入。

范围在 `1` 到 `10` 之间，较高的值提供更强烈的曲线。默认值为 `1`，此时输入将完全按接收的方式返回。

仅在父操作的 `Class.InputAction.Type|Type` 为 `Enum.InputActionType|Direction2D` 且 `Class.InputBinding.KeyCode|KeyCode` 为 `Enum.KeyCode.Thumbstick1|Thumbstick1` 或 `Enum.KeyCode.Thumbstick2|Thumbstick2` 时适用。


InputBinding.ResponseCurve

配置更精确的摇杆瞄准的数值。


指定用于将方向性 "右" 输入分派到 `Class.InputAction:GetState()|GetState()` 和父 `Class.InputAction` 的 `Class.InputAction.StateChanged|StateChanged` 事件的备用 `Enum.KeyCode`。

当父操作的 `Class.InputAction.Type|Type` 为 `Enum.InputActionType|Direction2D` 时，分派的值将是一个 `Datatype.Vector2`，其 `Datatype.Vector2.X|X` 组件在 `0` 和 `1` 之间。

当父操作的 `Class.InputAction.Type|Type` 为 `Enum.InputActionType|Direction3D` 时，分派的值将是一个 `Datatype.Vector3`，其 `Datatype.Vector3.X|X` 组件在 `0` 和 `1` 之间。

当父操作的 `Class.InputAction.Type|Type` 为 `Enum.InputActionType|Direction1D` 或 `Enum.InputActionType|Bool` 时不适用。


InputBinding.Right

指定用于将方向性 "右" 输入分派到父 `Class.InputAction` 的备用 `Enum.KeyCode`。


均匀应用于输出值每个组件的标量乘数。适用于 `Class.InputAction` 类型 `Enum.InputActionType|Direction1D`、`Enum.InputActionType|Direction2D` 和 `Enum.InputActionType|Direction3D`。

要独立缩放各个组件，请使用 `Class.InputBinding.Vector2Scale|Vector2Scale`（对于 `Enum.InputActionType|Direction2D`）或 `Class.InputBinding.Vector3Scale|Vector3Scale`（对于 `Enum.InputActionType|Direction3D`）。当同时设置 `Scale` 和向量缩放时，两者都会被应用。


InputBinding.Scale

均匀应用于方向性 `Class.InputAction` 输出的标量乘数。


指定作为绑定所需修饰符的 `Enum.KeyCode`。只有在此输入在 `Class.InputBinding.KeyCode|KeyCode`、`Class.InputBinding.UIButton|UIButton` 或复合方向之前被按下时，`Class.InputBinding` 才会触发父 `Class.InputAction`。

`Class.InputBinding.PrimaryModifier|PrimaryModifier` 和 `Class.InputBinding.SecondaryModifier|SecondaryModifier` 之间没有顺序要求。如果同时设置了这两个属性，则必须同时按下这两个修饰符以激活绑定，但按下的顺序无关紧要。

如果设置为 `Enum.KeyCode.Unknown`，则不需要次要修饰符。


InputBinding.SecondaryModifier

指定必须按下的次要 `Enum.KeyCode` 以激活绑定。


确定此 `InputBinding` 是由硬件输入（`Enum.InputBindingType|Automatic`）触发，还是通过 `Class.InputBinding:Fire()|Fire()`（`Enum.InputBindingType|Scriptable`）以编程方式触发。

当设置为 `Enum.InputBindingType|Automatic`（默认值）时，绑定会根据其 `Class.InputBinding.KeyCode|KeyCode` 或复合方向或 UI 按钮属性响应物理输入设备（键盘、鼠标、游戏手柄、触摸）。

当设置为 `Enum.InputBindingType|Scriptable` 时，绑定会忽略硬件输入，而仅通过 `Class.InputBinding:Fire()|Fire()` 方法接收状态更新。


InputBinding.Type

确定此绑定是由硬件输入触发还是通过 `Class.InputBinding:Fire()|Fire()` 以编程方式触发。


`Class.GuiButton` 连接到布尔动作。

InputBinding.UIButton

将 `Class.GuiButton` 连接到布尔动作。

指定必须按下的 `Class.GuiButton` 以触发父 `Class.InputAction` 的 `Class.InputBinding`。其行为类似于 `Class.InputBinding.PrimaryModifier|PrimaryModifier` 和 `Class.InputBinding.SecondaryModifier|SecondaryModifier`，但接受 UI 按钮引用而不是 `Enum.KeyCode`。

这对于触摸输入特别有用，因为相关交互由触摸开始时在屏幕上的位置定义，例如一个动态摇杆，仅应对在特定 UI 区域内开始的触摸做出响应。

如果为 `nil`，则不需要修饰符。


InputBinding.UIModifier

指定必须处于活动状态的 `Class.GuiButton` 以激活绑定。

指定用于将方向性"上"输入分派到 `Class.InputAction:GetState()|GetState()` 和
父 `Class.InputAction` 的 `Class.InputAction.StateChanged|StateChanged` 事件的备用 `Enum.KeyCode`。

当父动作的 `Class.InputAction.Type|Type` 是 `Enum.InputActionType|Direction1D` 时，分派的值将是一个介于 `0` 和 `1` 之间的数字。

当父动作的 `Class.InputAction.Type|Type` 是 `Enum.InputActionType|Direction2D` 时，分派的值将是
一个 `Datatype.Vector2`，其 `Datatype.Vector2.Y|Y` 组件介于 `0` 和 `1` 之间。

当父动作的 `Class.InputAction.Type|Type` 是 `Enum.InputActionType|Direction3D` 时，分派的值将是
一个 `Datatype.Vector3`，其 `Datatype.Vector3.Y|Y` 组件介于 `0` 和 `1` 之间。

当父动作的 `Class.InputAction.Type|Type` 是 `Enum.InputActionType|Bool` 时，不适用。

InputBinding.Up

指定用于将方向性"上"输入分派到父 `Class.InputAction` 的备用 `Enum.KeyCode`。

每个输出组件独立线性缩放的大小。仅在父动作的 `Class.InputAction.Type|Type` 为 `Enum.InputActionType|Direction2D` 时适用。

InputBinding.Vector2Scale

应用于 `Enum.InputActionType|Direction2D` 动作输出的每个组件的缩放。

每个输出组件独立线性缩放的大小。仅在父动作的 `Class.InputAction.Type|Type` 为 `Enum.InputActionType|Direction3D` 时适用。

InputBinding.Vector3Scale

应用于 `Enum.InputActionType|Direction3D` 动作输出的每个组件的缩放。

定义应触发父级 `Class.InputAction` 的硬件绑定。

`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

一个字符串数组，每个字符串表示应用于实例的标签。

获取应用于实例的所有标签的数组。

Instance

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

/reference/engine/classes/InputBinding.yaml

摘要