PlayerMouse¶
The PlayerMouse behaves identically to the Mouse object that is obtained using Tool.Equipped. Both PlayerMouse and Mouse are legacy APIs, superseded by UserInputService.
Description¶
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.
Inheritance¶
Object → Instance → Mouse → PlayerMouse
Nova inheritance: Instance → Mouse → PlayerMouse
Inherited members¶
Inherited from Mouse: 21 properties, 36 methods, 18 events. They are documented on the base class page.
Roblox reference: PlayerMouse
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.