# PlayerMouse

Roblox Engine API class from Roblox Studio 0.744.0.7441077 (version-7aaa6838d36c4448).

- Inherits from, nearest first: [Mouse](https://rapi.sleaze.dev/classes/Mouse.md), [Instance](https://rapi.sleaze.dev/classes/Instance.md), [Object](https://rapi.sleaze.dev/classes/Object.md)
- Tags: Not creatable
- Memory category: Instances
- HTML page: https://rapi.sleaze.dev/classes/PlayerMouse/
- Roblox documentation: https://create.roblox.com/docs/reference/engine/classes/PlayerMouse

The PlayerMouse behaves identically to the [`Mouse`](https://rapi.sleaze.dev/classes/Mouse.md) object that is obtained using [`Tool.Equipped`](https://rapi.sleaze.dev/classes/Tool.md). Both PlayerMouse and [`Mouse`](https://rapi.sleaze.dev/classes/Mouse.md) are legacy APIs, superseded by [`UserInputService`](https://rapi.sleaze.dev/classes/UserInputService.md).

## Inherited members

- From [Mouse](https://rapi.sleaze.dev/classes/Mouse.md): `Hit`, `Icon`, `IconContent`, `Origin`, `Target`, `TargetFilter`, `TargetSurface`, `UnitRay`, `ViewSizeX`, `ViewSizeY`, `X`, `Y`, `hit`, `target`, `Button1Down`, `Button1Up`, `Button2Down`, `Button2Up`, `Idle`, `Move`, `WheelBackward`, `WheelForward`, `KeyDown`, `KeyUp`, `keyDown`
- From [Instance](https://rapi.sleaze.dev/classes/Instance.md): `Archivable`, `archivable`, `Attributes`, `AttributesReplicate`, `AttributesSerialize`, `HistoryId`, `Name`, `Parent`, `PredictionMode`, `PropertyStatusStudio`, `RobloxLocked`, `SerializedOverrides`, `SourceAssetId`, `Tags`, `UniqueId`, `numExpectedDirectChildren`, `DataCost`, `Capabilities`, `DefinesCapabilities`, `IsInSandbox`, `Sandboxed`, `AddTag`, `ClearAllChildren`, `Clone`, `Destroy`, `FindFirstAncestor`, `FindFirstAncestorOfClass`, `FindFirstAncestorWhichIsA`, `FindFirstChild`, `FindFirstChildOfClass`, `FindFirstChildWhichIsA`, `FindFirstDescendant`, `GetActor`, `GetAttribute`, `GetAttributeChangedSignal`, `GetAttributes`, `GetChildren`, `GetDebugId`, `GetDescendants`, `GetFullName`, `GetStyled`, `GetStyledPropertyChangedSignal`, `GetTags`, `HasTag`, `IsAncestorOf`, `IsDescendantOf`, `IsPropertyModified`, `QueryDescendants`, `RemoveTag`, `ResetPropertyToDefault`, `SetAttribute`, `WaitForChild`, `Remove`, `children`, `clone`, `destroy`, `findFirstChild`, `getChildren`, `isDescendantOf`, `remove`, `AncestryChanged`, `AttributeChanged`, `ChildAdded`, `ChildRemoved`, `DescendantAdded`, `DescendantRemoving`, `Destroying`, `StyledPropertiesChanged`, `childAdded`
- From [Object](https://rapi.sleaze.dev/classes/Object.md): `ClassName`, `className`, `GetPropertyChangedSignal`, `IsA`, `isA`, `Changed`