PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience
Collapse Sidebar

PlayerMouse

Show deprecated

PlayerMouse

Show deprecated

The PlayerMouse behaves identically to the Mouse object that is obtained using Tool/Equipped. It can be accessed from LocalScripts using the local player’s Player/GetMouse method.

The only difference between the PlayerMouse and the Mouse object is the PlayerMouse can be obtained using the Player/GetMouse method.

In most cases developers are advised to use the new UserInputService. However the PlayerMouse and Mouse objects remain supported for a number of reasons.

For more information on how to use the mouse object, see the Mouse page.

Properties

Inherited from Mouse: Show Hide

Content

Icon

The content ID of the image used as the `Mouse`'s icon.
Instance

TargetFilter

Determines an object (and its descendants) to be ignored when determining `Mouse/Hit` and `Mouse/Target`
NormalId

TargetSurface

[ReadOnly] [NotReplicated]
Describes the `Enum/NormalId` of the `BasePart` surface at which the mouse is pointing
Ray

UnitRay

[ReadOnly] [NotReplicated]
A `DataType/Ray` directed towards the `Mouse`'s world position, originating from the `Workspace/CurrentCamera|Camera`'s world position
int

ViewSizeY

[ReadOnly] [NotReplicated]
Describes the height of the game window in pixels
int

ViewSizeX

[ReadOnly] [NotReplicated]
Describes the width of the game window in pixels
int

X

[ReadOnly] [NotReplicated]
Describes the X (horizontal) component of the mouse's position on the screen
int

Y

[ReadOnly] [NotReplicated]
Describes the Y (vertical) component of the mouse’s screen position
BasePart

Target

[ReadOnly] [NotReplicated]
The object in 3D space the mouse is pointing to.
CFrame

Origin

[ReadOnly] [NotReplicated]
A `DataType/CFrame` positioned at the `Workspace/CurrentCamera` and oriented toward the `Mouse`'s 3D position.
CFrame

Hit

[ReadOnly] [NotReplicated]
The `DataType/CFrame` of the mouse's position in 3D space.

Inherited from Instance: Show Hide

int

DataCost

[ReadOnly] [NotReplicated]
The cost of saving the instance using data persistence.
Instance

Parent

Determines the hierarchical parent of the `Instance`.
bool

RobloxLocked

If true, the `Instance` and its descendants cannot be indexed or edited by a `Script` or `LocalScript` and will throw an error if it is attempted.
string

ClassName

[ReadOnly] [NotReplicated]
A read-only string representing the class this `Instance` belongs to.
string

Name

A non-unique identifier of the `Instance`.
bool

Archivable

Determines if an `Instance` can be cloned using `/Instance/Clone` or saved to file.

Functions

Inherited from Instance: Show Hide

RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.
Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the `Instance` for whom `Instance/IsA` returns true for the given className.
Array

GetDescendants ( )

[CustomLuaState]
Returns an array containing all of the `Instance`'s descendants.
bool

IsAncestorOf ( Instance descendant )

Returns true if an `Instance` is an ancestor of the given descendant.
bool

IsDescendantOf ( Instance ancestor )

Returns true if an `Instance` is a descendant of the given ancestor.
Instance

FindFirstChildOfClass ( string className )

Returns the first child of the `Instance` whose `Instance/ClassName|ClassName` is equal to the given className.
Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the `Instance` found with the given name.
Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the `Instance` for whom `Instance/IsA` returns true for the given className.
Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the `Instance` whose `Instance/ClassName` is equal to the given className.
Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the `Instance` whose `Instance/Name` is equal to the given name.
bool

IsA ( string className )

Returns true if an `Instance`'s class matches or inherits from a given class
Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]
Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.
string

GetFullName ( )

Returns a string showing the `Instance`'s ancestry.
string

GetDebugId ( int scopeLength )

[NotBrowsable]
Returns a coded string of the `Instance`s DebugId used internally by Roblox.
Objects

GetChildren ( )

Returns an array containing all of the `Instance`'s children.
void

Destroy ( )

Sets the `Instance/Parent` property to nil, locks the `Instance/Parent` property, disconnects all connections and calls Destroy on all children.
Instance

Clone ( )

Create a deep copy of a Roblox instance and descendants where `Archivable = true`.
void

ClearAllChildren ( )

This function destroys all of an `Instance`'s children.

Events

Inherited from Mouse: Show Hide

RBXScriptSignal

Button1Down ( )

Fired when the left mouse button is pressed.
RBXScriptSignal

Button2Down ( )

Fires when the right mouse button is pressed.
RBXScriptSignal

WheelForward ( )

Fires when the mouse wheel is scrolled forwards.
RBXScriptSignal

WheelBackward ( )

Fires when the mouse wheel is scrolled backwards.
RBXScriptSignal

Move ( )

Fired when the mouse is moved.
RBXScriptSignal

Idle ( )

Fired during every heartbeat that the mouse isn't being passed to another mouse event.
RBXScriptSignal

Button2Up ( )

Fired when the right mouse button is released.
RBXScriptSignal

Button1Up ( )

Fires when the left mouse button is released.

Inherited from Instance: Show Hide

RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the `Instance` is removed.
RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the `Instance/Parent` property of the object or one of its ancestors is changed.
RBXScriptSignal

ChildAdded ( Instance child )

Fires when an object is parented to this `Instance`.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this `Instance`.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the `Instance`.
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.