Controller |
The base class for all controller maps. Maps actions to specific controller elements.
Inheritance HierarchyNamespace: Rewired
Assembly: Rewired_Core (in Rewired_Core.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
public abstract class ControllerMap
The ControllerMap type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ControllerMap | Initializes a new instance of the ControllerMap class |
| ControllerMap(ControllerMap) | Initializes a new instance of the ControllerMap class |
Properties| Name | Description | |
|---|---|---|
 | AllMaps | Gets all ActionElementMaps in this controller map. |
| buttonMapCount | The count of all Button ActionElementMaps contained in this controller map. |
| ButtonMaps | Gets all Button ActionElementMaps in this controller map. |
| categoryId | The id of the Map Category of this controller map. |
| controller | The controller this controller map applies to. |
| controllerId | The id of the controller this controller map applies to. |
| controllerType | The type of controller this controller map applies to. |
| elementMapCount | The count of all ActionElementMaps contained in this controller map. |
| ElementMaps | Gets all ActionElementMaps in this controller map. Alias for AllMaps. |
| enabled | Is the controller map enabled? Disabled maps will never return input values for the ActionElementMaps contained within. |
| hardwareGuid | The GUID of the controller definition this map is for. This GUID corresponds to the Rewired HardwareJoystickMap controller definition and can be used to identify recognized controller types. This will always be Guid.Empty for Unknown Controllers. |
| id | The unique id of this controller map. This value is not consistent between game sessions, so do not store it. |
| isModified | Determines if the Controller Map has been modified since it was created. If this is manually set to true, modifiedTime will also be set to the current time. |
| layoutId | The id of the Layout of this controller map. |
| modifiedTime | The last time the Controller Map was modified since it was created. Returns 0 if the Controller Map was not modified or if isModified was set to false. |
| name | The name of this controller map. (This is currently unused and will always be blank.) |
| player | The parent Player that owns this controller map. |
| playerId | The id of the Player that owns this controller map. |
| sourceMapId | The id of the original source ControllerMap from the Rewired Input Manager. This is only valid for maps loaded from the Rewired Input Manager on start, not maps loaded via XML or created at runtime. |
Methods| Name | Description | |
|---|---|---|
| ButtonMapsWithAction(Int32) | Enumarates all Button ActionElementMaps in this controller map that contain a specific Action. |
| ButtonMapsWithAction(String) | Enumarates all Axis ActionElementMaps in this controller map that contain a specific Action. |
| ButtonMapsWithAction(Int32, Boolean) | Enumarates all Button ActionElementMaps in this controller map that contain a specific Action. |
| ButtonMapsWithAction(String, Boolean) | Enumarates all Axis ActionElementMaps in this controller map that contain a specific Action. |
| ClearElementMaps | Deletes all ActionElementMaps in this controller map. |
| ContainsAction(Int32) | Does this controller map contain any ActionElementMaps that are bound to a particular Action? |
| ContainsAction(String) | Does this controller map contain any ActionElementMaps that are bound to a particular Action? |
| ContainsElementIdentifier | Does this controller map contain any ActionElementMaps that are bound to a particular Element Identifier Id? |
| ContainsElementMap(ActionElementMap) | Does this controller map contain the ActionElementMap? |
| ContainsElementMap(Int32) | Does this controller map contain the ActionElementMap with the specific id? |
| ContainsKeyboardKey | Does this controller map contain any ActionElementMaps that are bound to a particular keyboard key? |
 | Create | Creates a Controller Map for the specified Controller. |
| CreateElementMap(ElementAssignment) | Creates an ActionElementMap in this controller map based on the data in elementAssignment. |
| CreateElementMap(ElementAssignment, ActionElementMap) | Creates an ActionElementMap in this controller map based on the data in elementAssignment. |
| CreateElementMap(Int32, Pole, KeyCode, ModifierKeyFlags) | Creates an ActionElementMap in this controller map for a keyboard key assignment. |
| CreateElementMap(Int32, Pole, KeyCode, ModifierKeyFlags, ActionElementMap) | Creates an ActionElementMap in this controller map for a keyboard key assignment. |
| CreateElementMap(Int32, Pole, Int32, ControllerElementType, AxisRange, Boolean) | Creates an ActionElementMap in this controller map for a controller button or axis assignment. |
| CreateElementMap(Int32, Pole, KeyCode, ModifierKey, ModifierKey, ModifierKey) | Creates an ActionElementMap in this controller map for a keyboard key assignment. |
| CreateElementMap(Int32, Pole, Int32, ControllerElementType, AxisRange, Boolean, ActionElementMap) | Creates an ActionElementMap in this controller map for a controller button or axis assignment. |
| CreateElementMap(Int32, Pole, KeyCode, ModifierKey, ModifierKey, ModifierKey, ActionElementMap) | Creates an ActionElementMap in this controller map for a keyboard key assignment. |
| CreateFromJson | |
| CreateFromXml | |
| DeleteButtonMapsWithAction(Int32) | Deletes all Button ActionElementMap from the controller map that contain a specific Action. |
| DeleteButtonMapsWithAction(String) | Deletes all Button ActionElementMap from the controller map that contain a specific Action. |
| DeleteElementMap | Deletes the ActionElementMap from the controller map. |
| DeleteElementMapsWithAction(Int32) | Deletes all ActionElementMap from the controller map that contain a specific Action. |
| DeleteElementMapsWithAction(String) | Deletes all ActionElementMap from the controller map that contain a specific Action. |
| DisableElementAssignmentConflicts(ActionElementMap) | Disables any ActionElementMaps in this controller map that conflict with the incoming ActionElementMap. |
| DisableElementAssignmentConflicts(ControllerMap) | Disables any ActionElementMaps in this controller map that conflict with the incoming controller map. |
| DisableElementAssignmentConflicts(ElementAssignmentConflictCheck) | Disables any ActionElementMaps in this controller map that conflict with the potential assignment contained in the ElementAssignmentConflictCheck. |
| DisableElementAssignmentConflicts(ActionElementMap, Boolean) | Disables any ActionElementMaps in this controller map that conflict with the incoming ActionElementMap. |
| DisableElementAssignmentConflicts(ControllerMap, Boolean) | Disables any ActionElementMaps in this controller map that conflict with the incoming controller map. |
| DisableElementAssignmentConflicts(ElementAssignmentConflictCheck, Boolean) | Disables any ActionElementMaps in this controller map that conflict with the potential assignment contained in the ElementAssignmentConflictCheck. |
| DoesElementAssignmentConflict(ActionElementMap) | Determines if any element assignments conflict between the this controller map and the incoming ActionElementMap. |
| DoesElementAssignmentConflict(ControllerMap) | Determines if any element assignments conflict between this controller map and the incoming controller map. |
| DoesElementAssignmentConflict(ElementAssignmentConflictCheck) | Determines if any element assignments conflict between this controller map and the potential assignment contained in the ElementAssignmentConflictCheck. |
| DoesElementAssignmentConflict(ActionElementMap, Boolean) | Determines if any element assignments conflict between the this controller map and the incoming ActionElementMap. |
| DoesElementAssignmentConflict(ControllerMap, Boolean) | Determines if any element assignments conflict between this controller map and the incoming controller map. |
| DoesElementAssignmentConflict(ElementAssignmentConflictCheck, Boolean) | Determines if any element assignments conflict between this controller map and the potential assignment contained in the ElementAssignmentConflictCheck. |
| ElementAssignmentConflicts(ActionElementMap) | Enumerates all assignment conflicts between the this controller map and the incoming ActionElementMap. |
| ElementAssignmentConflicts(ControllerMap) | Enumerates all assignment conflicts between this controller map and the incoming controller map. |
| ElementAssignmentConflicts(ElementAssignmentConflictCheck) | Enumerates all assignment conflicts between this controller map and the potential assignment contained in the ElementAssignmentConflictCheck. |
| ElementAssignmentConflicts(ActionElementMap, Boolean) | Enumerates all assignment conflicts between the this controller map and the incoming ActionElementMap. |
| ElementAssignmentConflicts(ControllerMap, Boolean) | Enumerates all assignment conflicts between this controller map and the incoming controller map. |
| ElementAssignmentConflicts(ElementAssignmentConflictCheck, Boolean) | Enumerates all assignment conflicts between this controller map and the potential assignment contained in the ElementAssignmentConflictCheck. |
| ElementMapsWithAction(Int32) | Enumarates all ActionElementMaps in this controller map that contain a specific Action. |
| ElementMapsWithAction(String) | Enumarates all ActionElementMaps in this controller map that contain a specific Action. |
| ElementMapsWithAction(Int32, Boolean) | Enumarates all ActionElementMaps in this controller map that contain a specific Action. |
| ElementMapsWithAction(String, Boolean) | Enumarates all ActionElementMaps in this controller map that contain a specific Action. |
| ElementMapsWithElementTarget(ControllerElementTarget, Boolean) | Enumarates all ActionElementMaps that map to a specific controller element target. |
| ElementMapsWithElementTarget(IControllerElementTarget, Boolean) | Enumarates all ActionElementMaps that map to a specific controller element target. |
| ElementMapsWithElementTarget(ControllerElementTarget, Int32, Boolean) | Enumarates all ActionElementMaps that map to a specific controller element target and a specific Action. |
| ElementMapsWithElementTarget(ControllerElementTarget, String, Boolean) | Enumarates all ActionElementMaps that map to a specific controller element target and a specific Action. |
| ElementMapsWithElementTarget(IControllerElementTarget, Int32, Boolean) | Enumarates all ActionElementMaps that map to a specific controller element target and a specific Action. |
| ElementMapsWithElementTarget(IControllerElementTarget, String, Boolean) | Enumarates all ActionElementMaps that map to a specific controller element target and a specific Action. |
| ForEachButtonMapMatch | Invokes the action on each Button Map that matches the conditions defined by specified predicate. |
| ForEachElementAssignmentConflict(ActionElementMap, ActionActionElementMap) | Invokes the specified action on all ActionElementMaps in this controller map that conflict with the incoming ActionElementMap. |
| ForEachElementAssignmentConflict(ControllerMap, ActionActionElementMap) | Invokes the specified action on all ActionElementMaps in this controller map that conflict with the incoming controller map. |
| ForEachElementAssignmentConflict(ElementAssignmentConflictCheck, ActionActionElementMap) | Invokes the specified action on all ActionElementMaps in this controller map that conflict with the potential assignment contained in the ElementAssignmentConflictCheck. |
| ForEachElementAssignmentConflict(ActionElementMap, ActionActionElementMap, Boolean) | Invokes the specified action on all ActionElementMaps in this controller map that conflict with the incoming ActionElementMap. |
| ForEachElementAssignmentConflict(ControllerMap, ActionActionElementMap, Boolean) | Invokes the specified action on all ActionElementMaps in this controller map that conflict with the incoming controller map. |
| ForEachElementAssignmentConflict(ElementAssignmentConflictCheck, ActionActionElementMap, Boolean) | Invokes the specified action on all ActionElementMaps in this controller map that conflict with the potential assignment contained in the ElementAssignmentConflictCheck. |
| ForEachElementMapMatch | Invokes the action on each Action Element Map of any type that matches the conditions defined by specified predicate. |
| GetButtonMap | Gets the Button ActionElementMap at a specific index.. |
| GetButtonMapMatches | Finds all Button Maps that match the conditions defined by the specified predicate. |
| GetButtonMaps | Gets all Button ActionElementMaps in this controller map. Warning: Calling this allocates memory. Use ButtonMaps instead. |
| GetButtonMaps(Boolean) | Gets all Button ActionElementMaps in this controller map. Warning: Calling this allocates memory. Use GetButtonMaps(Boolean, ListActionElementMap) instead. |
| GetButtonMaps(Boolean, ListActionElementMap) | Gets all Button ActionElementMaps in this controller map. |
| GetButtonMapsWithAction(Int32) | Gets all Button ActionElementMaps in this controller map that contain a specific Action. Warning: Calling this allocates memory. Use GetButtonMapsWithAction(Int32, ListActionElementMap) instead. |
| GetButtonMapsWithAction(String) | Gets all Button ActionElementMaps in this controller map that contain a specific Action. Warning: Calling this allocates memory. Use GetButtonMapsWithAction(String, ListActionElementMap) instead. |
| GetButtonMapsWithAction(Int32, Boolean) | Gets all Button ActionElementMaps in this controller map that contain a specific Action. Warning: Calling this allocates memory. Use GetButtonMapsWithAction(Int32, Boolean, ListActionElementMap) instead. |
| GetButtonMapsWithAction(Int32, ListActionElementMap) | Gets all Button ActionElementMaps in this controller map that contain a specific Action. |
| GetButtonMapsWithAction(String, Boolean) | Gets all Button ActionElementMaps in this controller map that contain a specific Action. Warning: Calling this allocates memory. Use GetButtonMapsWithAction(String, Boolean, ListActionElementMap) instead. |
| GetButtonMapsWithAction(String, ListActionElementMap) | Gets all Button ActionElementMaps in this controller map that contain a specific Action. |
| GetButtonMapsWithAction(Int32, Boolean, ListActionElementMap) | Gets all Button ActionElementMaps in this controller map that contain a specific Action. |
| GetButtonMapsWithAction(String, Boolean, ListActionElementMap) | Gets all Button ActionElementMaps in this controller map that contain a specific Action. |
| GetButtonNames | Gets the element identifier names in all button maps. Warning: Calling this allocates memory. |
| GetElementMap | Gets the ActionElementMap that matches the id. |
| GetElementMapMatches | Finds all Action Element Maps of any kind that match the conditions defined by the specified predicate. |
| GetElementMaps | Gets all ActionElementMaps in this controller map. Warning: Calling this allocates memory. Use AllMaps instead. |
| GetElementMaps(Boolean) | Gets all ActionElementMaps in this controller map. Warning: Calling this allocates memory. Use GetElementMaps(Boolean, ListActionElementMap) instead. |
| GetElementMaps(ListActionElementMap) | Gets all ActionElementMaps in this controller map. |
| GetElementMaps(Boolean, ListActionElementMap) | Gets all ActionElementMaps in this controller map. |
| GetElementMapsWithAction(Int32) | Gets all ActionElementMaps in this controller map that contain a specific Action. Warning: Calling this allocates memory. Use GetElementMapsWithAction(Int32, ListActionElementMap) instead. |
| GetElementMapsWithAction(String) | Gets all ActionElementMaps in this controller map that contain a specific Action. Warning: Calling this allocates memory. Use GetElementMapsWithAction(String, ListActionElementMap) instead. |
| GetElementMapsWithAction(Int32, Boolean) | Gets all ActionElementMaps in this controller map that contain a specific Action. Warning: Calling this allocates memory. Use GetElementMapsWithAction(Int32, Boolean, ListActionElementMap) instead. |
| GetElementMapsWithAction(Int32, ListActionElementMap) | Gets all ActionElementMaps in this controller map that contain a specific Action. |
| GetElementMapsWithAction(String, Boolean) | Gets all ActionElementMaps in this controller map that contain a specific Action. Warning: Calling this allocates memory. Use GetElementMapsWithAction(String, Boolean, ListActionElementMap) instead. |
| GetElementMapsWithAction(String, ListActionElementMap) | Gets all ActionElementMaps in this controller map that contain a specific Action. |
| GetElementMapsWithAction(Int32, Boolean, ListActionElementMap) | Gets all ActionElementMaps in this controller map that contain a specific Action. |
| GetElementMapsWithAction(String, Boolean, ListActionElementMap) | Gets all ActionElementMaps in this controller map that contain a specific Action. |
| GetElementMapsWithElementTarget(ControllerElementTarget, Boolean, ListActionElementMap) | Gets all ActionElementMaps that map to a specific controller element target. |
| GetElementMapsWithElementTarget(IControllerElementTarget, Boolean, ListActionElementMap) | Gets all ActionElementMaps that map to a specific controller element target. |
| GetElementMapsWithElementTarget(ControllerElementTarget, Int32, Boolean, ListActionElementMap) | Gets all ActionElementMaps that map to a specific controller element target and a specific Action. |
| GetElementMapsWithElementTarget(ControllerElementTarget, String, Boolean, ListActionElementMap) | Gets all ActionElementMaps that map to a specific controller element target and a specific Action. |
| GetElementMapsWithElementTarget(IControllerElementTarget, Int32, Boolean, ListActionElementMap) | Gets all ActionElementMaps that map to a specific controller element target and a specific Action. |
| GetElementMapsWithElementTarget(IControllerElementTarget, String, Boolean, ListActionElementMap) | Gets all ActionElementMaps that map to a specific controller element target and a specific Action. |
| GetFirstButtonMapMatch | Finds the first Button Map that matches the conditions defined by the specified predicate. |
| GetFirstButtonMapWithAction(Int32) | Gets the first Button ActionElementMap found in this controller that contains a specific Action. |
| GetFirstButtonMapWithAction(String) | Gets the first Button ActionElementMap found in this controller that contains a specific Action. |
| GetFirstButtonMapWithAction(Int32, Boolean) | Gets the first Button ActionElementMap found in this controller that contains a specific Action. |
| GetFirstButtonMapWithAction(String, Boolean) | Gets the first Button ActionElementMap found in this controller that contains a specific Action. |
| GetFirstElementMapMatch | Finds the first Action Element Map of any kind that matches the conditions defined by the specified predicate. |
| GetFirstElementMapWithAction(Int32) | Gets the first ActionElementMap found in this controller that contains a specific Action. |
| GetFirstElementMapWithAction(String) | Gets the first ActionElementMap found in this controller that contains a specific Action. |
| GetFirstElementMapWithAction(Int32, Boolean) | Gets the first ActionElementMap found in this controller that contains a specific Action. |
| GetFirstElementMapWithAction(String, Boolean) | Gets the first ActionElementMap found in this controller that contains a specific Action. |
| GetFirstElementMapWithElementTarget(ControllerElementTarget, Boolean) | Gets the first ActionElementMap found that maps to a specific controller element target. |
| GetFirstElementMapWithElementTarget(IControllerElementTarget, Boolean) | Gets the first ActionElementMap found that maps to a specific controller element target. |
| GetFirstElementMapWithElementTarget(ControllerElementTarget, Int32, Boolean) | Gets the first ActionElementMap found that maps to a specific controller element target and a specific Action. |
| GetFirstElementMapWithElementTarget(ControllerElementTarget, String, Boolean) | Gets the first ActionElementMap found that maps to a specific controller element target and a specific Action. |
| GetFirstElementMapWithElementTarget(IControllerElementTarget, Int32, Boolean) | Gets the first ActionElementMap found that maps to a specific controller element target and a specific Action. |
| GetFirstElementMapWithElementTarget(IControllerElementTarget, String, Boolean) | Gets the first ActionElementMap found that maps to a specific controller element target and a specific Action. |
| RemoveElementAssignmentConflicts(ActionElementMap) | Deletes any ActionElementMaps in this controller map that conflict with the incoming ActionElementMap. |
| RemoveElementAssignmentConflicts(ControllerMap) | Deletes any ActionElementMaps in this controller map that conflict with the incoming controller map. |
| RemoveElementAssignmentConflicts(ElementAssignmentConflictCheck) | Deletes any ActionElementMaps in this controller map that conflict with the potential assignment contained in the ElementAssignmentConflictCheck. |
| RemoveElementAssignmentConflicts(ActionElementMap, Boolean) | Deletes any ActionElementMaps in this controller map that conflict with the incoming ActionElementMap. |
| RemoveElementAssignmentConflicts(ControllerMap, Boolean) | Deletes any ActionElementMaps in this controller map that conflict with the incoming controller map. |
| RemoveElementAssignmentConflicts(ElementAssignmentConflictCheck, Boolean) | Deletes any ActionElementMaps in this controller map that conflict with the potential assignment contained in the ElementAssignmentConflictCheck. |
| ReplaceElementMap(ElementAssignment) | Replaces an existing ActionElementMap with a new assignment. ElementAssignment.elementMapId must be set to the ActionElementMap.id of the assignment to replace if replacing. If no matching ActionElementMap is found, it will return false. |
| ReplaceElementMap(ElementAssignment, ActionElementMap) | Replaces an existing ActionElementMap with a new assignment. ElementAssignment.elementMapId must be set to the ActionElementMap.id of the assignment to replace if replacing. If no matching ActionElementMap is found, it will return false. |
| ReplaceElementMap(Int32, Int32, Pole, KeyCode, ModifierKeyFlags) | Replaces an ActionElementMap in this controller map with a new keyboard key assignment. If the ActionElementMap is not found in this controller map, a new ActionElementMap will not be created. |
| ReplaceElementMap(Int32, Int32, Pole, KeyCode, ModifierKeyFlags, ActionElementMap) | Replaces an ActionElementMap in this controller map with a new keyboard key assignment. If the ActionElementMap is not found in this controller map, a new ActionElementMap will not be created. |
| ReplaceElementMap(Int32, Int32, Pole, Int32, ControllerElementType, AxisRange, Boolean) | Replaces an ActionElementMap in this controller map with a new button or axis assignment. If the ActionElementMap is not found in this controller map, a new ActionElementMap will not be created. |
| ReplaceElementMap(Int32, Int32, Pole, KeyCode, ModifierKey, ModifierKey, ModifierKey) | Replaces an ActionElementMap in this controller map with a new keyboard key assignment. If the ActionElementMap is not found in this controller map, a new ActionElementMap will not be created. |
| ReplaceElementMap(Int32, Int32, Pole, Int32, ControllerElementType, AxisRange, Boolean, ActionElementMap) | Replaces an ActionElementMap in this controller map with a new button or axis assignment. If the ActionElementMap is not found in this controller map, a new ActionElementMap will not be created. |
| ReplaceElementMap(Int32, Int32, Pole, KeyCode, ModifierKey, ModifierKey, ModifierKey, ActionElementMap) | Replaces an ActionElementMap in this controller map with a new keyboard key assignment. If the ActionElementMap is not found in this controller map, a new ActionElementMap will not be created. |
| ReplaceOrCreateElementMap(ElementAssignment) | Replaces an existing ActionElementMap with a new assignment. ElementAssignment.elementMapId must be set to the ActionElementMap.id of the assignment to replace if replacing. If no ActionElementMap is found matching that id, a new ActionElementMap will be created instead. |
| ReplaceOrCreateElementMap(ElementAssignment, ActionElementMap) | Replaces an existing ActionElementMap with a new assignment. ElementAssignment.elementMapId must be set to the ActionElementMap.id of the assignment to replace if replacing. If no ActionElementMap is found matching that id, a new ActionElementMap will be created instead. |
| SetAllButtonMapsEnabled | Sets the enabled state on all Button Maps. |
| SetAllElementMapsEnabled | Sets the enabled state on all Action Element Maps. |
| ToControllerTemplateMap(Guid) | Converts the Controller Map to a Controller Template Map. |
| ToControllerTemplateMap(Type) | Converts the Controller Map to a Controller Template Map. |
| ToControllerTemplateMapT | Converts the Controller Map to a Controller Template Map. |
| ToJsonString | Exports the map to a JSON string. |
| ToXmlString | Exports the map to an XML string. |
See Also