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

Mouse

Show deprecated

Mouse

Show deprecated

The Mouse object is the code interface for the computer mouse.

How to get the Mouse?

A Mouse object is not createable, but can be obtained using the Player/GetMouse, Tool/Equipped. The PluginMouse object, which inherits from Mouse can be created using the Plugin Plugin/GetMouse function.

local Players = game:GetService("Players")
local localPlayer = Players.LocalPlayer -- from a LocalScript
local mouse = Player:GetMouse()
Tool.Equipped:Connect(function(mouse)
	-- got mouse
end)

Mouse alternatives

There is a degree of overlap between the functionality offered by ContextActionService, UserInputService and the Mouse object.

Mouse, by and large, has been superseded by UserInputService which offers wider additional functionality for interacting with the mouse as well as other input types. For example:

  • UserInputService supports other inputs such as key presses and mobile inputs whereas Mouse does not
  • UserInputService includes additional mouse features such as UserInputService/MouseBehavior and UserInputService/MouseDeltaSensitivity

In most cases developers are advised to use the new UserInputService. However the Mouse object remains supported for a number of reasons.

  • Mouse existed long before UserInputService and a large number of places and gear items are dependent on it
  • The PluginMouse object is still used by plugins accessing the mouse
  • The mouse object is embedded into Tools and is easier to pick up for new developers

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

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

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

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

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

FindFirstChild ( string name , bool recursive )

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

RBXScriptSignal

GetPropertyChangedSignal ( string property )

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

string

GetFullName ( )

Returns a string describing the Instance's ancestry.

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

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

GetDebugId ( int scopeLength )

[NotBrowsable]

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

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

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

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.

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.