PcoWSkbVqDnWTu_dm2ix
Collapse Sidebar

Mouse

Show deprecated

Mouse

Show deprecated

Mouse has been superseded by UserInputService and ContextActionService, which cover a broader scope, are more feature rich, and support cross-platform patterns better. It remains supported because of its widespread use, but you should strongly consider using these alternatives.

The Mouse object is a legacy object that houses API for pointer input, mainly for button input and raycasting. It is most notable for the Mouse/Icon|Icon property, which can change the cursor’s appearance. This object can be accessed through Player/GetMouse, usually called on the Players/LocalPlayer in a LocalScript. It is also passed in the Tool/Equipped event, and the PluginMouse object can be accessed using Plugin/GetMouse.

-- From a LocalScript:
local Players = game:GetService("Players")
local player = Players.LocalPlayer
local mouse = Player:GetMouse()
-- Setting the mouse's icon
mouse.Icon = "rbxasset://SystemCursors/Wait"
  • This object can’t control/restrict cursor movement. For this, see UserInputService/MouseBehavior and UserInputService/MouseDeltaSensitivity.
  • If two functions are connected to one of its input events, such as Mouse/Button1Down|Button1Down, both connected functions always run when the event fires. There is no concept of sinking/passing input, as events don’t support this behavior. However, ContexActionService does have this behavior through ContextActionService/BindAction|BindAction.

Properties

CFrame

Hit

[ReadOnly] [NotReplicated]

The DataType/CFrame of the mouse’s position in 3D space

Content

Icon

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

CFrame

Origin

[ReadOnly] [NotReplicated]

A DataType/CFrame positioned at the Workspace/CurrentCamera and oriented toward the Mouse's 3D position.

BasePart

Target

[ReadOnly] [NotReplicated]

The object in 3D space the Mouse|mouse is pointing to

Instance

TargetFilter

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

NormalId

TargetSurface

[ReadOnly] [NotReplicated]

Indicates 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

ViewSizeX

[ReadOnly] [NotReplicated]

Describes the width of the game window in pixels

int

ViewSizeY

[ReadOnly] [NotReplicated]

Describes the height 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

CFrame

hit

[Hidden] [ReadOnly] [NotReplicated] [Deprecated]
BasePart

target

[ReadOnly] [NotReplicated] [Deprecated]

Inherited from Instance: Show Hide

bool

Archivable

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

string

ClassName

[ReadOnly] [NotReplicated]

A read-only string representing the class this Instance belongs to

int

DataCost

[ReadOnly] [NotReplicated] [Deprecated]

The cost of saving the instance using data persistence.

string

Name

A non-unique identifier of the Instance

Instance

Parent

Determines the hierarchical parent of the Instance

bool

RobloxLocked

[Deprecated]

A deprecated property that used to protect CoreGui objects

bool

archivable

[Hidden] [NotReplicated] [Deprecated]
string

className

[ReadOnly] [NotReplicated] [Deprecated]

Functions

Inherited from Instance: Show Hide

void

ClearAllChildren ( )

This function destroys all of an Instance's children.

Instance

Clone ( )

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

void

Destroy ( )

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

Instance

FindFirstAncestor ( string name )

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

Instance

FindFirstAncestorOfClass ( string className )

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

Instance

FindFirstAncestorWhichIsA ( string className )

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

Instance

FindFirstChild ( string name , bool recursive )

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

Instance

FindFirstChildOfClass ( string className )

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

Instance

FindFirstChildWhichIsA ( string className , bool recursive )

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

Variant

GetAttribute ( string attribute )

RBXScriptSignal

GetAttributeChangedSignal ( string attribute )

Dictionary

GetAttributes ( )

Objects

GetChildren ( )

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

string

GetDebugId ( int scopeLength )

[NotBrowsable]

Returns a coded string of the Instances DebugId used internally by Roblox.

Array

GetDescendants ( )

[CustomLuaState]

Returns an array containing all of the descendants of the instance

string

GetFullName ( )

Returns a string describing the Instance's ancestry.

RBXScriptSignal

GetPropertyChangedSignal ( string property )

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

bool

IsA ( string className )

[CustomLuaState]

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

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.

void

Remove ( )

[Deprecated]

Sets the object’s Parent to nil, and does the same for all its descendants.

void

SetAttribute ( string attribute , Variant value )

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.

Objects

children ( )

[Deprecated]

Returns an array of the object’s children.

Instance

clone ( )

[Deprecated]
void

destroy ( )

[Deprecated]
Instance

findFirstChild ( string name , bool recursive )

[Deprecated]
Objects

getChildren ( )

[Deprecated]
bool

isA ( string className )

[Deprecated] [CustomLuaState]
bool

isDescendantOf ( Instance ancestor )

[Deprecated]
void

remove ( )

[Deprecated]

Events

RBXScriptSignal

Button1Down ( )

Fired when the left mouse button is pressed.

RBXScriptSignal

Button1Up ( )

Fires when the left mouse button is released.

RBXScriptSignal

Button2Down ( )

Fires when the right mouse button is pressed.

RBXScriptSignal

Button2Up ( )

Fired when the right mouse button is released

RBXScriptSignal

Idle ( )

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

RBXScriptSignal

KeyDown ( string key )

[Deprecated]

Fires when a Key is pressed

RBXScriptSignal

KeyUp ( string key )

[Deprecated]

Fires when a Key is released

RBXScriptSignal

Move ( )

Fired when the mouse is moved.

RBXScriptSignal

WheelBackward ( )

Fires when the mouse wheel is scrolled backwards

RBXScriptSignal

WheelForward ( )

Fires when the mouse wheel is scrolled forwards.

RBXScriptSignal

keyDown ( string key )

[Deprecated]

Inherited from Instance: Show Hide

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

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

RBXScriptSignal

AttributeChanged ( string attribute )

RBXScriptSignal

Changed ( string property )

[DetectingPropertyChanges]

Fired immediately after a property of an object changes.

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

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the Instance is removed.

RBXScriptSignal

childAdded ( Instance child )

[Deprecated]