This code sample includes a simple example of how the local player's
`PlayerMouse` can be retrieved using the `Class.Player:GetMouse()` function in
a `LocalScript`. This code should be placed in a `LocalScript` in
`StarterPlayerScripts`.


PlayerMouse

The following code sample, when placed in `StarterPlayerScripts` will create a
tool in the player's backpack that, once equipped, will change the
`Class.BasePart.BrickColor` of every `BasePart` the player clicks on.


Mouse.Button1Down

The follow example changes the `Class.BasePart.BrickColor` of every `BasePart`
the player clicks and releases their mouse on.

In order for a part to change color, the player's mouse must be over the part
both when the player presses their left mouse button down and when the player
releases their left mouse button.


Mouse.Button1Up

Mouse.Button2Down

The follow example changes the `Class.BasePart.BrickColor` of every `BasePart`
the player clicks and releases their right mouse button on.

In order for a part to change color, the player's mouse must be over the part
both when the player presses their right mouse button down and when the player
releases their right mouse button.


Mouse.Button2Up

This example demonstrates how mouse events are passed during each frame


Mouse.Idle

The below example, assuming that 'mouse' was defined, would print the key that
was pressed (e.g. "q") along with the ascii value for that key (e.g. 113).


Mouse.KeyDown

The below example, assuming that 'mouse' was defined, would print the key that
was released (e.g. "q") along with the ascii value for that key (e.g. 113).


Mouse.KeyUp

The example below allows the `Class.Players.LocalPlayer|local player` to move
parts with their mouse.

When the player presses their left mouse button over a part, that part is the
`Class.Mouse.Target|mouse's target` and becomes the _point_. Until the player
releases their left mouse button, that part will move to the mouse's world
position when the player moves their mouse.

Note that the `Class.Mouse.TargetFilter` property allows the code to ignore
the part being moved when determining the mouse's world position.

The code should work as expected when placed in a `LocalScript`.


Mouse.Move

The below example assumes that you have already got the player's mouse (and
set it as a variable named 'mouse'), whether by use of a `Class.Tool`,
`Class.HopperBin` or the `Class.Player:GetMouse()` method. It will print
"Wheel went backwards!" when the player scrolls backwards.


Mouse.WheelBackward

The below example assumes that you have already got the player's mouse (and
set it as a variable named 'mouse'), whether by use of a `Tool`, `HopperBin`
or the `Class.Player:GetMouse()` method. It will print "Wheel went forward!"
when the player scrolls forwards.


Mouse.WheelForward

Mouse.keyDown

Mouse

The code in this sample, when placed inside a `LocalScript` within
`StarterPlayerScripts` will draw a red laser beam between the character's head
and `Class.Mouse.Hit` at all times.

Note, this beam will pass directly through obstructions in third person as the
`Mouse`'s raycasting is done from the `Class.Workspace.CurrentCamera` not the
head.


The code below visualizes the difference between `Class.Mouse.Hit` and
`Class.Mouse.Origin`. In order to do this, the code uses the
`Datatype.Vector3` positions of the hit and origin `Datatype.CFrame` values
using `.p`.

The difference is that the origin is "where the mouse came from" (its origin)
and the hit is the position where the mouse hits (is when the player presses
their mouse).

This example also visualizes that the mouse origin is very similar to the
position of the `CurrentCamera` by printing the magnitude (distance) between
the two positions.


Mouse.Hit

This example changes the `Class.Players.LocalPlayer` mouse icon to look like
a dragon image.


Mouse.Icon

Mouse.Origin

Mouse.Target

Mouse.TargetFilter

The code in this sample, when placed in a `LocalScript` inside
`StarterPlayerScripts` will set the surface of any `BasePart` clicked on to a
random surface.


Mouse.TargetSurface

Mouse.UnitRay

This code sample shows how you can create a `Datatype.Vector2` representing
the `Mouse` object's position on screen (`Class.Mouse.X|X()` and
`Class.Mouse.Y|Y()`) and the size of the screen itself
(`Class.Mouse.ViewSizeX|ViewSizeX()` and `Class.Mouse.ViewSizeY|ViewSizeY()`).
Using these, you can normalize the position of the mouse on-screen such that
the top-left just under the topbar maps to (0, 0) and the bottom-right maps to
(1, 1). This normalized position is calculated and printed as the mouse moves
using the `Class.Mouse.Move|Move()` event.


Mouse.ViewSizeX

Mouse.ViewSizeY

Mouse.X

Mouse.Y

Mouse.hit

Mouse.target

Demonstrates detecting changes to an instance's ancestry by connecting to the `Class.Instance.AncestryChanged` event.

The ChangingPart's Parent is set to different values overtime. The parent of the part is the part's ancestor, so the `Class.Instance.AncestryChanged` event will fire whenever it changes.


Instance.AncestryChanged

child

parent

Instance.AttributeChanged

attribute

This snippet prints the names of objects as they are added to the Workspace:


Instance.ChildAdded

This snippet prints the names of objects as they are removed from the
Workspace:


Instance.ChildRemoved

This following example will print the name of any object that is added to the
Workspace:


Instance.DescendantAdded

descendant

The following example prints the name of any descendant as it is being removed
from the Workspace:


Instance.DescendantRemoving

This sample demonstrates how, when using Immediate signal behavior, an Instance being destroyed remains in place until the connected function yields.


This sample demonstrates how, when using Deferred signal behavior,
an Instance is destroyed before the signal fires.


Instance.Destroying

Instance.childAdded

Instance:AddTag

This example creates a Part and adds a few sparkle objects to the part. Then
it calls Part:ClearAllChildren() to remove all of the children.


Instance:ClearAllChildren

Demonstrates cloning a model using `Class.Instance:Clone()`.

Instance:Clone

Demonstrates destroying a Part using the `Class.Instance:Destroy()` function.

This function is the correct way to dispose of objects that are no longer required.


Instance:Destroy

Instance:FindFirstAncestor

name

Instance:FindFirstAncestorOfClass

className

Instance:FindFirstAncestorWhichIsA

The below would look in Workspace for an object name "Brick". If found, it
will change the name of the object to "Foo".


Instance:FindFirstChild

recursive

Instance:FindFirstChildOfClass

Instance:FindFirstChildWhichIsA

Instance:FindFirstDescendant

Instance:GetActor

Instance:GetAttribute

Instance:GetAttributeChangedSignal

Instance:GetAttributes

The below would print the name of all objects currently in Workspace when ran.


Instance:GetChildren

Instance:GetDebugId

scopeLength

GetDescendants is often used to do something to all the descendants that are a
particular type of object. The code in this example uses GetDescendants and
`Class.Instance:IsA()` to find all of the parts in the workspace and turns
them green.


Instance:GetDescendants

This code sample demonstrates the behavior of `Class.Instance:GetFullName()`.
It shows how the function behaves when called on an object not in the
`DataModel` hierarchy, and it also shows how the return value does not escape
special characters.


This code sample re-implements the `Class.Instance:GetFullName()` function in
Lua.


Instance:GetFullName

Instance:GetStyled

Instance:GetTags

Instance:HasTag

Demonstrates determining if one instance is the ancestor of another using `Class.Instance:IsAncestorOf()`

Workspace and SpawnLocation are ancestors of the SpawnLocation's decal.
Workspace is an ancestor of SpawnLocation.

SpawnLocation and its decal are descendants of Workspace, not ancenstors.
Decal is a descendant to SpawnLocation, not an ancestor.


Instance:IsAncestorOf

Instance:IsDescendantOf

ancestor

The following code demonstrates how a part can be re-added to the DataModel
after being removed:


Instance:Remove

Instance:RemoveTag

Instance:SetAttribute

value

The following code waits for an instance named "Part" to be added to
Workspace.


Instance:WaitForChild

childName

timeOut

Instance:children

Instance:clone

Instance:destroy

Instance:findFirstChild

Instance:getChildren

Instance:isDescendantOf

Instance:remove

Instance

Instance.Archivable

Instance.Capabilities

Instance.Name

Instance.Parent

Instance.RobloxLocked

Instance.Sandboxed

Instance.UniqueId

Instance.archivable

This sample demonstrates the subtleties of the Changed event on normal objects
and "-Value" objects.


This code sample demonstrates the Changed event firing within a parent object.


Object.Changed

property

This code sample demonstrates how to save a value before a changed event fires
on it in order to get more information about a change.


This code sample demonstrates the equivalence of the `Changed` event and event
returned by `GetPropertyChangedSignal`.


Object:GetPropertyChangedSignal

Demonstrates determining the class of Workspace using `Class.Instance:IsA()`

Workspace is of class 'Workspace', so the first statement is true.
Workspace is not of class 'BasePart', so the second statement is false.
Workspace inherits from Instance and therefore is of class 'Instance', so the third statement is true.


Object:IsA

Object:isA

Object

Object.ClassName

Object.className

/reference/engine/classes/PlayerMouse.yaml

玩家滑鼠與 `Class.Mouse` 對象相同，其中 `Class.Tool.Equipped` 是使用 `Class.Mouse` 獲得。 玩家滑鼠和 2> Class.Mouse2> 都是擁有過時的 API，由 5> Class.UserInputService5> 取代。

Class.Actor 是一個可以安全分離在自己的子線程中的代碼。

Class

Actor

Luau

Array

物理互動的世界對象的抽象基地類。

BasePart

代表 3D 位置和方向的資料類型。

Data Type

CFrame

Dictionary

NormalId 列表將會設定哪個方向/面的零件使用。

Enum

Enum.NormalId

連接到特定發生時執行的對象。

RBXScriptSignal

代表一個始點，在特定方向上無限拋射。

Variant

bool

number

字母、數字和符號等的一系列字符。

string

void

概覽

指南

教學

參考

資源

美術

設計

引擎

虛擬人偶

舊版本

雲端

This method is asynchronous and returns an `Operation`, which represents the current state of the operation. It contains an endpoint path that you can poll to obtain the real response and applicable metadata. See the [documentation]({longRunningOperationsLink}) on long-running operations for more information.
            
The following sections describe the response and metadata objects that are provided when an operation completes.

Beta 測試終點已準備好公開使用。可能出現導致功能無法正常運作的變更，但機率不高。

建立資源時可設定此欄位，但可能無法在後續請求中修改。

此欄位可在請求中提供，但永遠不會包含在回應中。

每個 API 金鑰：每個 IP 位址每 {periodInSeconds} 秒 {maxInPeriod} 個請求

此欄位可在回應中設定，但將在請求中被忽略。

調用此端點需要以下 API 金鑰權限。有關
產生正確金鑰的更多資訊，請查看 [管理 API 金鑰]（{apiKeyReferenceDocLink}）。

根據相對基本網址的路徑，可使用下列終點。

此字串的格式為 [FieldMask](/cloud/reference/types#fieldmask)。

JSON 值可為「null」、「boolean」、「string」、「number」、「array」或「object」。

若想使用此端點，您的 OAuth 2.0 應用程式需要以下範圍。有關如何註冊 OAuth 2.0 應用程式的更多資訊，請查看 [應用程式註冊和審查]（{oauth2ReferenceDocLink}）。

以下物件描述被接受或退回的負載。若要獲得更多關於物件使用時機的資訊，請查看個別終點。

此字串的格式為 [Timestamp](/cloud/reference/types#timestamp)。

這可以查看有關您資產的資訊。

這可以上傳和更新 Roblox 的資產。

授予更新使用者所擁有之徽章的能力。

這會允許查看您商品的相關資訊。

這會允許對您的商務商家連結進行編輯。

這能讓您檢視您創作者商店商品的相關資訊。

這能讓您修改您創作者商店商品的相關資訊。

這能讓您管理您帳號的群組加入申請。

這可以查看有關您道具欄的資訊。

Grants access to mange your badges and spend robux.

授予管理您開發者產品的權限。

授予讀取您所追蹤體驗之相關資訊的權限。

授予代您追蹤體驗和取消追蹤的權限。

授予讀取與寫入您在地化表格的權限。

授予管理您擁有之所有體驗的團隊協作權限。

授予管理您的體驗及部分體驗相關資訊（例如：在地化資訊）的權限。

授予讀取您體驗之在地化資訊的權限。

授予修改您體驗在地化偏好的權限。

授予管理您使用者帳號的權限。

授予修改使用者在地化偏好的權限。

給予代替使用者發布訊息的能力。

這能讓您的體驗向使用者傳送通知。

此將允許列出與您的體驗相關的機密資料。

此將允許建立並更新與您的體驗相關的機密資料。

授予讀取您訂閱產品相關資訊的權限。

此操作將會允許發布新版本的體驗到 Roblox。

讓您檢視體驗中的使用者限制。

讓您在體驗中編輯使用者限制。

授予讀取使用者高級會員狀態與驗證狀態的能力。

這能讓您檢視使用者的社群帳號。

這將授予讀取您個人檔案資訊的權限。

PlayerMouse

範例程式碼

概要

屬性

方法

活動

屬性

方法

活動