这个代码示例包含了一个简单的例子，演示如何使用
`Class.Player:GetMouse()` 函数在 `LocalScript` 中检索本地玩家的
`PlayerMouse`。此代码应放置在 `StarterPlayerScripts` 中的
`LocalScript` 中。

PlayerMouse 的行为与通过 `Class.Tool.Equipped` 获得的 `Class.Mouse` 对象完全相同。可以通过 `Class.LocalScript|LocalScripts` 中的本地玩家的 `Class.Player:GetMouse()` 方法来访问它。PlayerMouse 和 `Class.Mouse` 都是遗留 API，已被 `Class.UserInputService` 取代。

PlayerMouse 和 `Class.Mouse` 对象之间唯一的区别是 PlayerMouse 可以通过 `Class.Player:GetMouse()` 方法获得。

在大多数情况下，建议开发者使用新的 `Class.UserInputService`。然而，出于多种原因，PlayerMouse 和 Mouse 对象仍然受到支持。有关在您的体验中自定义输入的更多信息，请参见 [Input and Camera](/input)。


PlayerMouse

PlayerMouse 的行为与通过 `Class.Tool.Equipped` 获得的 `Class.Mouse` 对象完全相同。PlayerMouse 和 `Class.Mouse` 都是遗留 API，已被 `Class.UserInputService` 取代。


**Mouse** 已被 `Class.UserInputService` 和 `Class.ContextActionService` 取代，这两个类覆盖了更广泛的范围，更具功能性，并且更好地支持 **跨平台** 模式。它仍然被支持，因为它被广泛使用，但您应该强烈考虑使用这些替代方案。

**Mouse** 对象提供了各种指针的 API，主要用于按钮和射线检测。可以通过在 `Class.Players.LocalPlayer` 的 `Class.LocalScript` 中调用 `Class.Player:GetMouse()` 来访问它。它也会通过 `Class.Tool.Equipped` 事件传递。

- 它最显著的特性是 `Class.Mouse.Icon|Icon` 属性，可以更改光标的外观。
- 它不断将屏幕鼠标位置的射线投射到 3D 世界中，使用 `Class.Mouse.TargetFilter|TargetFilter` 属性，将射线检测结果存储在 `Class.Mouse.Hit|Hit`、`Class.Mouse.Target|Target` 和 `Class.Mouse.TargetSurface|TargetSurface` 属性中。这些对于简单情况可能有用，但在更复杂的 [射线检测](/workspace/raycasting) 场景中应使用 `Class.WorldRoot:Raycast()`。
- `Class.Plugin|Plugins` 可以使用 `Class.Plugin:GetMouse()` 获取一个 `Class.PluginMouse`，其行为类似。

```lua
-- 来自 LocalScript：
local Players = game:GetService("Players")
local player = Players.LocalPlayer
local mouse = player:GetMouse()
-- 设置鼠标图标
mouse.Icon = "rbxasset://SystemCursors/Wait"
```
注意：

- 该对象不控制/限制指针移动。有关此内容，请参见 `Class.UserInputService.MouseBehavior` 和 `Class.UserInputService.MouseDeltaSensitivity`。
- 如果两个函数连接到同一输入事件，例如 `Class.Mouse.Button1Down|Button1Down`，**两个** 函数将在事件触发时运行。没有传递/传递输入的概念，因为事件不支持此行为。然而，`Class.ContextActionService` 通过 `Class.ContextActionService:BindAction()|BindAction` 确实具有此行为。
- 虽然并非所有平台都有鼠标，但 Mouse 仍然会在移动设备（触摸）和控制台（游戏手柄）上正常工作，这些设备通常没有鼠标或指针硬件。要实现明确的跨平台行为，请使用 `Class.UserInputService` 和 `Class.ContextActionService`。

有关自定义您体验中的输入的更多信息，请参见 [输入和相机](/input)。

当玩家按下左键时触发此事件。请注意，可以从 `Class.Tool` 访问此事件；例如，当放置在 `Class.LocalScript` 中时，以下代码会在每次按下左键时打印 `Button1Down`。

```lua
local tool = script.Parent  -- 确保这是一个 Tool 对象

tool.Equipped:Connect(function(mouse)
	mouse.Button1Down:Connect(function()
		print("Button1Down")
	end)
end)
```
您可以使用 `Class.Mouse.Hit|Hit` 和 `Class.Mouse.Target|Target` 属性来查找鼠标在世界空间中的位置以及它是否指向任何 `Class.BasePart`。

Mouse.Button1Down

当玩家释放左键时触发此事件。请注意，可以从 `Class.Tool` 访问此事件；例如，当放置在 `Class.LocalScript` 时，以下代码会在每次释放左键时打印 `Button1Up`。

```lua
local tool = script.Parent  -- 确保这是一个 Tool 对象

tool.Equipped:Connect(function(mouse)
	mouse.Button1Up:Connect(function()
		print("Button1Up")
	end)
end)
```
您可以使用 `Class.Mouse.Hit|Hit` 和 `Class.Mouse.Target|Target` 属性来查找鼠标在世界空间中的位置以及它是否指向任何 `Class.BasePart`。

Mouse.Button1Up

当玩家按下右键时触发此事件。请注意，可以从 `Class.Tool` 访问此事件；例如，当放置在 `Class.LocalScript` 中时，以下代码会在每次按下右键时打印 `Button2Down`。

```lua
local tool = script.Parent  -- 确保这是一个 Tool 对象

tool.Equipped:Connect(function(mouse)
	mouse.Button2Down:Connect(function()
		print("Button2Down")
	end)
end)
```
您可以使用 `Class.Mouse.Hit|Hit` 和 `Class.Mouse.Target|Target` 属性来查找鼠标在世界空间中的位置以及它是否指向任何 `Class.BasePart`。

Mouse.Button2Down

当玩家释放右键时触发此事件。请注意，可以从 `Class.Tool` 访问此事件；例如，当放置在 `Class.LocalScript` 中时，以下代码会在每次释放右键时打印 `Button2Up`。

```lua
local tool = script.Parent  -- 确保这是一个 Tool 对象

tool.Equipped:Connect(function(mouse)
	mouse.Button2Up:Connect(function()
		print("Button2Up")
	end)
end)
```
您可以使用 `Class.Mouse.Hit|Hit` 和 `Class.Mouse.Target|Target` 属性来查找鼠标在世界空间中的位置以及它是否指向任何 `Class.BasePart`。

Mouse.Button2Up

本示例演示鼠标事件如何在每帧中传递


当鼠标未被传递到另一个鼠标事件时，在每个心跳期间触发。

注意，此事件不应用于确定鼠标何时静止。由于它在每个心跳中触发，它将在 `Class.Mouse.Move` 事件之间触发。

有关如何获取 `Class.Mouse` 对象的信息，请参见 `Class.Mouse` 页面。

开发者可以使用 `Class.Mouse.Hit` 和 `Class.Mouse.Target` 属性查找鼠标在世界空间中的位置，看看它是否指向任何 `Class.BasePart`。

注意，开发者建议在新工作中使用 `Class.UserInputService`，而不是 `Class.Mouse` 对象。

Mouse.Idle

当鼠标未被传递到另一个鼠标事件时，在每个心跳期间触发。

以下示例假设已定义 'mouse'，将打印被按下的键（例如 "q"）以及该键的 ascii 值（例如 113）。

当按下某个键时触发此事件，传递的参数是被按下的键。

注意：

- 并非所有键都会产生此事件。然而，您可以使用一些键（例如"/"），通过使用 `Class.Mouse.KeyUp` 事件来解决此问题。
- 某些键会产生与其他键相同的字符串。
- 字符串可能为空（可能是由于"\\0"键代码）。

Mouse.KeyDown

Mouse.keyDown

下面的示例，假设 'mouse' 已经定义，将打印释放的键（例如 "q"）以及该键的 ASCII 值（例如 113）。

当键被释放时将触发此事件，传递的参数为被释放的键。

注意：

- 并不是所有键都生成此事件。然而，您可以通过少数几个键来绕过此限制，例如使用 `[[API:Class/Mouse/KeyUp|KeyUp]]` 事件的"/"。
- 一些键生成与其他键相同的字符串。
- 字符串可能为空（可能由于 "\\0" 键代码）。


Mouse.KeyUp

下面的示例允许 `Class.Players.LocalPlayer|本地玩家` 用他们的鼠标移动
部件。

当玩家在某个部件上按下鼠标左键时，该部件就是
`Class.Mouse.Target|鼠标的目标`，并成为 _点_。在玩家释放鼠标左键之前，那个部件会在玩家移动鼠标时移动到鼠标的世界位置。

请注意，`Class.Mouse.TargetFilter` 属性允许代码在确定鼠标的世界位置时忽略正在移动的部件。

代码应在 `LocalScript` 中正常工作。

当鼠标移动时触发此事件。

注意，此事件在鼠标位置更新时触发，因此在移动时会重复触发。

有关如何获取 `Class.Mouse` 对象的信息，请参见 `Class.Mouse` 页面。

开发人员可以找到鼠标在世界空间中的位置，如果它指向任何 `Class.BasePart`，可以使用 `Class.Mouse.Hit` 和 `Class.Mouse.Target` 属性。

```
mouse.Move:Connect(function()
	local position = mouse.Hit.p
	local target = mouse.Target
	print(target, position)
end)
```
注意，建议开发人员在新工作中使用 `Class.UserInputService` 而不是 `Class.Mouse` 对象。


Mouse.Move

以下示例假定您已经获取了玩家的鼠标（并将其设置为名为 'mouse' 的变量），无论是通过使用 `Class.Tool`、`Class.HopperBin` 还是 `Class.Player:GetMouse()` 方法。当玩家向后滚动时，它将打印 "轮子向后滚动！"

当鼠标滚轮向后滚动时触发 WheelBackward 事件。此事件的可能用法包括在第一人称射击 (FPS) 游戏中切换枪的瞄准镜或缩放玩家的相机。

这可以与向前滚动事件 `Class.Mouse.WheelForward` 一起使用。

有关如何获取 `Class.Mouse` 对象的信息，请参见 `Class.Mouse` 页面。

注意，建议开发人员在新工作中使用 `Class.UserInputService` 而不是 `Class.Mouse` 对象。


Mouse.WheelBackward

下面的示例假设您已经获取了玩家的鼠标（并将其设置为名为'mouse'的变量），无论是通过使用`Tool`、`HopperBin`还是`Class.Player:GetMouse()`方法。当玩家向前滚动时，它将打印“轮子向前滚动!”。

当鼠标滚轮向前滚动时触发 WheelForward 事件。此事件的可能用法包括在第一人称射击 (FPS) 游戏中切换枪的瞄准镜或缩放玩家的相机。

这可以与向后滚动事件 `Class.Mouse.WheelBackward` 一起使用。

有关如何获取 `Class.Mouse` 对象的信息，请参见 `Class.Mouse` 页面。

注意，建议开发人员在新工作中使用 `Class.UserInputService` 而不是 `Class.Mouse` 对象。


Mouse.WheelForward

Mouse

本示例中的代码，当放置在 `StarterPlayerScripts` 的 `LocalScript` 中时，将始终绘制一个红色激光束，连接角色的头部和 `Class.Mouse.Hit`。

请注意，这个激光束在第三人称视角中将直接穿过阻碍，因为 `Mouse` 的射线投射是从 `Class.Workspace.CurrentCamera` 而不是头部进行的。

下面的代码可视化了 `Class.Mouse.Hit` 与 `Class.Mouse.Origin` 之间的差异。为了实现这一点，代码使用了击中位置和原点 `Datatype.CFrame` 值的 `Datatype.Vector3` 坐标，通过 `.p` 进行访问。

差异在于原点是“鼠标来的地方”（其原点），而击中位置是鼠标击中的位置（即玩家按下鼠标时的位置）。

此示例还可视化了鼠标原点与 `CurrentCamera` 位置非常相似，通过打印两者之间的大小（距离）来展示这一点。

该属性指示鼠标在 3D 空间中的位置的 `Datatype.CFrame`。请注意，`Class.Mouse.TargetFilter` 及其后代将被忽略。

开发者可以这样获取 Hit 的位置：

```
local position = mouse.Hit.Position
```
Hit 通常用于 `Class.Tool|Tools` 向鼠标发射武器，以便在第三人称视角中使用。

开发者要寻找鼠标所指向的 `Class.BasePart` 应使用 `Class.Mouse.Target`。

#### Mouse.Hit 是如何计算的？

Hit CFrame 的位置是通过鼠标内部的 `Datatype.Ray`（是 `Class.Mouse.UnitRay` 的扩展版本）与 3D 空间中的对象（例如零件）的交点计算得出的。

Hit CFrame 的朝向与 `Class.Mouse.UnitRay` 的方向对应。

```
local unitRayDirection = mouse.UnitRay.Direction
local mouseHitDirection = mouse.Hit.lookVector
-- unitRayDirection ≈ mouseHitDirection
-- 这两个向量大致相等
```
注意，当计算 Hit `Datatype.CFrame` 的朝向时，不会使用 `Class.Workspace.CurrentCamera` 的滚动值。

鼠标内部的射线延伸 1,000 个 studs。如果鼠标没有指向 3D 空间中的对象（例如，当它指向天空时），该属性将为 1,000 个 studs，距离 `Class.Workspace.CurrentCamera`。

Mouse.Hit

鼠标在 3D 空间中的位置的 `Datatype.CFrame`。

Mouse.hit

此示例将 `Class.Players.LocalPlayer` 的鼠标图标更改为看起来像一只
dragon 的图像。


**图标** 是一个决定作为指针使用的图像的属性。如果为空，则使用默认箭头。当光标悬停在 `Class.GuiButton` 上时，此属性会被临时忽略。

要完全隐藏光标，**不要** 使用透明图像 &ndash; 而是将 `Class.UserInputService.MouseIconEnabled` 设置为 false。

在体验中获取/设置用户鼠标图标时，您应该使用 `Class.UserInputService.MouseIcon`。`Class.Mouse.Icon` 在为插件设置鼠标光标的新 API 发布后将被弃用。

##### 设计光标

创建自己的鼠标光标时，以下指南可能会很有用：

- 使用的图像的尺寸决定了光标的大小。
- 图像的尺寸不得超过任一轴上的 256 像素。
- 图像的 **中心** 是鼠标输入发出的地方。
- 默认鼠标图像为 64x64 像素，鼠标占据 17x24 像素的空间。

##### 系统光标

当使用从 `Class.Plugin:GetMouse()` 获取的 `Class.PluginMouse` 时，您可以使用以下图标，类似于系统的默认光标，如手、箭头、I beam 等。您可以将这些与 GUI 事件一起使用，如 `Class.GuiObject.MouseEnter|MouseEnter`、`Class.GuiObject.MouseLeave|MouseLeave` 和 `Class.GuiButton.MouseButton1Down|MouseButton1Down`，以在与某些类型的 GUI 组件交互时提供一致的 Studio 体验。请注意，这些仅适用于 Studio 插件；它们不适用于其他 `Class.Mouse` 对象。

<table>
    <thead>
        <tr>
            <th>外观*</th>
            <th>资源</th>
            <th>建议用途</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Pointer.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Arrow</code></td>
            <td>默认点击和选择。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-PointingHand.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/PointingHand</code></td>
            <td>悬停在活动链接/按钮上。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-OpenHand.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/OpenHand</code></td>
            <td>悬停在可拖动项上。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-GrabbingHand.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/ClosedHand</code></td>
            <td>拖动项。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-IBeam.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/IBeam</code></td>
            <td>悬停在文本框中。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeNS.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeNS</code></td>
            <td>悬停在垂直调整手柄上。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeEW.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeEW</code></td>
            <td>悬停在水平调整手柄上。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeNESW.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeNESW</code></td>
            <td>悬停在角落调整手柄上。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeNWSE.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeNWSE</code></td>
            <td>悬停在角落调整手柄上。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeAll.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeAll</code></td>
            <td>悬停在多方向调整手柄上。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeSplitV.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SplitNS</code></td>
            <td>悬停在垂直"分割"手柄上。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeSplitH.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SplitEW</code></td>
            <td>悬停在水平"分割"手柄上。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Forbidden.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Forbidden</code></td>
            <td>悬停在锁定/禁止项上。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Wait.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Wait</code></td>
            <td>指示操作正在进行中。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Busy.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Busy</code></td>
            <td>指示系统繁忙。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Crosshair.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Cross</code></td>
            <td>悬停在精确选择区域。</td>
        </tr>
    </tbody>
</table>

<figcaption>* 这些外观是近似值 &mdash; 实际外观取决于您的操作系统。</figcaption>


Mouse.Icon

作为 `Class.Mouse` 图标使用的图像的内容 ID。


**图标** 是一个决定作为指针使用的图像的属性。如果为空，则使用默认箭头。当光标悬停在 `Class.GuiButton` 上时，此属性会被临时忽略。此属性仅支持资产 URI。

要完全隐藏光标，**不要** 使用透明图像 &ndash; 而是将 `Class.UserInputService.MouseIconEnabled` 设置为 false。

在体验中获取/设置用户鼠标图标时，您应该使用 `Class.UserInputService.MouseIcon`。`Class.Mouse.Icon` 在为插件设置鼠标光标的新 API 发布后将被弃用。

##### 设计光标

创建自己的鼠标光标时，以下指南可能会很有用：

- 使用的图像的尺寸决定了光标的大小。
- 图像的尺寸不得超过任一轴上的 256 像素。
- 图像的 **中心** 是鼠标输入发出的地方。
- 默认鼠标图像为 64x64 像素，鼠标占据 17x24 像素的空间。

##### 系统光标

当使用从 `Class.Plugin:GetMouse()` 获取的 `Class.PluginMouse` 时，您可以使用以下图标，类似于系统的默认光标，如手、箭头、I beam 等。您可以将这些与 GUI 事件一起使用，如 `Class.GuiObject.MouseEnter|MouseEnter`、`Class.GuiObject.MouseLeave|MouseLeave` 和 `Class.GuiButton.MouseButton1Down|MouseButton1Down`，以在与某些类型的 GUI 组件交互时提供一致的 Studio 体验。请注意，这些仅适用于 Studio 插件；它们不适用于其他 `Class.Mouse` 对象。

<table>
    <thead>
        <tr>
            <th>外观*</th>
            <th>资源</th>
            <th>建议用途</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Pointer.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Arrow</code></td>
            <td>默认点击和选择。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-PointingHand.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/PointingHand</code></td>
            <td>悬停在活动链接/按钮上。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-OpenHand.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/OpenHand</code></td>
            <td>悬停在可拖动项上。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-GrabbingHand.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/ClosedHand</code></td>
            <td>拖动项。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-IBeam.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/IBeam</code></td>
            <td>悬停在文本框中。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeNS.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeNS</code></td>
            <td>悬停在垂直调整手柄上。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeEW.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeEW</code></td>
            <td>悬停在水平调整手柄上。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeNESW.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeNESW</code></td>
            <td>悬停在角落调整手柄上。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeNWSE.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeNWSE</code></td>
            <td>悬停在角落调整手柄上。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeAll.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SizeAll</code></td>
            <td>悬停在多方向调整手柄上。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeSplitV.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SplitNS</code></td>
            <td>悬停在垂直"分割"手柄上。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-ResizeSplitH.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/SplitEW</code></td>
            <td>悬停在水平"分割"手柄上。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Forbidden.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Forbidden</code></td>
            <td>悬停在锁定/禁止项上。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Wait.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Wait</code></td>
            <td>指示操作正在进行中。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Busy.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Busy</code></td>
            <td>指示系统繁忙。</td>
        </tr>
        <tr>
            <td><img src="../../../assets/misc/Mouse-Icon-Crosshair.png" width="30" /></td>
            <td><code>rbxasset://SystemCursors/Cross</code></td>
            <td>悬停在精确选择区域。</td>
        </tr>
    </tbody>
</table>

<figcaption>* 这些外观是近似值 &mdash; 实际外观取决于您的操作系统。</figcaption>


Mouse.IconContent

作为 `Class.Mouse` 图标使用的图像的内容。仅支持资产 URI。


原始的 `Class.Mouse` 属性是一个 `Datatype.CFrame`，指示鼠标的原始位置。它位于 `Class.Workspace.CurrentCamera` 处并朝向鼠标的 3D 位置。

`Class.Mouse.UnitRay` 从与Origin相同的位置开始，并在相同的方向上延伸 1 个 Stud。

```lua
local unitRay = mouse.UnitRay
local origin = mouse.Origin
-- unitRay.Direction = origin.p
-- unitRay.Direction ≈ origin.lookVector
```
有关 `Class.Mouse` 在 3D 空间中的位置，请参见 `Class.Mouse.Hit`。


Mouse.Origin

定位在 `Class.Workspace.CurrentCamera` 处并朝向鼠标的 3D 位置的 `Datatype.CFrame`。


当放置在 `StarterPlayerScripts` 中的 `LocalScript` 时，以下代码
会改变玩家点击的每个 `BasePart` 的 `Class.BasePart.BrickColor`，
例如出生位置或基板。


鼠标 `Class.Mouse|mouse` 指向的 3D 空间中的对象。

注意：

- 如果设置了 `Class.Mouse.TargetFilter`，则将忽略目标过滤器及其后代。
- 当鼠标不指向 `Class.BasePart` 时，例如当它指向天空时，目标将为 `nil`。
- 寻找鼠标在 3D 空间中的位置的开发人员应该使用 `Class.Mouse.Hit`。


Mouse.Target

鼠标 `Class.Mouse|mouse` 指向的 3D 空间中的对象。


Mouse.target

此属性确定在计算 `Class.Mouse.Hit` 和 `Class.Mouse.Target` 时要被鼠标忽略的对象。该对象的后代也会被忽略，因此只要它们是设置此属性的对象的后代，就可以忽略多个对象。此属性在过滤包含不应影响 `Class.Mouse.Hit` 或 `Class.Mouse.Target` 的特殊效果或装饰的模型时很有用。

此属性可以设置为任何 `Class.Instance` 或 `nil`，例如：

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

local player = Players.LocalPlayer
local mouse = player:GetMouse()
mouse.TargetFilter = Workspace.Model
```
请注意，`Class.Player.Character|Character` 的 `Class.Players.LocalPlayer` 会被鼠标自动忽略。


Mouse.TargetFilter

确定在确定 `Class.Mouse.Hit` 和 `Class.Mouse.Target` 时要忽略的对象（及其后代）。


这个示例中的代码放置在 `StarterPlayerScripts` 内的 `LocalScript` 中，
将设置任何被点击的 `BasePart` 的表面为随机表面。

此属性指示鼠标指向的 `Class.BasePart` 表面的 `Enum.NormalId`。此属性源于鼠标的世界位置 (`Class.Mouse.Hit`) 和鼠标指向的部分 (`Class.Mouse.Target`)。

当鼠标不指向部分时，此属性没有实际意义，例如当鼠标指向天空时。在这种情况下，此属性目前被设置为 'Right'。在使用此属性之前，请检查鼠标的目标是否为 `nil`。

```lua
local Players = game:GetService("Players")
local player = Players.LocalPlayer
local mouse = player:GetMouse()
-- 检查鼠标指向的位置是否存在部分
if mouse.Target then
	print("鼠标正指向 " .. mouse.TargetSurface.Name .. " 面的 " .. mouse.Target.Name)
else
	print("鼠标没有指向任何东西。")
end
```


Mouse.TargetSurface

指示鼠标指向的 `Class.BasePart` 表面的 `Enum.NormalId`。


UnitRay 属性是一个指向鼠标在 3D 空间中的位置的 `Datatype.Ray`（由 `Class.Mouse.Hit` 描述）。它源于 `Class.Workspace.CurrentCamera` 的 `Class.Camera.CFrame|CFrame`。
与所有单位光线一样，它的距离为 1。

```lua
local Players = game:GetService("Players")
local player = Players.LocalPlayer
local mouse = player:GetMouse()
print(mouse.UnitRay.Direction.Magnitude) -- 始终为 1
```


Mouse.UnitRay

从 `Class.Workspace.CurrentCamera` 世界位置向鼠标的世界位置指向的 `Datatype.Ray`。


这个代码示例演示了如何创建一个 `Datatype.Vector2` 表示
`Mouse` 对象在屏幕上的位置（`Class.Mouse.X|X()` 和
`Class.Mouse.Y|Y()`），以及屏幕本身的大小
（`Class.Mouse.ViewSizeX|ViewSizeX()` 和 `Class.Mouse.ViewSizeY|ViewSizeY()`）。
使用这些，你可以规范化鼠标在屏幕上的位置，使得
顶部左侧刚好在顶部栏下方映射到 (0, 0)，而右下角映射到
(1, 1)。这个规范化位置是通过计算和打印在鼠标移动时获得的，
使用 `Class.Mouse.Move|Move()` 事件。

ViewSizeX 属性描述游戏窗口大小的水平分量（以像素为单位）。


Mouse.ViewSizeX

描述游戏窗口的宽度（以像素为单位）。


ViewSizeY 属性描述游戏窗口大小的垂直分量（以像素为单位）。此长度包括顶部区域占用的空间。


Mouse.ViewSizeY

描述游戏窗口的高度（以像素为单位）。


在检测鼠标在屏幕上的位置变化时，建议使用 `Class.ContextActionService:BindAction()` 与 `Enum.UserInputType.MouseMovement` 或 `Class.UserInputService.InputChanged`，它们均使用鼠标的 `Class.InputObject.Position|Position`（一个 `Datatype.Vector3`）描述鼠标的位置，而不是使用此属性和相关属性。

X 属性描述鼠标在屏幕上的水平分量。该位置是相对于顶部左角（即顶部区域下方）的像素测量的。此属性可以与 `Class.Mouse.Y` 一起使用，以生成表示鼠标位置的 `Datatype.Vector2`：

```lua
local position = Vector2.new(mouse.X, mouse.Y)
```
此属性不会触发 `Class.Object.Changed|Changed` 或返回的信号
`Class.Object:GetPropertyChangedSignal()|GetPropertyChangedSignal`。请使用 `Class.Mouse.Move` 事件。


Mouse.X

描述鼠标在屏幕上的 X（水平）分量。


在检测鼠标在屏幕上的位置变化时，建议使用 `Class.ContextActionService:BindAction()` 与 `Enum.UserInputType.MouseMovement` 或 `Class.UserInputService.InputChanged`，它们均使用鼠标的 `Class.InputObject.Position|Position`（一个 `Datatype.Vector3`）描述鼠标的位置，而不是使用此属性和相关属性。

Y 属性描述鼠标在屏幕上的垂直分量。该位置是相对于顶部左角（即顶部区域下方）的像素测量的。此属性可以与 `Class.Mouse.X` 一起使用，以生成表示鼠标位置的 `Datatype.Vector2`：

```lua
local position = Vector2.new(mouse.X, mouse.Y)
```
此属性不会触发 `Class.Object.Changed|Changed` 或返回的信号
`Class.Object:GetPropertyChangedSignal()|GetPropertyChangedSignal`。请使用 `Class.Mouse.Move` 事件。


Mouse.Y

描述鼠标屏幕位置的 Y（垂直）分量。


遗留对象，包含用于指针输入的有用成员。

`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

要监听其更改的样式属性名称。

Instance

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

/reference/engine/classes/PlayerMouse.yaml