ElementAssignment Structure |
A struct for making a controller element assignement.
Namespace: Rewired
Assembly: Rewired_Core (in Rewired_Core.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
public struct ElementAssignment
The ElementAssignment type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ElementAssignment(Int32, Int32, Pole) |
A struct for use in element assignment.
Overload for assignment of a button.
|
| ElementAssignment(Int32, Int32, Boolean) |
A struct for use in element assignment.
Overload for assignment of a full axis.
|
| ElementAssignment(Int32, AxisRange, Int32, Pole) |
A struct for use in element assignment.
Overload for assignment of a split axis.
|
| ElementAssignment(Int32, Int32, Pole, Int32) |
A struct for use in element assignment.
Overload for assignment of a button to replace an existing element map.
|
| ElementAssignment(Int32, Int32, Boolean, Int32) |
A struct for use in element assignment.
Overload for assignment of a full axis to replace an existing element map.
|
| ElementAssignment(KeyCode, ModifierKeyFlags, Int32, Pole) |
A struct for use in element assignment.
Overload for assignment of a keyboard key.
|
| ElementAssignment(Int32, AxisRange, Int32, Pole, Int32) |
A struct for use in element assignment.
Overload for assignment of a split axis to replace an existing element map.
|
| ElementAssignment(KeyCode, ModifierKeyFlags, Int32, Pole, Int32) |
A struct for use in element assignment.
Overload for assignment of a keyboard key to replace an existing element map.
|
| ElementAssignment(ElementAssignmentType, Int32, AxisRange, KeyCode, ModifierKeyFlags, Int32, Pole, Boolean) |
A struct for use in element assignment.
Overload for complete new assignment.
|
| ElementAssignment(ControllerType, ControllerElementType, Int32, AxisRange, KeyCode, ModifierKeyFlags, Int32, Pole, Boolean) |
A struct for use in element assignment.
Overload for complete new assignment.
|
| ElementAssignment(ElementAssignmentType, Int32, AxisRange, KeyCode, ModifierKeyFlags, Int32, Pole, Boolean, Int32) |
A struct for use in element assignment.
Overload for complete assignment to replace an existing element map.
|
| ElementAssignment(ControllerType, ControllerElementType, Int32, AxisRange, KeyCode, ModifierKeyFlags, Int32, Pole, Boolean, Int32) |
A struct for use in element assignment.
Overload for complete assignment to replace an existing element map.
|
Methods| Name | Description | |
|---|---|---|
 | ButtonAssignment(Int32, Int32, Pole) |
Creates a struct for use in element assignment.
For assignment of a button.
|
| ButtonAssignment(Int32, Int32, Pole, Int32) |
Creates a struct for use in element assignment.
For assignment of a button to replace an existing element map.
|
| CompleteAssignment(ElementAssignmentType, Int32, AxisRange, KeyCode, ModifierKeyFlags, Int32, Pole, Boolean) |
Creates a struct for use in element assignment.
For complete new assignment.
|
| CompleteAssignment(ControllerType, ControllerElementType, Int32, AxisRange, KeyCode, ModifierKeyFlags, Int32, Pole, Boolean) |
Creates a struct for use in element assignment.
For complete new assignment.
|
| CompleteAssignment(ElementAssignmentType, Int32, AxisRange, KeyCode, ModifierKeyFlags, Int32, Pole, Boolean, Int32) |
Creates a struct for use in element assignment.
For complete assignment to replace an existing element map.
|
| CompleteAssignment(ControllerType, ControllerElementType, Int32, AxisRange, KeyCode, ModifierKeyFlags, Int32, Pole, Boolean, Int32) |
Creates a struct for use in element assignment.
For complete assignment to replace an existing element map.
|
| FullAxisAssignment(Int32, Int32, Boolean) |
Creates a struct for use in element assignment.
For assignment of a full axis.
|
| FullAxisAssignment(Int32, Int32, Boolean, Int32) |
Creates a struct for use in element assignment.
For assignment of a full axis to replace an existing element map.
|
| KeyboardKeyAssignment(KeyCode, ModifierKeyFlags, Int32, Pole) |
Creates a struct for use in element assignment.
For assignment of a keyboard key.
|
| KeyboardKeyAssignment(KeyCode, ModifierKeyFlags, Int32, Pole, Int32) |
Creates a struct for use in element assignment.
For assignment of a keyboard key to replace an existing element map.
|
| SplitAxisAssignment(Int32, AxisRange, Int32, Pole) |
Creates a struct for use in element assignment.
For assignment of a split axis.
|
| SplitAxisAssignment(Int32, AxisRange, Int32, Pole, Int32) |
Creates a struct for use in element assignment.
For assignment of a split axis to replace an existing element map.
|
| ToElementAssignmentConflictCheck |
Converts this ElementAssignment to an ElementAssignmentConflictCheck struct. Can be used for conflict checking.
You may need to provide additional data to the resulting ElementAssignmentConflictCheck before performing the conflict check.
|
Fields| Name | Description | |
|---|---|---|
 | actionId |
The id of the Action that will be bound to the controller element.
|
| axisContribution |
Does this Action contribute positive or negative values to the final Action's input value? Used for split axis and button/key assignments.
|
| axisRange |
The range of the axis of this assignment. Use Positive or Negative to assign a split axis or Full for a single unified axis assignment.
|
| elementIdentifierId |
The element identifier id the Action will be bound to.
|
| elementMapId |
The id of the ActionElementMap that this assignment will be replacing. (Optional)
|
| invert |
Is the axis inverted? Used only for axis assignments.
|
| keyboardKey |
The keyboard key the Action will be bound to. Only used for keyboard maps.
|
| modifierKeyFlags |
The keyboard modifiers the Action will be bound to. Use this in combination with keyboardKey to make a modified key assignment. Only used for keyboard maps.
|
| type |
The type of the element assignment.
|
See Also