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.
This is a component wrapper for Player Mouse which can be added to a GameObject.
Inheritance HierarchySystemObject
Object
Component
Behaviour
MonoBehaviour
Rewired.ComponentsComponentWrapperPlayerController
Rewired.ComponentsPlayerController
Rewired.ComponentsPlayerMouse
Object
Component
Behaviour
MonoBehaviour
Rewired.ComponentsComponentWrapperPlayerController
Rewired.ComponentsPlayerController
Rewired.ComponentsPlayerMouse
Namespace: Rewired.Components
Assembly: Rewired_Core (in Rewired_Core.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
[SerializableAttribute] public sealed class PlayerMouse : PlayerController
The PlayerMouse type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PlayerMouse | Initializes a new instance of the PlayerMouse class |
Properties| Name | Description | |
|---|---|---|
 | animation | Obsolete. (Inherited from Component.) |
| audio | Obsolete. (Inherited from Component.) |
| 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.) |
| camera | Obsolete. (Inherited from Component.) |
| clampToMovementArea |
If enabled, movement will be clamped to the movementArea.
|
| collider | Obsolete. (Inherited from Component.) |
| collider2D | Obsolete. (Inherited from Component.) |
| constantForce | Obsolete. (Inherited from Component.) |
| 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 | (Inherited from Behaviour.) |
| gameObject | (Inherited from Component.) |
| guiElement | Obsolete. (Inherited from Component.) |
| guiText | Obsolete. (Inherited from Component.) |
| guiTexture | Obsolete. (Inherited from Component.) |
| hideFlags | (Inherited from Object.) |
| hingeJoint | Obsolete. (Inherited from Component.) |
| isActiveAndEnabled | (Inherited from Behaviour.) |
| leftButton |
The left or first button.
|
| light | Obsolete. (Inherited from Component.) |
| 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.
|
| name | (Inherited from Object.) |
| networkView | Obsolete. (Inherited from Component.) |
| particleSystem | Obsolete. (Inherited from Component.) |
| 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.
|
| renderer | Obsolete. (Inherited from Component.) |
| rightButton |
The right or second button.
|
| rigidbody | Obsolete. (Inherited from Component.) |
| rigidbody2D | Obsolete. (Inherited from Component.) |
| runInEditMode | (Inherited from MonoBehaviour.) |
| 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.
|
| tag | (Inherited from Component.) |
| transform | (Inherited from Component.) |
| useGUILayout | (Inherited from MonoBehaviour.) |
| 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.
|
| 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 | |
|---|---|---|
| BroadcastMessage(String) | (Inherited from Component.) |
| BroadcastMessage(String, Object) | (Inherited from Component.) |
| BroadcastMessage(String, SendMessageOptions) | (Inherited from Component.) |
| BroadcastMessage(String, Object, SendMessageOptions) | (Inherited from Component.) |
| CancelInvoke | (Inherited from MonoBehaviour.) |
| CancelInvoke(String) | (Inherited from MonoBehaviour.) |
| CompareTag | (Inherited from Component.) |
| Equals | (Inherited from Object.) |
| 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.) |
| GetComponent(Type) | (Inherited from Component.) |
| GetComponent(String) | (Inherited from Component.) |
| GetComponent``1 | (Inherited from Component.) |
| GetComponentInChildren(Type) | (Inherited from Component.) |
| GetComponentInChildren(Type, Boolean) | (Inherited from Component.) |
| GetComponentInChildren``1 | (Inherited from Component.) |
| GetComponentInChildren``1(Boolean) | (Inherited from Component.) |
| GetComponentInParent(Type) | (Inherited from Component.) |
| GetComponentInParent``1 | (Inherited from Component.) |
| GetComponents(Type) | (Inherited from Component.) |
| GetComponents(Type, ListComponent) | (Inherited from Component.) |
| GetComponents``1 | (Inherited from Component.) |
| GetComponents``1(ListUMP) | (Inherited from Component.) |
| GetComponentsInChildren(Type) | (Inherited from Component.) |
| GetComponentsInChildren(Type, Boolean) | (Inherited from Component.) |
| GetComponentsInChildren``1 | (Inherited from Component.) |
| GetComponentsInChildren``1(Boolean) | (Inherited from Component.) |
| GetComponentsInChildren``1(ListUMP) | (Inherited from Component.) |
| GetComponentsInChildren``1(Boolean, ListUMP) | (Inherited from Component.) |
| GetComponentsInParent(Type) | (Inherited from Component.) |
| GetComponentsInParent(Type, Boolean) | (Inherited from Component.) |
| GetComponentsInParent``1 | (Inherited from Component.) |
| GetComponentsInParent``1(Boolean) | (Inherited from Component.) |
| GetComponentsInParent``1(Boolean, ListUMP) | (Inherited from Component.) |
| GetElement(Int32) |
Gets the element at the specified index.
(Inherited from PlayerController.) |
| GetHashCode | (Inherited from Object.) |
| GetInstanceID | (Inherited from Object.) |
| Invoke | (Inherited from MonoBehaviour.) |
| InvokeRepeating | (Inherited from MonoBehaviour.) |
| IsInvoking | (Inherited from MonoBehaviour.) |
| IsInvoking(String) | (Inherited from MonoBehaviour.) |
| SendMessage(String) | (Inherited from Component.) |
| SendMessage(String, Object) | (Inherited from Component.) |
| SendMessage(String, SendMessageOptions) | (Inherited from Component.) |
| SendMessage(String, Object, SendMessageOptions) | (Inherited from Component.) |
| SendMessageUpwards(String) | (Inherited from Component.) |
| SendMessageUpwards(String, Object) | (Inherited from Component.) |
| SendMessageUpwards(String, SendMessageOptions) | (Inherited from Component.) |
| SendMessageUpwards(String, Object, SendMessageOptions) | (Inherited from Component.) |
| StartCoroutine(String) | (Inherited from MonoBehaviour.) |
| StartCoroutine(IEnumerator) | (Inherited from MonoBehaviour.) |
| StartCoroutine(String, Object) | (Inherited from MonoBehaviour.) |
| StartCoroutine_Auto | Obsolete. (Inherited from MonoBehaviour.) |
| StopAllCoroutines | (Inherited from MonoBehaviour.) |
| StopCoroutine(IEnumerator) | (Inherited from MonoBehaviour.) |
| StopCoroutine(Coroutine) | (Inherited from MonoBehaviour.) |
| StopCoroutine(String) | (Inherited from MonoBehaviour.) |
| ToString | (Inherited from Object.) |
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