PlayerMouse Class |
A virtual mouse that can be used to drive a sprite or software mouse pointer.
It uses a Rewired Player to move the pointer position and as the source for
the buttons and axes.
Inheritance HierarchyNamespace: Rewired
Assembly: Rewired_Core (in Rewired_Core.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
public sealed class PlayerMouse : PlayerController
The PlayerMouse type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | axes |
The list of Axes in the controller.
(Inherited from PlayerController.) |
| axisCount |
The number of Axes in the controller.
(Inherited from PlayerController.) |
| buttonCount |
The number of Buttons in the controller.
(Inherited from PlayerController.) |
| buttons |
The list of Buttons in the controller.
(Inherited from PlayerController.) |
| clampToMovementArea |
If enabled, movement will be clamped to the movementArea.
|
| defaultToCenter |
If enabled, the screen position will default to the center of the allowed movement area.
Otherwise, it will default to the lower-left corner of the allowed movement area.
|
| elementCount |
The number of Elements in the controller.
(Inherited from PlayerController.) |
| elements |
The list of Elements of all types in the controller.
(Inherited from PlayerController.) |
| enabled |
Is the controller enabled?
(Inherited from PlayerController.) |
| leftButton |
The left or first button.
|
| middleButton |
The middle or third button.
|
| movementArea |
The allowed movement area for the mouse pointer.
Set movementAreaUnit to determine the data format of this value.
This rect is a screen-space rect with 0, 0 at the lower-left corner.
If you pass a UnityEngine.Rect in which represents 0, 0 as the upper-left corner, Y will automatically be flipped.
|
| movementAreaUnit |
The unit format of the movement area.
This is used to determine the data format of movementArea.
|
| playerId |
The Player id of the Player used for the source of input.
(Inherited from PlayerController.) |
| pointerSpeed |
The pointer speed. This does not affect the speed of input from the mouse x/y axes if
useHardwarePointerPosition is enabled. It only affects the speed
from input sources other than mouse x/y or if mouse x/y are mapped to Actions
assigned to Axes.
|
| rightButton |
The right or second button.
|
| screenPosition |
The screen position on the current frame.
|
| screenPositionDelta |
The change in screen position since the previous frame.
|
| screenPositionPrev |
The screen position on the previous frame.
|
| useHardwarePointerPosition |
If enabled, the hardware pointer position will be used for mouse input.
Otherwise, the position of the pointer will be calculated only from
the Axis Action values.
The Player that owns this Player Mouse must have the physical mouse assigned to it in order for the hardware position to be used, ex: player.controllers.hasMouse == true.
|
| wheel |
The wheel (or the first wheel if multiple exist.)
|
| xAxis |
The horizontal axis or the first axis.
|
| yAxis |
The vertical axis or the second axis.
|
Methods| Name | Description | |
|---|---|---|
 | GetAxis |
Gets the current axis value.
(Inherited from PlayerController.) |
| GetAxisRaw |
Gets the current raw axis value.
(Inherited from PlayerController.) |
| GetButton |
Gets the current value of the button.
(Inherited from PlayerController.) |
| GetButtonDown |
Gets the down state of the button. Returns True only on the first frame the button was pressed.
(Inherited from PlayerController.) |
| GetButtonUp |
Gets the up state of the button. Returns True only on the first frame the button was released.
(Inherited from PlayerController.) |
| GetElement(Int32) |
Gets the element at the specified index.
(Inherited from PlayerController.) |
Events| Name | Description | |
|---|---|---|
 | AxisValueChangedEvent |
Triggered when the axis value changes.
(Inherited from PlayerController.) |
| ButtonStateChangedEvent |
Triggered the first frame the button is pressed or released.
(Inherited from PlayerController.) |
| EnabledStateChangedEvent |
Triggered when the controller is enabled or disabled.
(Inherited from PlayerController.) |
| ScreenPositionChangedEvent |
Triggers when the screen position changes.
|
See Also