Click or drag to resize

ActionElementMap Properties

The ActionElementMap type exposes the following members.

Properties
  NameDescription
Public propertyactionDescriptiveName
Gets the descriptive name of the Action. For split axes, this will return the Positive or Negative Descriptive Name or the Descriptive Name with a +/- suffix.
Public propertyactionId
Gets the id of the Action to which the element is bound.
Public propertyaxisContribution
The contribution to the Action's final value when queried as an axis. Describes how the binding contributes value to the Action when that Action is queried as an Axis. (Player.GetAxis()). Axis Contribution describes the Action, not the element. Axis Contribution is used to determine how button elements and split-axis element (one pole of an axis element) bindings contribute value to the Action's value when queried as an axis. Axis Contribution is not used when the Action is bound to a full-axis element. Instead invert is used to determine how the full-axis binding contributes value to the Action when queried as an axis.
Public propertyaxisRange
The range of the axis. Describes whether the Action is bound to the full, positive, or negative portion of the axis element. Axis Range describes the axis element, not the Action. Axis Range is not used when the Action is bound to a button element because buttons do not have a range of values or +/- poles. For Actions bound to buttons or only one pole of an axis, axisContribution.
Public propertyaxisType
The axis type.
Public propertycontrollerMap
The parent Controller Map that contains this ActionElementMap.
Public propertyelementIdentifierId
The controller element identifier id bound to the Action. Warning: Do not change this value during iteration of the list of element mappings in a Controller Map. If the element type changes based on the new element identifier id, the element mapping list will be changed resulting in an InvalidOperationException during iteration.
Public propertyelementIdentifierName
Gets the descriptive name of the element identifier bound to the Action. For split axes, this will return the Positive or Negative Descriptive Name or the Descriptive Name with a +/- suffix.
Public propertyelementIndex
Gets the controller element index pointed to by this mapping.
Public propertyelementType
Gets the element type of the controller element bound to the Action.
Public propertyenabled
Is the Action Element Map enabled? Disabled maps will never return input.
Public propertyhasModifiers
Does this use any keyboard modfiier keys?
Public propertyid
Gets the unique runtime id of this ActionElementMap. This value is not consistent between game sessions, so do not store it.
Public propertyinvert
Is the axis inverted?
Public propertykeyboardKeyCode
The keyboard key code. Only used for keyboard bindings. Returns Rewired.KeyboardKeyCode value.
Public propertykeyCode
The keyboard key code. Only used for keyboard bindings. Returns UnityEngine.KeyCode value.
Public propertymodifierKey1
The first keyboard modifier key.
Public propertymodifierKey2
The second keyboard modifier key.
Public propertymodifierKey3
The third keyboard modifier key.
Public propertymodifierKeyFlags
Flags representing all the assigned keyboard modifier keys.
Top
See Also