PlayerMouseDefinition Class

Definition for a Player Mouse.

Inheritance Hierarchy

Namespace: Rewired
Assembly: Rewired_Core (in Rewired_Core.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

public sealed class Definition : PlayerControllerDefinition

The PlayerMouseDefinition type exposes the following members.

Fields

	Name	Description
	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.
	elements	A list of element definitions used to create elements in the controller. (Inherited from PlayerControllerDefinition)
	enabled	Is the controller enabled? (Inherited from PlayerControllerDefinition)
	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 PlayerControllerDefinition)
	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.
	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.