Class
PlayerMouse
NotCreatable
The PlayerMouse behaves identically to the Mouse object that is
obtained using Tool.Equipped. Both PlayerMouse and Mouse are
legacy APIs, superseded by UserInputService.
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. Both PlayerMouse and Mouse are
legacy APIs, superseded by UserInputService.
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. See Input and Camera for more information
on customizing inputs in your experience.
Inherited members#
Inherited from Mouse 25
Properties (14)
Hit, hit, Icon, IconContent, Origin, Target, target, TargetFilter, TargetSurface, UnitRay, ViewSizeX, ViewSizeY, X, Y
Events (11)
Button1Down, Button1Up, Button2Down, Button2Up, Idle, KeyDown, keyDown, KeyUp, Move, WheelBackward, WheelForward
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild