PlayerMouse
Show Deprecated
Not Creatable
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.
Code Samples
PlayerMouse
local Players = game:GetService("Players")
local player = Players.LocalPlayer
local mouse = player:GetMouse()
local function onMouseMove()
print("mouse screen position: ", mouse.X, mouse.Y)
end
mouse.Move:Connect(onMouseMove)
Summary
Properties
Properties inherited from Mouse
Properties inherited from Instance
Methods
Methods inherited from Instance
Events
Events inherited from Mouse
Events inherited from Instance
Properties
Properties inherited from Mouse
Properties inherited from Instance
Methods
Methods inherited from Instance
Events
Events inherited from Mouse
Events inherited from Instance