Click or drag to resize

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 Hierarchy
SystemObject
  RewiredPlayerController
    RewiredPlayerMouse

Namespace:  Rewired
Assembly:  Rewired_Core (in Rewired_Core.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
C#
public sealed class PlayerMouse : PlayerController

The PlayerMouse type exposes the following members.

Properties
  NameDescription
Public propertyaxes
The list of Axes in the controller.
(Inherited from PlayerController.)
Public propertyaxisCount
The number of Axes in the controller.
(Inherited from PlayerController.)
Public propertybuttonCount
The number of Buttons in the controller.
(Inherited from PlayerController.)
Public propertybuttons
The list of Buttons in the controller.
(Inherited from PlayerController.)
Public propertyclampToMovementArea
If enabled, movement will be clamped to the movementArea.
Public propertydefaultToCenter
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.
Public propertyelementCount
The number of Elements in the controller.
(Inherited from PlayerController.)
Public propertyelements
The list of Elements of all types in the controller.
(Inherited from PlayerController.)
Public propertyenabled
Is the controller enabled?
(Inherited from PlayerController.)
Public propertyleftButton
The left or first button.
Public propertymiddleButton
The middle or third button.
Public propertymovementArea
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.
Public propertymovementAreaUnit
The unit format of the movement area. This is used to determine the data format of movementArea.
Public propertyplayerId
The Player id of the Player used for the source of input.
(Inherited from PlayerController.)
Public propertypointerSpeed
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.
Public propertyrightButton
The right or second button.
Public propertyscreenPosition
The screen position on the current frame.
Public propertyscreenPositionDelta
The change in screen position since the previous frame.
Public propertyscreenPositionPrev
The screen position on the previous frame.
Public propertyuseHardwarePointerPosition
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.
Public propertywheel
The wheel (or the first wheel if multiple exist.)
Public propertyxAxis
The horizontal axis or the first axis.
Public propertyyAxis
The vertical axis or the second axis.
Top
Methods
  NameDescription
Public methodGetAxis
Gets the current axis value.
(Inherited from PlayerController.)
Public methodGetAxisRaw
Gets the current raw axis value.
(Inherited from PlayerController.)
Public methodGetButton
Gets the current value of the button.
(Inherited from PlayerController.)
Public methodGetButtonDown
Gets the down state of the button. Returns True only on the first frame the button was pressed.
(Inherited from PlayerController.)
Public methodGetButtonUp
Gets the up state of the button. Returns True only on the first frame the button was released.
(Inherited from PlayerController.)
Public methodGetElement(Int32)
Gets the element at the specified index.
(Inherited from PlayerController.)
Top
Events
  NameDescription
Public eventAxisValueChangedEvent
Triggered when the axis value changes.
(Inherited from PlayerController.)
Public eventButtonStateChangedEvent
Triggered the first frame the button is pressed or released.
(Inherited from PlayerController.)
Public eventEnabledStateChangedEvent
Triggered when the controller is enabled or disabled.
(Inherited from PlayerController.)
Public eventScreenPositionChangedEvent
Triggers when the screen position changes.
Top
See Also