Click or drag to resize

ControllerMap Class

The base class for all controller maps. Maps actions to specific controller elements.
Inheritance Hierarchy

Namespace:  Rewired
Assembly:  Rewired_Core (in Rewired_Core.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
C#
public abstract class ControllerMap

The ControllerMap type exposes the following members.

Constructors
  NameDescription
Public methodControllerMap
Initializes a new instance of the ControllerMap class
Public methodControllerMap(ControllerMap)
Initializes a new instance of the ControllerMap class
Top
Properties
  NameDescription
Public propertyAllMaps
Gets all ActionElementMaps in this controller map.
Public propertybuttonMapCount
The count of all Button ActionElementMaps contained in this controller map.
Public propertyButtonMaps
Gets all Button ActionElementMaps in this controller map.
Public propertycategoryId
The id of the Map Category of this controller map.
Public propertycontroller
The controller this controller map applies to.
Public propertycontrollerId
The id of the controller this controller map applies to.
Public propertycontrollerType
The type of controller this controller map applies to.
Public propertyelementMapCount
The count of all ActionElementMaps contained in this controller map.
Public propertyenabled
Is the controller map enabled? Disabled maps will never return input values for the ActionElementMaps contained within.
Public propertyhardwareGuid
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.
Public propertyid
The unique id of this controller map. This value is not consistent between game sessions, so do not store it.
Public propertylayoutId
The id of the Layout of this controller map.
Public propertyname
The name of this controller map. (This is currently unused and will always be blank.)
Public propertyplayer
The parent Player that owns this controller map.
Public propertyplayerId
The id of the Player that owns this controller map.
Public propertysourceMapId
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.
Top
Methods
  NameDescription
Public methodButtonMapsWithAction(Int32)
Enumarates all Button ActionElementMaps in this controller map that contain a specific Action.
Public methodButtonMapsWithAction(String)
Enumarates all Axis ActionElementMaps in this controller map that contain a specific Action.
Public methodButtonMapsWithAction(Int32, Boolean)
Enumarates all Button ActionElementMaps in this controller map that contain a specific Action.
Public methodButtonMapsWithAction(String, Boolean)
Enumarates all Axis ActionElementMaps in this controller map that contain a specific Action.
Public methodClearElementMaps
Deletes all ActionElementMaps in this controller map.
Public methodContainsAction(Int32)
Does this controller map contain any ActionElementMaps that are bound to a particular Action?
Public methodContainsAction(String)
Does this controller map contain any ActionElementMaps that are bound to a particular Action?
Public methodContainsElementIdentifier
Does this controller map contain any ActionElementMaps that are bound to a particular Element Identifier Id?
Public methodContainsElementMap(Int32)
Does this controller map contain the ActionElementMap with the specific id?
Public methodContainsElementMap(ActionElementMap)
Does this controller map contain the ActionElementMap?
Public methodContainsKeyboardKey
Does this controller map contain any ActionElementMaps that are bound to a particular keyboard key?
Public methodCreateElementMap(ElementAssignment)
Creates an ActionElementMap in this controller map based on the data in elementAssignment.
Public methodCreateElementMap(ElementAssignment, ActionElementMap)
Creates an ActionElementMap in this controller map based on the data in elementAssignment.
Public methodCreateElementMap(Int32, Pole, KeyCode, ModifierKeyFlags)
Creates an ActionElementMap in this controller map for a keyboard key assignment.
Public methodCreateElementMap(Int32, Pole, KeyCode, ModifierKeyFlags, ActionElementMap)
Creates an ActionElementMap in this controller map for a keyboard key assignment.
Public methodCreateElementMap(Int32, Pole, Int32, ControllerElementType, AxisRange, Boolean)
Creates an ActionElementMap in this controller map for a controller button or axis assignment.
Public methodCreateElementMap(Int32, Pole, KeyCode, ModifierKey, ModifierKey, ModifierKey)
Creates an ActionElementMap in this controller map for a keyboard key assignment.
Public methodCreateElementMap(Int32, Pole, Int32, ControllerElementType, AxisRange, Boolean, ActionElementMap)
Creates an ActionElementMap in this controller map for a controller button or axis assignment.
Public methodCreateElementMap(Int32, Pole, KeyCode, ModifierKey, ModifierKey, ModifierKey, ActionElementMap)
Creates an ActionElementMap in this controller map for a keyboard key assignment.
Public methodStatic memberCreateFromXml
Public methodDeleteButtonMapsWithAction(Int32)
Deletes all Button ActionElementMap from the controller map that contain a specific Action.
Public methodDeleteButtonMapsWithAction(String)
Deletes all Button ActionElementMap from the controller map that contain a specific Action.
Public methodDeleteElementMap
Deletes the ActionElementMap from the controller map.
Public methodDeleteElementMapsWithAction(Int32)
Deletes all ActionElementMap from the controller map that contain a specific Action.
Public methodDeleteElementMapsWithAction(String)
Deletes all ActionElementMap from the controller map that contain a specific Action.
Public methodDisableElementAssignmentConflicts(ActionElementMap)
Disables any ActionElementMaps in this controller map that conflict with the incoming ActionElementMap.
Public methodDisableElementAssignmentConflicts(ControllerMap)
Disables any ActionElementMaps in this controller map that conflict with the incoming controller map.
Public methodDisableElementAssignmentConflicts(ElementAssignmentConflictCheck)
Disables any ActionElementMaps in this controller map that conflict with the potential assignment contained in the ElementAssignmentConflictCheck.
Public methodDisableElementAssignmentConflicts(ActionElementMap, Boolean)
Disables any ActionElementMaps in this controller map that conflict with the incoming ActionElementMap.
Public methodDisableElementAssignmentConflicts(ControllerMap, Boolean)
Disables any ActionElementMaps in this controller map that conflict with the incoming controller map.
Public methodDisableElementAssignmentConflicts(ElementAssignmentConflictCheck, Boolean)
Disables any ActionElementMaps in this controller map that conflict with the potential assignment contained in the ElementAssignmentConflictCheck.
Public methodDoesElementAssignmentConflict(ActionElementMap)
Determines if any element assignments conflict between the this controller map and the incoming ActionElementMap.
Public methodDoesElementAssignmentConflict(ControllerMap)
Determines if any element assignments conflict between this controller map and the incoming controller map.
Public methodDoesElementAssignmentConflict(ElementAssignmentConflictCheck)
Determines if any element assignments conflict between this controller map and the potential assignment contained in the ElementAssignmentConflictCheck.
Public methodDoesElementAssignmentConflict(ActionElementMap, Boolean)
Determines if any element assignments conflict between the this controller map and the incoming ActionElementMap.
Public methodDoesElementAssignmentConflict(ControllerMap, Boolean)
Determines if any element assignments conflict between this controller map and the incoming controller map.
Public methodDoesElementAssignmentConflict(ElementAssignmentConflictCheck, Boolean)
Determines if any element assignments conflict between this controller map and the potential assignment contained in the ElementAssignmentConflictCheck.
Public methodElementAssignmentConflicts(ActionElementMap)
Enumerates all assignment conflicts between the this controller map and the incoming ActionElementMap.
Public methodElementAssignmentConflicts(ControllerMap)
Enumerates all assignment conflicts between this controller map and the incoming controller map.
Public methodElementAssignmentConflicts(ElementAssignmentConflictCheck)
Enumerates all assignment conflicts between this controller map and the potential assignment contained in the ElementAssignmentConflictCheck.
Public methodElementAssignmentConflicts(ActionElementMap, Boolean)
Enumerates all assignment conflicts between the this controller map and the incoming ActionElementMap.
Public methodElementAssignmentConflicts(ControllerMap, Boolean)
Enumerates all assignment conflicts between this controller map and the incoming controller map.
Public methodElementAssignmentConflicts(ElementAssignmentConflictCheck, Boolean)
Enumerates all assignment conflicts between this controller map and the potential assignment contained in the ElementAssignmentConflictCheck.
Public methodElementMapsWithAction(Int32)
Enumarates all ActionElementMaps in this controller map that contain a specific Action.
Public methodElementMapsWithAction(String)
Enumarates all ActionElementMaps in this controller map that contain a specific Action.
Public methodElementMapsWithAction(Int32, Boolean)
Enumarates all ActionElementMaps in this controller map that contain a specific Action.
Public methodElementMapsWithAction(String, Boolean)
Enumarates all ActionElementMaps in this controller map that contain a specific Action.
Public methodElementMapsWithElementTarget(ControllerElementTarget, Boolean)
Enumarates all ActionElementMaps that map to a specific controller element target.
Public methodElementMapsWithElementTarget(IControllerElementTarget, Boolean)
Enumarates all ActionElementMaps that map to a specific controller element target.
Public methodElementMapsWithElementTarget(ControllerElementTarget, Int32, Boolean)
Enumarates all ActionElementMaps that map to a specific controller element target and a specific Action.
Public methodElementMapsWithElementTarget(ControllerElementTarget, String, Boolean)
Enumarates all ActionElementMaps that map to a specific controller element target and a specific Action.
Public methodElementMapsWithElementTarget(IControllerElementTarget, Int32, Boolean)
Enumarates all ActionElementMaps that map to a specific controller element target and a specific Action.
Public methodElementMapsWithElementTarget(IControllerElementTarget, String, Boolean)
Enumarates all ActionElementMaps that map to a specific controller element target and a specific Action.
Public methodForEachButtonMapMatch
Invokes the action on each Button Map that matches the conditions defined by specified predicate.
Public methodForEachElementAssignmentConflict(ActionElementMap, ActionActionElementMap)
Invokes the specified action on all ActionElementMaps in this controller map that conflict with the incoming ActionElementMap.
Public methodForEachElementAssignmentConflict(ControllerMap, ActionActionElementMap)
Invokes the specified action on all ActionElementMaps in this controller map that conflict with the incoming controller map.
Public methodForEachElementAssignmentConflict(ElementAssignmentConflictCheck, ActionActionElementMap)
Invokes the specified action on all ActionElementMaps in this controller map that conflict with the potential assignment contained in the ElementAssignmentConflictCheck.
Public methodForEachElementAssignmentConflict(ActionElementMap, ActionActionElementMap, Boolean)
Invokes the specified action on all ActionElementMaps in this controller map that conflict with the incoming ActionElementMap.
Public methodForEachElementAssignmentConflict(ControllerMap, ActionActionElementMap, Boolean)
Invokes the specified action on all ActionElementMaps in this controller map that conflict with the incoming controller map.
Public methodForEachElementAssignmentConflict(ElementAssignmentConflictCheck, ActionActionElementMap, Boolean)
Invokes the specified action on all ActionElementMaps in this controller map that conflict with the potential assignment contained in the ElementAssignmentConflictCheck.
Public methodForEachElementMapMatch
Invokes the action on each Action Element Map of any type that matches the conditions defined by specified predicate.
Public methodGetButtonMap
Gets the Button ActionElementMap at a specific index..
Public methodGetButtonMapMatches
Finds all Button Maps that match the conditions defined by the specified predicate.
Public methodGetButtonMaps
Gets all Button ActionElementMaps in this controller map. Warning: Calling this allocates memory. Use ButtonMaps instead.
Public methodGetButtonMaps(Boolean)
Public methodGetButtonMaps(Boolean, ListActionElementMap)
Gets all Button ActionElementMaps in this controller map.
Public methodGetButtonMapsWithAction(Int32)
Gets all Button ActionElementMaps in this controller map that contain a specific Action. Warning: Calling this allocates memory. Use GetButtonMapsWithAction(Int32, ListActionElementMap) instead.
Public methodGetButtonMapsWithAction(String)
Public methodGetButtonMapsWithAction(Int32, Boolean)
Public methodGetButtonMapsWithAction(Int32, ListActionElementMap)
Gets all Button ActionElementMaps in this controller map that contain a specific Action.
Public methodGetButtonMapsWithAction(String, Boolean)
Public methodGetButtonMapsWithAction(String, ListActionElementMap)
Gets all Button ActionElementMaps in this controller map that contain a specific Action.
Public methodGetButtonMapsWithAction(Int32, Boolean, ListActionElementMap)
Gets all Button ActionElementMaps in this controller map that contain a specific Action.
Public methodGetButtonMapsWithAction(String, Boolean, ListActionElementMap)
Gets all Button ActionElementMaps in this controller map that contain a specific Action.
Public methodGetButtonNames
Gets the element identifier names in all button maps. Warning: Calling this allocates memory.
Public methodGetElementMap
Gets the ActionElementMap that matches the id.
Public methodGetElementMapMatches
Finds all Action Element Maps of any kind that match the conditions defined by the specified predicate.
Public methodGetElementMaps
Gets all ActionElementMaps in this controller map. Warning: Calling this allocates memory. Use AllMaps instead.
Public methodGetElementMaps(Boolean)
Public methodGetElementMaps(ListActionElementMap)
Gets all ActionElementMaps in this controller map.
Public methodGetElementMaps(Boolean, ListActionElementMap)
Gets all ActionElementMaps in this controller map.
Public methodGetElementMapsWithAction(Int32)
Public methodGetElementMapsWithAction(String)
Public methodGetElementMapsWithAction(Int32, Boolean)
Public methodGetElementMapsWithAction(Int32, ListActionElementMap)
Gets all ActionElementMaps in this controller map that contain a specific Action.
Public methodGetElementMapsWithAction(String, Boolean)
Public methodGetElementMapsWithAction(String, ListActionElementMap)
Gets all ActionElementMaps in this controller map that contain a specific Action.
Public methodGetElementMapsWithAction(Int32, Boolean, ListActionElementMap)
Gets all ActionElementMaps in this controller map that contain a specific Action.
Public methodGetElementMapsWithAction(String, Boolean, ListActionElementMap)
Gets all ActionElementMaps in this controller map that contain a specific Action.
Public methodGetElementMapsWithElementTarget(ControllerElementTarget, Boolean, ListActionElementMap)
Gets all ActionElementMaps that map to a specific controller element target.
Public methodGetElementMapsWithElementTarget(IControllerElementTarget, Boolean, ListActionElementMap)
Gets all ActionElementMaps that map to a specific controller element target.
Public methodGetElementMapsWithElementTarget(ControllerElementTarget, Int32, Boolean, ListActionElementMap)
Gets all ActionElementMaps that map to a specific controller element target and a specific Action.
Public methodGetElementMapsWithElementTarget(ControllerElementTarget, String, Boolean, ListActionElementMap)
Gets all ActionElementMaps that map to a specific controller element target and a specific Action.
Public methodGetElementMapsWithElementTarget(IControllerElementTarget, Int32, Boolean, ListActionElementMap)
Gets all ActionElementMaps that map to a specific controller element target and a specific Action.
Public methodGetElementMapsWithElementTarget(IControllerElementTarget, String, Boolean, ListActionElementMap)
Gets all ActionElementMaps that map to a specific controller element target and a specific Action.
Public methodGetFirstButtonMapMatch
Finds the first Button Map that matches the conditions defined by the specified predicate.
Public methodGetFirstButtonMapWithAction(Int32)
Gets the first Button ActionElementMap found in this controller that contains a specific Action.
Public methodGetFirstButtonMapWithAction(String)
Gets the first Button ActionElementMap found in this controller that contains a specific Action.
Public methodGetFirstButtonMapWithAction(Int32, Boolean)
Gets the first Button ActionElementMap found in this controller that contains a specific Action.
Public methodGetFirstButtonMapWithAction(String, Boolean)
Gets the first Button ActionElementMap found in this controller that contains a specific Action.
Public methodGetFirstElementMapMatch
Finds the first Action Element Map of any kind that matches the conditions defined by the specified predicate.
Public methodGetFirstElementMapWithAction(Int32)
Gets the first ActionElementMap found in this controller that contains a specific Action.
Public methodGetFirstElementMapWithAction(String)
Gets the first ActionElementMap found in this controller that contains a specific Action.
Public methodGetFirstElementMapWithAction(Int32, Boolean)
Gets the first ActionElementMap found in this controller that contains a specific Action.
Public methodGetFirstElementMapWithAction(String, Boolean)
Gets the first ActionElementMap found in this controller that contains a specific Action.
Public methodGetFirstElementMapWithElementTarget(ControllerElementTarget, Boolean)
Gets the first ActionElementMap found that maps to a specific controller element target.
Public methodGetFirstElementMapWithElementTarget(IControllerElementTarget, Boolean)
Gets the first ActionElementMap found that maps to a specific controller element target.
Public methodGetFirstElementMapWithElementTarget(ControllerElementTarget, Int32, Boolean)
Gets the first ActionElementMap found that maps to a specific controller element target and a specific Action.
Public methodGetFirstElementMapWithElementTarget(ControllerElementTarget, String, Boolean)
Gets the first ActionElementMap found that maps to a specific controller element target and a specific Action.
Public methodGetFirstElementMapWithElementTarget(IControllerElementTarget, Int32, Boolean)
Gets the first ActionElementMap found that maps to a specific controller element target and a specific Action.
Public methodGetFirstElementMapWithElementTarget(IControllerElementTarget, String, Boolean)
Gets the first ActionElementMap found that maps to a specific controller element target and a specific Action.
Public methodRemoveElementAssignmentConflicts(ActionElementMap)
Deletes any ActionElementMaps in this controller map that conflict with the incoming ActionElementMap.
Public methodRemoveElementAssignmentConflicts(ControllerMap)
Deletes any ActionElementMaps in this controller map that conflict with the incoming controller map.
Public methodRemoveElementAssignmentConflicts(ElementAssignmentConflictCheck)
Deletes any ActionElementMaps in this controller map that conflict with the potential assignment contained in the ElementAssignmentConflictCheck.
Public methodRemoveElementAssignmentConflicts(ActionElementMap, Boolean)
Deletes any ActionElementMaps in this controller map that conflict with the incoming ActionElementMap.
Public methodRemoveElementAssignmentConflicts(ControllerMap, Boolean)
Deletes any ActionElementMaps in this controller map that conflict with the incoming controller map.
Public methodRemoveElementAssignmentConflicts(ElementAssignmentConflictCheck, Boolean)
Deletes any ActionElementMaps in this controller map that conflict with the potential assignment contained in the ElementAssignmentConflictCheck.
Public methodReplaceElementMap(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.
Public methodReplaceElementMap(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.
Public methodReplaceElementMap(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.
Public methodReplaceElementMap(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.
Public methodReplaceElementMap(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.
Public methodReplaceElementMap(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.
Public methodReplaceElementMap(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.
Public methodReplaceElementMap(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.
Public methodReplaceOrCreateElementMap(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.
Public methodReplaceOrCreateElementMap(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.
Public methodSetAllButtonMapsEnabled
Sets the enabled state on all Button Maps.
Public methodSetAllElementMapsEnabled
Sets the enabled state on all Action Element Maps.
Public methodToControllerTemplateMap(Guid)
Converts the Controller Map to a Controller Template Map.
Public methodToControllerTemplateMap(Type)
Converts the Controller Map to a Controller Template Map.
Public methodToControllerTemplateMapT
Converts the Controller Map to a Controller Template Map.
Public methodToJsonString
Exports the map to a JSON string.
Public methodToXmlString
Exports the map to an XML string.
Top
See Also