ActionElementMap Properties |
The ActionElementMap type exposes the following members.
Properties| 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.
The returned value will be localized if localization is in use.
|
| 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.
If this is an axis binding, this determines if it is full or split axis binding.
|
| controllerMap |
The parent Controller Map that contains this Action Element Map.
|
| elementIdentifierGlyph |
The primary glyph for the element bound to the Action.
If this is a keyboard binding, modifier keys may be in use, therefore you should use
GetElementIdentifierGlyphs(ICollectionObject) instead to get the modifier key glyphs as well.
You can check elementIdentifierGlyphCount to determine if this binding has more than one glyph to display.
This will only return a glyph if a glyph provider is in use and a glyph has been defined for this element identifier.
|
| elementIdentifierGlyphCount |
The number of glyphs for the element bound to the Action.
If this is a keyboard binding and modifier keys are in use, the returned count will include the modifier key glyphs.
This will only return a non-zero value if a glyph provider is in use and a glyph has been defined for this element identifier.
|
| 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.
The returned value will be localized if localization is in use.
|
| 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 |
Determines if any keyboard modifier keys are set.
This only applies to keyboard bindings.
|
| 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.
Modifier keys should be set in ascending order because the modifier key list will be collapsed after a value is set.
|
| modifierKey2 |
The second keyboard modifier key.
Modifier keys should be set in ascending order because the modifier key list will be collapsed after a value is set.
|
| modifierKey3 |
The third keyboard modifier key.
Modifier keys should be set in ascending order because the modifier key list will be collapsed after a value is set.
|
| modifierKeyFlags |
Flags representing all the assigned keyboard modifier keys.
|
See Also