MappingHelper Methods |
The ReInputMappingHelper type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | ActionCategoriesWithTag |
Enumerates all action categories with matching tag
|
| ActionsInCategoriesWithTag |
Enumerates all actions with a tag
|
| ActionsInCategory(Int32) |
Enumerates all actions in a specific category
|
| ActionsInCategory(String) |
Enumerates all actions in a specific category
|
| ActionsInCategory(Int32, Boolean) |
Enumerates all actions in a specific category
|
| ActionsInCategory(String, Boolean) |
Enumerates all actions in a specific category
|
| GetAction(Int32) |
Gets a specific action
|
| GetAction(String) |
Gets a specific action
|
| GetActionCategory(Int32) |
Gets a specific action category
|
| GetActionCategory(String) |
Gets a specific action category
|
| GetActionCategoryId |
Gets the id of a specific action category
|
| GetActionElementMap |
Gets the Action Element Map with the specified id from
existing Action Element Maps in all Players.
|
| GetActionId |
Gets the id of a specific action
|
| GetControllerMap |
Gets the Controller Map with the specified id from
existing Controller Maps loaded in all Players.
|
| GetControllerMapEnablerRuleSetInstance(Int32) |
Gets a copy of the Controller Map Enabler Rule Set at the specified id.
|
| GetControllerMapEnablerRuleSetInstance(String) |
Gets a copy of the Controller Map Enabler Rule Set with the specified name.
|
| GetControllerMapInstance(Controller, Int32, Int32) |
Gets a copy of a Controller Map.
This can be used to view the default Controller Map setup in the Rewired Input Manager.
|
| GetControllerMapInstance(Controller, String, String) |
Gets a copy of a Controller Map.
This can be used to view the default Controller Map setup in the Rewired Input Manager.
|
| GetControllerMapInstance(ControllerIdentifier, Int32, Int32) |
Gets a copy of a Controller Map.
This can be used to view the default Controller Map setup in the Rewired Input Manager.
This overload can be used when no Controller is actually connected and available to be used to look up the correct Controller Maps to load.
The Controller Map returned by this method is not guarateed to be consistent with the Controller Map that would be loaded
were the actual device to be connected. This is due to the fact that different Controller Maps may be loaded depending on the
actual device connected, properties returned by this device, the current input source(s) in use, and more factors.
This can be used to view the default Joystick Map setup in the Rewired Input Manager.
NOTE: Element indices in ActionElementMaps may not match to to a Controller Map created with the actual controller connected.
Do not rely on ActionElementMap.elementIndex being accurate in Controller Maps returned by this method.
This method can only be used to load Controller Maps for recognized Controllers. Unrecognized Controllers are not supported.
|
| GetControllerMapInstance(ControllerIdentifier, String, String) |
Gets a copy of a Controller Map.
This can be used to view the default Controller Map setup in the Rewired Input Manager.
This overload can be used when no Controller is actually connected and available to be used to look up the correct Controller Maps to load.
The Controller Map returned by this method is not guarateed to be consistent with the Controller Map that would be loaded
were the actual device to be connected. This is due to the fact that different Controller Maps may be loaded depending on the
actual device connected, properties returned by this device, the current input source(s) in use, and more factors.
This can be used to view the default Joystick Map setup in the Rewired Input Manager.
NOTE: Element indices in ActionElementMaps may not match to to a Controller Map created with the actual controller connected.
Do not rely on ActionElementMap.elementIndex being accurate in Controller Maps returned by this method.
This method can only be used to load Controller Maps for recognized Controllers. Unrecognized Controllers are not supported.
|
| GetControllerMapInstanceSavedOrDefault(Int32, Controller, Int32, Int32) |
Gets a copy of a Controller Map.
This can be used to view the Controller Map saved in user data if available or the default Controller Map setup in the Rewired Input Manager.
The Controller Map will be first loaded from UserDataStore. If none is found, it will be loaded from the Rewired Input Manager defaults.
UserDataStore must implement IControllerMapStore or data cannot be loaded from saved user data.
|
| GetControllerMapInstanceSavedOrDefault(Int32, Controller, String, String) |
Gets a copy of a Controller Map.
This can be used to view the Controller Map saved in user data if available or the default Controller Map setup in the Rewired Input Manager.
The Controller Map will be first loaded from UserDataStore. If none is found, it will be loaded from the Rewired Input Manager defaults.
UserDataStore must implement IControllerMapStore or data cannot be loaded from saved user data.
|
| GetControllerMapInstanceSavedOrDefault(Int32, ControllerIdentifier, Int32, Int32) |
Gets a copy of a Controller Map.
This can be used to view the Controller Map saved in user data if available or the default Controller Map setup in the Rewired Input Manager.
The Controller Map will be first loaded from UserDataStore. If none is found, it will be loaded from the Rewired Input Manager defaults.
UserDataStore must implement IControllerMapStore or data cannot be loaded from saved user data.
This overload can be used when no Controller is actually connected and available to be used to look up the correct Controller Maps to load.
The Controller Map returned by this method is not guarateed to be consistent with the Controller Map that would be loaded
were the actual device to be connected. This is due to the fact that different Controller Maps may be loaded depending on the
actual device connected, properties returned by this device, the current input source(s) in use, and more factors.
This can be used to view the Controller Map saved in user data if available or the default Controller Map setup in the Rewired Input Manager.
NOTE: Element indices in ActionElementMaps may not match to to a Controller Map created with the actual controller connected.
Do not rely on ActionElementMap.elementIndex being accurate in Controller Maps returned by this method.
|
| GetControllerMapInstanceSavedOrDefault(Int32, ControllerIdentifier, String, String) |
Gets a copy of a Controller Map.
This can be used to view the Controller Map saved in user data if available or the default Controller Map setup in the Rewired Input Manager.
The Controller Map will be first loaded from UserDataStore. If none is found, it will be loaded from the Rewired Input Manager defaults.
UserDataStore must implement IControllerMapStore or data cannot be loaded from saved user data.
This overload can be used when no Controller is actually connected and available to be used to look up the correct Controller Maps to load.
The Controller Map returned by this method is not guarateed to be consistent with the Controller Map that would be loaded
were the actual device to be connected. This is due to the fact that different Controller Maps may be loaded depending on the
actual device connected, properties returned by this device, the current input source(s) in use, and more factors.
This can be used to view the Controller Map saved in user data if available or the default Controller Map setup in the Rewired Input Manager.
NOTE: Element indices in ActionElementMaps may not match to to a Controller Map created with the actual controller connected.
Do not rely on ActionElementMap.elementIndex being accurate in Controller Maps returned by this method.
|
| GetControllerMapLayoutManagerRuleSetInstance(Int32) |
Gets a copy of the Controller Map Layout Manager Rule Set at the specified id.
|
| GetControllerMapLayoutManagerRuleSetInstance(String) |
Gets a copy of the Controller Map Layout Manager Rule Set with the specified name.
|
| GetControllerTemplateMapInstance(Guid, Int32, Int32) |
Gets a copy of a Controller Template Map from the default controller maps.
This can be used to view the default Controller Template Map setup in the Rewired Input Manager.
|
| GetControllerTemplateMapInstance(Guid, String, String) |
Gets a copy of a Controller Template Map from the default controller maps.
This can be used to view the default Controller Template Map setup in the Rewired Input Manager.
|
| GetCustomControllerLayout(Int32) |
Gets a custom controller layout
|
| GetCustomControllerLayout(String) |
Gets a custom controller layout
|
| GetCustomControllerLayoutId |
Gets the id of a custom controller layout
|
| GetCustomControllerMapInstance(ControllerIdentifier, Int32, Int32) |
Gets a copy of a custom controller map from the default controller maps.
This overload can be used when no Custom Controller is actually connected and available to be used to look up the correct Controller Maps to load.
The Controller Map returned by this method is not guarateed to be consistent with the Controller Map that would be loaded
were the actual device to be connected. This is due to the fact that different Controller Maps may be loaded depending on the
actual device connected, properties returned by this device, the current input source(s) in use, and more factors.
This can be used to view the default CustomController Map setup in the Rewired Input Manager.
NOTE: Element indices in ActionElementMaps may not match to to a Controller Map created with the actual controller connected.
Do not rely on ActionElementMap.elementIndex being accurate in Controller Maps returned by this method.
This method can only be used to load Controller Maps for recognized Controllers. Unrecognized Controllers are not supported.
|
| GetCustomControllerMapInstance(ControllerIdentifier, String, String) |
Gets a copy of a custom controller map from the default controller maps.
This overload can be used when no Custom Controller is actually connected and available to be used to look up the correct Controller Maps to load.
The Controller Map returned by this method is not guarateed to be consistent with the Controller Map that would be loaded
were the actual device to be connected. This is due to the fact that different Controller Maps may be loaded depending on the
actual device connected, properties returned by this device, the current input source(s) in use, and more factors.
This can be used to view the default CustomController Map setup in the Rewired Input Manager.
NOTE: Element indices in ActionElementMaps may not match to to a Controller Map created with the actual controller connected.
Do not rely on ActionElementMap.elementIndex being accurate in Controller Maps returned by this method.
This method can only be used to load Controller Maps for recognized Controllers. Unrecognized Controllers are not supported.
|
| GetCustomControllerMapInstance(CustomController, Int32, Int32) |
Gets a copy of a Custom Controller Map.
This can be used to view the default Custom Controller Map setup in the Rewired Input Manager.
|
| GetCustomControllerMapInstance(CustomController, String, String) |
Gets a copy of a Custom Controller Map.
This can be used to view the default Custom Controller Map setup in the Rewired Input Manager.
|
| GetCustomControllerMapInstanceSavedOrDefault(Int32, ControllerIdentifier, Int32, Int32) |
This can be used to view the Controller Map saved in user data if available or the default Controller Map setup in the Rewired Input Manager.
The Controller Map will be first loaded from UserDataStore. If none is found, it will be loaded from the Rewired Input Manager defaults.
UserDataStore must implement IControllerMapStore or data cannot be loaded from saved user data.
This overload can be used when no Custom Controller is actually connected and available to be used to look up the correct Controller Maps to load.
The Controller Map returned by this method is not guarateed to be consistent with the Controller Map that would be loaded
were the actual device to be connected. This is due to the fact that different Controller Maps may be loaded depending on the
actual device connected, properties returned by this device, the current input source(s) in use, and more factors.
This can be used to view the Controller Map saved in user data if available or the default Controller Map setup in the Rewired Input Manager.
NOTE: Element indices in ActionElementMaps may not match to to a Controller Map created with the actual controller connected.
Do not rely on ActionElementMap.elementIndex being accurate in Controller Maps returned by this method.
|
| GetCustomControllerMapInstanceSavedOrDefault(Int32, ControllerIdentifier, String, String) |
This can be used to view the Controller Map saved in user data if available or the default Controller Map setup in the Rewired Input Manager.
The Controller Map will be first loaded from UserDataStore. If none is found, it will be loaded from the Rewired Input Manager defaults.
UserDataStore must implement IControllerMapStore or data cannot be loaded from saved user data.
This overload can be used when no Custom Controller is actually connected and available to be used to look up the correct Controller Maps to load.
The Controller Map returned by this method is not guarateed to be consistent with the Controller Map that would be loaded
were the actual device to be connected. This is due to the fact that different Controller Maps may be loaded depending on the
actual device connected, properties returned by this device, the current input source(s) in use, and more factors.
This can be used to view the Controller Map saved in user data if available or the default Controller Map setup in the Rewired Input Manager.
NOTE: Element indices in ActionElementMaps may not match to to a Controller Map created with the actual controller connected.
Do not rely on ActionElementMap.elementIndex being accurate in Controller Maps returned by this method.
|
| GetCustomControllerMapInstanceSavedOrDefault(Int32, CustomController, Int32, Int32) |
Gets a copy of a Custom Controller Map.
This can be used to view the Controller Map saved in user data if available or the default Controller Map setup in the Rewired Input Manager.
The Controller Map will be first loaded from UserDataStore. If none is found, it will be loaded from the Rewired Input Manager defaults.
UserDataStore must implement IControllerMapStore or data cannot be loaded from saved user data.
|
| GetCustomControllerMapInstanceSavedOrDefault(Int32, CustomController, String, String) |
Gets a copy of a Custom Controller Map.
This can be used to view the Controller Map saved in user data if available or the default Controller Map setup in the Rewired Input Manager.
The Controller Map will be first loaded from UserDataStore. If none is found, it will be loaded from the Rewired Input Manager defaults.
UserDataStore must implement IControllerMapStore or data cannot be loaded from saved user data.
|
| GetFirstJoystickTemplateElementIdentifier | Obsolete.
Gets the first template Element Identifier on the first joystick template found that maps to the joystick's Element Identifier.
NOTE: It is discouraged to use this method as the mapping template system wasn't designed for this use. This method has been added
as a short-term solution to the problem of trying to identify controller elements as generic Gamepad elements for use in displaying
visual help to users. A better solution will be available in the future and this method will be deprecated at that time.
|
| GetInputBehavior(Int32, Int32) |
Gets a specific input behavior from a specific player
|
| GetInputBehavior(Int32, String) |
Gets a specific input behavior from a specific player
|
| GetInputBehaviorId |
Gets the id of a specific input behavior
|
| GetInputBehaviors |
Gets a list of input behaviors from a specific player
|
| GetJoystickLayout(Int32) |
Gets a joystick layout
|
| GetJoystickLayout(String) |
Gets a joystick layout
|
| GetJoystickLayoutId |
Gets the id of a joystick layout
|
| GetJoystickMapInstance(Guid, Int32, Int32) |
Gets a copy of a joystick map from the default controller maps.
This overload can be used when no Joystick is actually connected and available to be used to look up the correct Controller Maps to load.
The Controller Map returned by this method is not guarateed to be consistent with the Controller Map that would be loaded
were the actual device to be connected. This is due to the fact that different Controller Maps may be loaded depending on the
actual device connected, properties returned by this device, the current input source(s) in use, and more factors.
This can be used to view the default Joystick Map setup in the Rewired Input Manager.
NOTE: Element indices in ActionElementMaps may not match to to a Controller Map created with the actual controller connected.
Do not rely on ActionElementMap.elementIndex being accurate in Controller Maps returned by this method.
This method can only be used to load Controller Maps for recognized Controllers. Unrecognized Controllers are not supported.
|
| GetJoystickMapInstance(Guid, String, String) |
Gets a copy of a joystick map from the default controller maps.
This overload can be used when no Joystick is actually connected and available to be used to look up the correct Controller Maps to load.
The Controller Map returned by this method is not guarateed to be consistent with the Controller Map that would be loaded
were the actual device to be connected. This is due to the fact that different Controller Maps may be loaded depending on the
actual device connected, properties returned by this device, the current input source(s) in use, and more factors.
This can be used to view the default Joystick Map setup in the Rewired Input Manager.
NOTE: Element indices in ActionElementMaps may not match to to a Controller Map created with the actual controller connected.
Do not rely on ActionElementMap.elementIndex being accurate in Controller Maps returned by this method.
This method can only be used to load Controller Maps for recognized Controllers. Unrecognized Controllers are not supported.
|
| GetJoystickMapInstance(ControllerIdentifier, Int32, Int32) |
Gets a copy of a joystick map from the default controller maps.
This overload can be used when no Joystick is actually connected and available to be used to look up the correct Controller Maps to load.
The Controller Map returned by this method is not guarateed to be consistent with the Controller Map that would be loaded
were the actual device to be connected. This is due to the fact that different Controller Maps may be loaded depending on the
actual device connected, properties returned by this device, the current input source(s) in use, and more factors.
This can be used to view the default Joystick Map setup in the Rewired Input Manager.
NOTE: Element indices in ActionElementMaps may not match to to a Controller Map created with the actual controller connected.
Do not rely on ActionElementMap.elementIndex being accurate in Controller Maps returned by this method.
This method can only be used to load Controller Maps for recognized Controllers. Unrecognized Controllers are not supported.
|
| GetJoystickMapInstance(ControllerIdentifier, String, String) |
Gets a copy of a joystick map from the default controller maps.
This overload can be used when no Joystick is actually connected and available to be used to look up the correct Controller Maps to load.
The Controller Map returned by this method is not guarateed to be consistent with the Controller Map that would be loaded
were the actual device to be connected. This is due to the fact that different Controller Maps may be loaded depending on the
actual device connected, properties returned by this device, the current input source(s) in use, and more factors.
This can be used to view the default Joystick Map setup in the Rewired Input Manager.
NOTE: Element indices in ActionElementMaps may not match to to a Controller Map created with the actual controller connected.
Do not rely on ActionElementMap.elementIndex being accurate in Controller Maps returned by this method.
This method can only be used to load Controller Maps for recognized Controllers. Unrecognized Controllers are not supported.
|
| GetJoystickMapInstance(Joystick, Int32, Int32) |
Gets a copy of a Joystick Map.
This can be used to view the default Joystick Map setup in the Rewired Input Manager.
|
| GetJoystickMapInstance(Joystick, String, String) |
Gets a copy of a Joystick Map.
This can be used to view the default Joystick Map setup in the Rewired Input Manager.
|
| GetJoystickMapInstanceSavedOrDefault(Int32, ControllerIdentifier, Int32, Int32) |
This can be used to view the Controller Map saved in user data if available or the default Controller Map setup in the Rewired Input Manager.
The Controller Map will be first loaded from UserDataStore. If none is found, it will be loaded from the Rewired Input Manager defaults.
UserDataStore must implement IControllerMapStore or data cannot be loaded from saved user data.
This overload can be used when no Joystick is actually connected and available to be used to look up the correct Controller Maps to load.
The Controller Map returned by this method is not guarateed to be consistent with the Controller Map that would be loaded
were the actual device to be connected. This is due to the fact that different Controller Maps may be loaded depending on the
actual device connected, properties returned by this device, the current input source(s) in use, and more factors.
This can be used to view the Controller Map saved in user data if available or the default Controller Map setup in the Rewired Input Manager.
NOTE: Element indices in ActionElementMaps may not match to to a Controller Map created with the actual controller connected.
Do not rely on ActionElementMap.elementIndex being accurate in Controller Maps returned by this method.
|
| GetJoystickMapInstanceSavedOrDefault(Int32, ControllerIdentifier, String, String) |
This can be used to view the Controller Map saved in user data if available or the default Controller Map setup in the Rewired Input Manager.
The Controller Map will be first loaded from UserDataStore. If none is found, it will be loaded from the Rewired Input Manager defaults.
UserDataStore must implement IControllerMapStore or data cannot be loaded from saved user data.
This overload can be used when no Joystick is actually connected and available to be used to look up the correct Controller Maps to load.
The Controller Map returned by this method is not guarateed to be consistent with the Controller Map that would be loaded
were the actual device to be connected. This is due to the fact that different Controller Maps may be loaded depending on the
actual device connected, properties returned by this device, the current input source(s) in use, and more factors.
This can be used to view the Controller Map saved in user data if available or the default Controller Map setup in the Rewired Input Manager.
NOTE: Element indices in ActionElementMaps may not match to to a Controller Map created with the actual controller connected.
Do not rely on ActionElementMap.elementIndex being accurate in Controller Maps returned by this method.
|
| GetJoystickMapInstanceSavedOrDefault(Int32, Joystick, Int32, Int32) |
Gets a copy of a Joystick Map.
This can be used to view the Controller Map saved in user data if available or the default Controller Map setup in the Rewired Input Manager.
The Controller Map will be first loaded from UserDataStore. If none is found, it will be loaded from the Rewired Input Manager defaults.
UserDataStore must implement IControllerMapStore or data cannot be loaded from saved user data.
|
| GetJoystickMapInstanceSavedOrDefault(Int32, Joystick, String, String) |
Gets a copy of a Joystick Map.
This can be used to view the Controller Map saved in user data if available or the default Controller Map setup in the Rewired Input Manager.
The Controller Map will be first loaded from UserDataStore. If none is found, it will be loaded from the Rewired Input Manager defaults.
UserDataStore must implement IControllerMapStore or data cannot be loaded from saved user data.
|
| GetKeyboardLayout(Int32) |
Gets a keyboard layout
|
| GetKeyboardLayout(String) |
Gets a keyboard layout
|
| GetKeyboardLayoutId |
Gets the id of a keyboard layout
|
| GetKeyboardMapInstance(Int32, Int32) |
Gets a copy of a Keyboard Map.
This can be used to view the default Keyboard Map setup in the Rewired Input Manager.
|
| GetKeyboardMapInstance(String, String) |
Gets a copy of a Keyboard Map.
This can be used to view the default Keyboard Map setup in the Rewired Input Manager.
|
| GetKeyboardMapInstanceSavedOrDefault(Int32, Int32, Int32) |
Gets a copy of a Keyboard Map.
This can be used to view the Controller Map saved in user data if available or the default Controller Map setup in the Rewired Input Manager.
The Controller Map will be first loaded from UserDataStore. If none is found, it will be loaded from the Rewired Input Manager defaults.
UserDataStore must implement IControllerMapStore or data cannot be loaded from saved user data.
|
| GetKeyboardMapInstanceSavedOrDefault(Int32, String, String) |
Gets a copy of a Keyboard Map.
This can be used to view the Controller Map saved in user data if available or the default Controller Map setup in the Rewired Input Manager.
The Controller Map will be first loaded from UserDataStore. If none is found, it will be loaded from the Rewired Input Manager defaults.
UserDataStore must implement IControllerMapStore or data cannot be loaded from saved user data.
|
| GetLayout(ControllerType, Int32) |
Gets a layout by specifying the controller type and layout id
|
| GetLayout(ControllerType, String) |
Gets a layout by specifying the controller type and layout name
|
| GetLayoutId |
Gets id of a layout by controller type
|
| GetMapCategory(Int32) |
Gets a specific map category
|
| GetMapCategory(String) |
Gets a specific map category
|
| GetMapCategoryId |
Gets id of a specific map category
|
| GetMouseLayout(Int32) |
Get a mouse layout
|
| GetMouseLayout(String) |
Gets a mouse layout
|
| GetMouseLayoutId |
Gets the id of a mouse layout
|
| GetMouseMapInstance(Int32, Int32) |
Gets a copy of a Mouse Map.
This can be used to view the default Mouse Map setup in the Rewired Input Manager.
|
| GetMouseMapInstance(String, String) |
Gets a copy of a Mouse Map.
This can be used to view the default Mouse Map setup in the Rewired Input Manager.
|
| GetMouseMapInstanceSavedOrDefault(Int32, Int32, Int32) |
Gets a copy of a Mouse Map.
This can be used to view the Controller Map saved in user data if available or the default Controller Map setup in the Rewired Input Manager.
The Controller Map will be first loaded from UserDataStore. If none is found, it will be loaded from the Rewired Input Manager defaults.
UserDataStore must implement IControllerMapStore or data cannot be loaded from saved user data.
|
| GetMouseMapInstanceSavedOrDefault(Int32, String, String) |
Gets a copy of a Mouse Map.
This can be used to view the Controller Map saved in user data if available or the default Controller Map setup in the Rewired Input Manager.
The Controller Map will be first loaded from UserDataStore. If none is found, it will be loaded from the Rewired Input Manager defaults.
UserDataStore must implement IControllerMapStore or data cannot be loaded from saved user data.
|
| GetSystemPlayerInputBehavior(Int32) |
Gets a specific input behavior from the System player
|
| GetSystemPlayerInputBehavior(String) |
Gets a specific input behavior from the System player
|
| GetSystemPlayerInputBehaviors |
Gets a list of input behaviors from the system player
|
| IsActionCategoryUserAssignable |
Is the specified action category user-assignable?
|
| IsMapCategoryUserAssignable |
Is the specified map category user assignable?
|
| MapCategoriesWithTag |
Enumerates all map categories with matching tag
|
| MapLayouts |
Gets a list of all map layouts for the specified controller type
|
| UserAssignableActionCategoriesWithTag |
Enumerates all user-assignable action categories with matching tag
|
| UserAssignableActionsInCategory(Int32) |
Enumerates all user-assignable actions in a specific category
|
| UserAssignableActionsInCategory(String) |
Enumerates all user-assignable actions in a specific category
|
| UserAssignableActionsInCategory(Int32, Boolean) |
Enumerates all user-assignable actions in a specific category
|
| UserAssignableActionsInCategory(String, Boolean) |
Enumerates all user-assignable actions in a specific category
|
| UserAssignableMapCategoriesWithTag |
Enumerates all user-assignable map categories with matching tag
|
See Also