InputMapperOptions Class |
Configuration options for the InputMapper.
Inheritance HierarchySystemObject
RewiredInputMapperOptions
RewiredInputMapperOptions
Namespace: Rewired
Assembly: Rewired_Core (in Rewired_Core.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
public class Options
The InputMapperOptions type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | InputMapperOptions |
Creates a new Options with default values.
|
Properties| Name | Description | |
|---|---|---|
 | allowAxes |
Should axes be polled for user input?
|
| allowButtons |
Should buttons be polled for user input?
|
| allowButtonsOnFullAxisAssignment |
Should buttons be polled when making a full-axis assignment?
If allowed, buttons will be assigned to the positive axis range of the Action.
If not allowed, button input will be ignored when making a full-axis assignment.
|
| allowKeyboardKeysWithModifiers |
Should modifier key + key combinations be allowed for keyboard mappings? Otherwise, only individual key mappings will be allowed.
|
| allowKeyboardModifierKeyAsPrimary |
Should keyboard modifier keys be allowed as the primary key for the Action?
|
| checkForConflicts |
Should assignment conflict checking be enabled?
|
| checkForConflictsWithAllPlayers |
Should assignment conflicts be checked with all Players? This setting overrides all other checkForConflictsWith options.
|
| checkForConflictsWithPlayerIds |
A list of Player Ids to check for assignment conflicts with.
|
| checkForConflictsWithSelf |
Should assignment conflicts be checked with the current Player?
|
| checkForConflictsWithSystemPlayer |
Should assignment conflicts be checked with the System Player?
|
| defaultActionWhenConflictFound |
When an assignment conflict is found, if there is no event listener for the ConflictsFoundEvent, the default action defined here will be used to resolve the conflict.
|
| holdDurationToMapKeyboardModifierKeyAsPrimary |
If both allowKeyboardKeysWithModifiers and allowKeyboardModifierKeyAsPrimary are true, the modifier key must be held down
for this duration in seconds before it will be accepted as a primary key assignment. This is used to allow the user to be able to map
modifier key + key combinations while also allowing them to map modifier keys as the primary key.
|
| ignoreMouseXAxis |
Should the the mouse X axis be ignored when polling for user input?
|
| ignoreMouseYAxis |
Should the the mouse Y axis be ignored when polling for user input?
|
| isElementAllowedCallback |
A callback used to determine whether a particular controller element is allowed for mapping.
Set this if you want to manually disallow specific controller elements from being used.
|
| timeout |
The time in seconds that the mapper will listen before stopping. [0 = no timeout]
|
Methods| Name | Description | |
|---|---|---|
| Clone |
Creates a shallow copy of this object.
|
 | Copy |
Copies data from one Options to another.
|
| ToString | (Overrides ObjectToString.) |
See Also