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

The PlayerMouse behaves identically to the `Class.Mouse` object that is
obtained using `Class.Tool.Equipped`. Both PlayerMouse and `Class.Mouse` are
legacy APIs, superseded by `Class.UserInputService`.


An `Class.Actor` is a container for code that can be safely split into its own thread.

Class

Actor

Luau

Array

The abstract base class for in-world objects that physically interact.

BasePart

A data type that represents both a 3D position and orientation.

Data Type

CFrame

Dictionary

The NormalId Enum sets which side/face of a Part is used.

Enum

Enum.NormalId

An object that runs connected functions upon a specific occurrence.

RBXScriptSignal

Represents a line with a starting point that casts infinitely in a specific direction.

Variant

Data type having a value of either true or false.

bool

A double-precision floating-point number.

number

A sequence of characters, such as letters, numbers, and symbols.

string

void

Overview

Guides

Tutorials

Reference

Resources

Design

Engine

Avatar

Legacy

Cloud

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 endpoints are ready for public use. Breaking changes are possible but rare.

This field may be set when creating a resource, but may not be modified by subsequent requests.

This field may be provided in requests, but will never be included in responses.

Per API Key: {maxInPeriod} requests every {periodInSeconds} seconds per IP Address

This field may be set on responses, but will be ignored in requests.

The following API key permissions are required to call this endpoint. For more
information on generating proper keys, see [Managing API Keys]({apiKeyReferenceDocLink}).

The following endpoints are available at paths relative to the base URL.

This string is formatted as a [FieldMask](/cloud/reference/types#fieldmask).

A JSON value can be `null`, `boolean`, `string`, `number`, `array`, or `object`.

The following scopes are required for your OAuth 2.0 application to use this endpoint. For more information on how to register an OAuth 2.0 application, see [App Registration and Review]({oauth2ReferenceDocLink}).

The following objects describe payloads that are accepted or returned. See each individual endpoint for more information on when these objects are used.

This string is formatted as a [Timestamp](/cloud/reference/types#timestamp).

This allows viewing information about your assets.

This allows uploading and updating assets to Roblox.

Grants the ability to update badges owned by the user.

This allows viewing information about your commerce items.

This allows editing of your commerce merchant connections.

This allows you to view information about your Creator Store products.

This allows you to modify information about your Creator Store products.

This allows viewing information about your groups.

This allows you to manage group join requests for your account.

This allows viewing information about your inventory.

Grants access to mange your badges and spend robux.

Grants access to manage your developer products.

Grants access to read information about the experiences you follow.

Grants access to follow and unfollow experiences on your behalf.

Grants permission to read group information.

Grants access to read and write your localization tables

Grants access to manage team collaboration for all experiences you own.

Grants access to manage your experiences and certain information associated with your experiences (e.g. localization information).

Grants access to read your experiences' localization information.

Grants access to modify your experiences' localization preferences.

Grants access to manage your user account.

Grants access to modify user localization preferences.

This grants the ability to publish messages on behalf of users.

This allows sending notifications from your experience to users.

This allows listing secrets associated with your experience.

This allows creating and updating secrets associated with your experience.

Grants access to read about your subscription products.

Grants the ability to read place information.

Grants the ability to edit place information.

This operation grants access to publish new versions of experiences to Roblox.

Grants the ability to read experience information.

Grants the ability to edit experience information.

Allows you to view user restrictions in the experience.

Allows you to edit user restrictions in the experience.

Grants the ability to read user's premium and verified status.

This allows you to view a user's social accounts.

This enables Single Sign-On functionality.

This grants access to read your profile information.

PlayerMouse

Code Samples

Summary

Properties

Methods

Events

Properties

Methods

Events