PlayerMouse
The mouse data of a player
Properties
| Name | Type | Description |
|---|---|---|
| X | Number | The x position of the mouse |
| Y | Number | The y position of the mouse |
| ScreenSizeX | Number | The width of the player's viewport (screen) |
| ScreenSizeY | Number | The height of the player's viewport (screen) |
| HitPosition | Vector3 | The hit point from the mouse's ray cast |
| HitNormal | Vector3 | The normal of the surface hit from the mouse's ray cast |
| Origin | CData | CData that describes the player's camera position and direction of the mouse |
| Target | Part | The part that the mouse is over |
Functions
| Name | Returns | Description |
|---|
Events
| Name | Description |
|---|---|
| LeftButtonDown | Fires when the left mouse button is pressed |
| LeftButtonUp | Fires when the left mouse button is released |
| RightButtonDown | Fires when the right mouse button is pressed |
| RightButtonUp | Fires when the right mouse button is pressed |
| Move | Fires when the mouse is moved |
| ScrollForward | Fires when the scrollwheel is moved forward |
| ScrollBackward | Fires when the scrollwheel is moved backward |