Click or drag to resize

MappingHelper Methods

The ReInputMappingHelper type exposes the following members.

Methods
  NameDescription
Public methodActionCategoriesWithTag
Enumerates all action categories with matching tag
Public methodActionsInCategoriesWithTag
Enumerates all actions with a tag
Public methodActionsInCategory(Int32)
Enumerates all actions in a specific category
Public methodActionsInCategory(String)
Enumerates all actions in a specific category
Public methodActionsInCategory(Int32, Boolean)
Enumerates all actions in a specific category
Public methodActionsInCategory(String, Boolean)
Enumerates all actions in a specific category
Public methodGetAction(Int32)
Gets a specific action
Public methodGetAction(String)
Gets a specific action
Public methodGetActionCategory(Int32)
Gets a specific action category
Public methodGetActionCategory(String)
Gets a specific action category
Public methodGetActionCategoryId
Gets the id of a specific action category
Public methodGetActionElementMap
Gets the Action Element Map with the specified id from existing Action Element Maps in all Players.
Public methodGetActionId
Gets the id of a specific action
Public methodGetControllerMap
Gets the Controller Map with the specified id from existing Controller Maps loaded in all Players.
Public methodGetControllerMapEnablerRuleSetInstance(Int32)
Gets a copy of the Controller Map Enabler Rule Set at the specified id.
Public methodGetControllerMapEnablerRuleSetInstance(String)
Gets a copy of the Controller Map Enabler Rule Set with the specified name.
Public methodGetControllerMapInstance(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.
Public methodGetControllerMapInstance(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.
Public methodGetControllerMapInstance(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.
Public methodGetControllerMapInstance(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.
Public methodGetControllerMapInstanceSavedOrDefault(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.
Public methodGetControllerMapInstanceSavedOrDefault(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.
Public methodGetControllerMapInstanceSavedOrDefault(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.
Public methodGetControllerMapInstanceSavedOrDefault(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.
Public methodGetControllerMapLayoutManagerRuleSetInstance(Int32)
Gets a copy of the Controller Map Layout Manager Rule Set at the specified id.
Public methodGetControllerMapLayoutManagerRuleSetInstance(String)
Gets a copy of the Controller Map Layout Manager Rule Set with the specified name.
Public methodGetControllerTemplateMapInstance(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.
Public methodGetControllerTemplateMapInstance(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.
Public methodGetCustomControllerLayout(Int32)
Gets a custom controller layout
Public methodGetCustomControllerLayout(String)
Gets a custom controller layout
Public methodGetCustomControllerLayoutId
Gets the id of a custom controller layout
Public methodGetCustomControllerMapInstance(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.
Public methodGetCustomControllerMapInstance(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.
Public methodGetCustomControllerMapInstance(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.
Public methodGetCustomControllerMapInstance(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.
Public methodGetCustomControllerMapInstanceSavedOrDefault(Int32, ControllerIdentifier, Int32, Int32)
Public methodGetCustomControllerMapInstanceSavedOrDefault(Int32, ControllerIdentifier, String, String)
Public methodGetCustomControllerMapInstanceSavedOrDefault(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.
Public methodGetCustomControllerMapInstanceSavedOrDefault(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.
Public methodGetFirstJoystickTemplateElementIdentifier 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.
Public methodGetInputBehavior(Int32, Int32)
Gets a specific input behavior from a specific player
Public methodGetInputBehavior(Int32, String)
Gets a specific input behavior from a specific player
Public methodGetInputBehaviorId
Gets the id of a specific input behavior
Public methodGetInputBehaviors
Gets a list of input behaviors from a specific player
Public methodGetJoystickLayout(Int32)
Gets a joystick layout
Public methodGetJoystickLayout(String)
Gets a joystick layout
Public methodGetJoystickLayoutId
Gets the id of a joystick layout
Public methodGetJoystickMapInstance(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.
Public methodGetJoystickMapInstance(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.
Public methodGetJoystickMapInstance(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.
Public methodGetJoystickMapInstance(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.
Public methodGetJoystickMapInstance(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.
Public methodGetJoystickMapInstance(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.
Public methodGetJoystickMapInstanceSavedOrDefault(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.
Public methodGetJoystickMapInstanceSavedOrDefault(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.
Public methodGetJoystickMapInstanceSavedOrDefault(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.
Public methodGetJoystickMapInstanceSavedOrDefault(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.
Public methodGetKeyboardLayout(Int32)
Gets a keyboard layout
Public methodGetKeyboardLayout(String)
Gets a keyboard layout
Public methodGetKeyboardLayoutId
Gets the id of a keyboard layout
Public methodGetKeyboardMapInstance(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.
Public methodGetKeyboardMapInstance(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.
Public methodGetKeyboardMapInstanceSavedOrDefault(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.
Public methodGetKeyboardMapInstanceSavedOrDefault(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.
Public methodGetLayout(ControllerType, Int32)
Gets a layout by specifying the controller type and layout id
Public methodGetLayout(ControllerType, String)
Gets a layout by specifying the controller type and layout name
Public methodGetLayoutId
Gets id of a layout by controller type
Public methodGetMapCategory(Int32)
Gets a specific map category
Public methodGetMapCategory(String)
Gets a specific map category
Public methodGetMapCategoryId
Gets id of a specific map category
Public methodGetMouseLayout(Int32)
Get a mouse layout
Public methodGetMouseLayout(String)
Gets a mouse layout
Public methodGetMouseLayoutId
Gets the id of a mouse layout
Public methodGetMouseMapInstance(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.
Public methodGetMouseMapInstance(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.
Public methodGetMouseMapInstanceSavedOrDefault(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.
Public methodGetMouseMapInstanceSavedOrDefault(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.
Public methodGetSystemPlayerInputBehavior(Int32)
Gets a specific input behavior from the System player
Public methodGetSystemPlayerInputBehavior(String)
Gets a specific input behavior from the System player
Public methodGetSystemPlayerInputBehaviors
Gets a list of input behaviors from the system player
Public methodIsActionCategoryUserAssignable
Is the specified action category user-assignable?
Public methodIsMapCategoryUserAssignable
Is the specified map category user assignable?
Public methodMapCategoriesWithTag
Enumerates all map categories with matching tag
Public methodMapLayouts
Gets a list of all map layouts for the specified controller type
Public methodUserAssignableActionCategoriesWithTag
Enumerates all user-assignable action categories with matching tag
Public methodUserAssignableActionsInCategory(Int32)
Enumerates all user-assignable actions in a specific category
Public methodUserAssignableActionsInCategory(String)
Enumerates all user-assignable actions in a specific category
Public methodUserAssignableActionsInCategory(Int32, Boolean)
Enumerates all user-assignable actions in a specific category
Public methodUserAssignableActionsInCategory(String, Boolean)
Enumerates all user-assignable actions in a specific category
Public methodUserAssignableMapCategoriesWithTag
Enumerates all user-assignable map categories with matching tag
Top
See Also