ActionElementMap Class |
Namespace: Rewired
[SerializableAttribute] public sealed class ActionElementMap
The ActionElementMap type exposes the following members.
Name | Description | |
---|---|---|
ActionElementMap | Initializes a new instance of the ActionElementMap class | |
ActionElementMap(ActionElementMap) | Initializes a new instance of the ActionElementMap class | |
ActionElementMap(Int32, ControllerElementType, Int32) | Initializes a new instance of the ActionElementMap class | |
ActionElementMap(Int32, ControllerElementType, Int32, Pole, AxisRange) | Initializes a new instance of the ActionElementMap class | |
ActionElementMap(Int32, ControllerElementType, Int32, Pole, AxisRange, Boolean) | Initializes a new instance of the ActionElementMap class | |
ActionElementMap(Int32, ControllerElementType, Pole, KeyboardKeyCode, ModifierKey, ModifierKey, ModifierKey) |
Create an ActionElementMap for a keyboard key.
|
Name | Description | |
---|---|---|
actionDescriptiveName |
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.
| |
actionId |
Gets the id of the Action to which the element is bound.
| |
axisContribution |
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.
| |
axisRange |
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.
| |
axisType |
The axis type.
| |
controllerMap |
The parent Controller Map that contains this ActionElementMap.
| |
elementIdentifierId |
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.
| |
elementIdentifierName |
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.
| |
elementIndex |
Gets the controller element index pointed to by this mapping.
| |
elementType |
Gets the element type of the controller element bound to the Action.
| |
enabled |
Is the Action Element Map enabled? Disabled maps will never return input.
| |
hasModifiers |
Does this use any keyboard modfiier keys?
| |
id |
Gets the unique runtime id of this ActionElementMap. This value is not consistent between game sessions, so do not store it.
| |
invert |
Is the axis inverted?
| |
keyboardKeyCode |
The keyboard key code. Only used for keyboard bindings. Returns Rewired.KeyboardKeyCode value.
| |
keyCode |
The keyboard key code. Only used for keyboard bindings. Returns UnityEngine.KeyCode value.
| |
modifierKey1 |
The first keyboard modifier key.
| |
modifierKey2 |
The second keyboard modifier key.
| |
modifierKey3 |
The third keyboard modifier key.
| |
modifierKeyFlags |
Flags representing all the assigned keyboard modifier keys.
|
Name | Description | |
---|---|---|
CheckForAssignmentConflict(ActionElementMap) |
Checks if there are any assignment conflicts between the incoming ActionElementMap and this map.
| |
CheckForAssignmentConflict(ElementAssignment) |
Checks if there are any assignment conflicts between the incoming ElementAssignment and this map.
| |
IsTarget(ControllerElementTarget) |
Is the Controller Element target mapped by this ActionElementMap?
| |
IsTarget(IControllerElementTarget) |
Is the Controller Element target mapped by this ActionElementMap?
| |
ShowInField |
Should this Action Element Map be shown in a particular input field with the specified range?
This makes it easy to determine whether to show this map in a full, positive, or negative input field when remapping controls.
| |
ToString | (Overrides ObjectToString.) |