此代碼範例包含了一個簡單的示例，展示如何在 `LocalScript` 中使用 `Class.Player:GetMouse()` 函數來獲取本地玩家的
`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.Player:GetMouse()` 在 `Class.Players.LocalPlayer` 的 `Class.LocalScript` 中訪問。它也被通過 `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` 具有此行為。
- 雖然在所有平台上可能無法使用滑鼠，但滑鼠仍會在行動裝置（觸控）和遊戲主機（遊戲手柄）上正常運作，這些設備通常不具備滑鼠或指標硬體。要實現明確的跨平台行為，請使用 `Class.UserInputService` 和 `Class.ContextActionService`。

  有關自定義輸入的更多信息，請參見 [輸入與攝影機](/input)。

當玩家按下滑鼠的左鍵時觸發此事件。請注意此事件可以在 `Class.Tool` 中訪問；例如，當放置在 `Class.LocalScript` 中時，下面的代碼會在每次按下左鍵時打印 `Button1Down`。

```lua
local tool = script.Parent  -- 確保這是工具對象

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.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.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.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

這段範例代碼，當放置在 `LocalScript` 中的 `StarterPlayerScripts` 內時，將會在角色的頭部與 `Class.Mouse.Hit` 之間繪製一條紅色雷射束。

請注意，這條束會直接穿過第三人稱的障礙物，因為 `Mouse` 的射線投射是從 `Class.Workspace.CurrentCamera` 而不是頭部進行的。


以下代碼可視化 `Class.Mouse.Hit` 和 `Class.Mouse.Origin` 之間的差異。
為了做到這一點，代碼使用了擊中和原點的 `Datatype.Vector3` 位置，
使用 `.p`。

差異在於，原點是「滑鼠來自的地方」（它的原點），而擊中是滑鼠擊中的位置（即玩家按下滑鼠時的位置）。

這個例子還可視化了滑鼠原點與 `CurrentCamera` 的位置非常相似，
通過打印兩個位置之間的大小（距離）。


此屬性指示滑鼠在 3D 空間中的位置的 `Datatype.CFrame`。請注意 `Class.Mouse.TargetFilter` 及其子類別將被忽略。

開發者可以這樣獲取 Hit 的位置：

```
local position = mouse.Hit.Position
```
Hit 通常被 `Class.Tool|Tools` 用於將武器朝著滑鼠發射，以便從第三人稱視角來看。

開發者尋找滑鼠在 3D 空間中指向的 `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 點。如果滑鼠未指向 3D 空間中的物體（例如，當指向天空時），則此屬性的距離將是距離 `Class.Workspace.CurrentCamera` 1,000 點。

Mouse.Hit

滑鼠在 3D 空間中的位置的 `Datatype.CFrame`。

Mouse.hit

這個範例將 `Class.Players.LocalPlayer` 的鼠標圖示更改為龍的圖像。


**圖示** 是決定用作指針的圖像的屬性。如果為空，則使用默認箭頭。當游標懸停在 `Class.GuiButton` 上時，會暫時忽略此屬性。

要完全隱藏游標，**不**要使用透明圖像 &ndash; 而是將 `Class.UserInputService.MouseIconEnabled` 設置為 false。

要在經驗中獲取/設置用戶鼠標圖示，應使用 `Class.UserInputService.MouseIcon`。 `Class.Mouse.Icon` 將在新 API 發佈後被棄用，該 API 允許插件設置鼠標光標。

##### 設計游標

以下準則在創建自己的鼠標游標時可能會有所幫助：

- 使用的圖像的尺寸決定游標的大小。
- 圖像的尺寸在任何軸上均不應超過 256 像素。
- 圖像的 **中心** 是鼠標輸入發出的地方。
- 默認的鼠標圖像為 64x64 像素，鼠標佔用 17x24 像素的空間。

##### 系統游標

當使用從 `Class.Plugin:GetMouse()` 獲取的 `Class.PluginMouse` 時，可以使用以下圖標，這些圖標類似於系統的默認游標，如手、箭頭、I 形光標等。您可以在 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 發佈後被棄用，該 API 允許插件設置鼠標光標。

##### 設計游標

以下準則在創建自己的鼠標游標時可能會有所幫助：

- 使用的圖像的尺寸決定游標的大小。
- 圖像的尺寸在任何軸上均不應超過 256 像素。
- 圖像的 **中心** 是鼠標輸入發出的地方。
- 默認的鼠標圖像為 64x64 像素，鼠標佔用 17x24 像素的空間。

##### 系統游標

當使用從 `Class.Plugin:GetMouse()` 獲取的 `Class.PluginMouse` 時，可以使用以下圖標，這些圖標類似於系統的默認游標，如手、箭頭、I 形光標等。您可以在 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` 從與原始位置相同的位置開始，並沿相同方向延伸一個 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

一個 `Datatype.CFrame`，位於 `Class.Workspace.CurrentCamera` 並面向鼠標的 3D 位置。

當放置在 `StarterPlayerScripts` 中的 `LocalScript` 時，以下代碼
會改變玩家點擊的每個 `BasePart` 的 `Class.BasePart.BrickColor`，
例如生成位置或基板。


位於鼠標所指向的 3D 空間中的對象。

注意：

- 如果已設置 `Class.Mouse.TargetFilter`，則會忽略目標過濾和其子項。
- 當鼠標不指向 `Class.BasePart` 時，例如當它指向天空時，目標將為 `nil`。
- 開發者尋找鼠標在 3D 空間中的位置應使用 `Class.Mouse.Hit`。

Mouse.Target

位於鼠標所指向的 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` 時要忽略的對象（及其子項）。

這段範例代碼，當放置在 `LocalScript` 中的 `StarterPlayerScripts` 內部時，將會把任何被點擊的 `BasePart` 的表面設置為隨機表面。


此屬性表示滑鼠指向的 `Class.BasePart` 表面的 `Enum.NormalId`。
此屬性是從滑鼠的世界位置 (`Class.Mouse.Hit`) 和滑鼠指向的部分 (`Class.Mouse.Target`) 派生而來。

當滑鼠不指向任何部分時，此屬性沒有意義，例如當滑鼠指向天空時。在這種情況下，此屬性會被設置為 'Right'。在使用此屬性之前，請檢查滑鼠的目標是否為 `nil`。


Mouse.TargetSurface

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

UnitRay 屬性是一個指向滑鼠在 3D 空間中位置的 `Datatype.Ray`（由 `Class.Mouse.Hit` 描述）。它起源於 `Class.Workspace.CurrentCamera` 的 `Class.Camera.CFrame|CFrame`。
像所有單位射線一樣，它的距離為 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 的 Parent 隨著時間設置為不同的值。部分的父項是該部分的祖先，因此每當發生變化時，`Class.Instance.AncestryChanged` 事件將被觸發。

當此實例被重新設置父項或其任何祖先被重新設置父項時觸發。

您可以使用此事件來跟踪 Studio 中實例的刪除，
例如在 Explorer 中手動刪除或通過插件刪除。如果您需要
檢測使用 `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` 後觸發。


以下範例在任何後代被移除時打印其名稱

從 Workspace 中：

此事件在父項 `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.BasePart|BaseParts` 從 `Class.Model` 中降下來的物件：

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

local model = Workspace:FindFirstChild("TestModel")

for _, descendant in model:GetDescendants() do
	if descendant:IsA("BasePart") then
		descendant:Destroy()
	end
end
```


Instance:ClearAllChildren

此方法銷毀實例的所有子物件。


演示如何使用 `Class.Instance:Clone()` 克隆模型。


`Clone()` 創建實例及其所有後代的副本，
忽略所有不為 `Class.Instance.Archivable|Archivable` 的實例。根實例的副本由此方法返回，
其 `Class.Instance.Parent|Parent` 設置為 `nil`。請注意，如果實例本身的 `Class.Instance.Archivable|Archivable` 設置為 `false`，
則此方法將返回 `nil`。

如果在克隆的實例中設置了引用屬性，例如 `Class.ObjectValue.Value`，則副本的屬性值取決於原始值：

- 如果引用屬性指向的實例 **也** 被克隆，則副本將指向該副本。
- 如果引用屬性指向的實例 **未** 被克隆，則副本將保持相同的值。


Instance:Clone

實例的副本，或如果實例不為 `Class.Instance.Archivable|Archivable` 則為 `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.Object.ClassName`。


返回 `Class.Instance` 的第一個祖先，該祖先的 `Class.Object.ClassName` 等於給定的 className。


返回 `Class.Instance` 的第一個祖先，該祖先的 `Class.Object:IsA()` 對給定的 className 返回 true。

此方法向上工作，意味著它從實例的直接 `Class.Instance.Parent` 開始，
並向上工作到 `Class.DataModel`。如果未找到匹配的祖先，則返回 `nil`。

與 `Class.Instance:FindFirstAncestorOfClass()` 不同，此方法使用 `Class.Object:IsA()`，
它尊重類別繼承。例如：

```
print(part:IsA("Part"))  --> true
print(part:IsA("BasePart"))  --> true
print(part:IsA("Instance"))  --> true
```
因此，以下代碼示例將返回第一個 `Class.BasePart` 祖先，無論它是 `Class.WedgePart`、
`Class.MeshPart` 還是 `Class.Part`。

```
local part = object:FindFirstAncestorWhichIsA("BasePart")
```
另請參見 `Class.Instance: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` 的屬性相同。
使用點運算符時，如果它們共享名稱，屬性將優先於子物件。

在以下示例中，將一個名為 `Color` 的 `Class.Folder` 添加到 `Class.Part`，
該 `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("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` 階層中的物件上調用該函數時的行為，
並且還顯示了返回值如何不轉義特殊字符。

這段程式碼範例重新實作了 `Class.Instance:GetFullName()` 函數於
Lua。


返回描述實例祖先的字符串。該字符串是物件的 `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

您在實例上針對的虛擬實例的可選選擇器。


指定屬性的樣式或明確修改的值，
如果未樣式/修改則返回默認屬性值。


返回指定屬性的樣式或明確修改的值，
如果未樣式/修改則返回默認屬性值。


Instance

`Instance` 是 Roblox 類別層級中所有類別的基礎類別
可以成為 `Class.DataModel` 樹的一部分。


/reference/engine/classes/PlayerMouse.yaml

概要