Click or drag to resize

ActionElementMap Methods

The ActionElementMap type exposes the following members.

Methods
  NameDescription
Public methodCheckForAssignmentConflict(ActionElementMap)
Checks if there are any assignment conflicts between the incoming ActionElementMap and this map.
Public methodCheckForAssignmentConflict(ElementAssignment)
Checks if there are any assignment conflicts between the incoming ElementAssignment and this map.
Public methodGetElementIdentifierFinalGlyphKeys
Get final full glyph key paths for the element identfier(s) bound to the Action. If this is a keyboard binding and modifier keys are in use, modifier key glyphs will be returned first in the results and the primary key will be returned at the end of the list. If using modifier keys and any glyph is missing for either modifier keys or the primary key, no results will be returned. Glyphs will be added to the incoming results collection, so the results collection should normally be cleared before passing to this function. This will only return a glyph if a glyph provider is in use and a glyph has been defined for this element identifier.
Public methodGetElementIdentifierGlyphs(ICollectionObject)
Get glyphs for the element identfier(s) bound to the Action. If this is a keyboard binding and modifier keys are in use, modifier key glyphs will be returned first in the results and the primary key will be returned at the end of the list. If using modifier keys and any glyph is missing for either modifier keys or the primary key, no results will be returned. Glyphs will be added to the incoming results collection, so the results collection should normally be cleared before passing to this function. This will only return a glyph if a glyph provider is in use and a glyph has been defined for this element identifier.
Public methodGetElementIdentifierGlyphsT(ICollectionT)
Get glyphs for the element bound to the Action. If this is a keyboard binding and modifier keys are in use, modifier key glyphs will be returned first in the results and the primary key will be returned at the end of the list. If using modifier keys and any glyph is missing for either modifier keys or the primary key, no results will be returned. Glyphs will be added to the incoming results collection, so the results collection should normally be cleared before passing to this function. This will only return a glyph if a glyph provider is in use and a glyph has been defined for this element identifier.
Public methodIsTarget(ControllerElementTarget)
Is the Controller Element target mapped by this ActionElementMap?
Public methodIsTarget(IControllerElementTarget)
Is the Controller Element target mapped by this ActionElementMap?
Public methodShowInField
Should this Action Element Map be shown in a particular input field with the specified range? This makes it easy to determine whether to show this map in a full, positive, or negative input field when remapping controls.
Public methodToString (Overrides ObjectToString.)
Public methodStatic memberTryGetCombinedElementIdentifierFinalGlyphKey
Gets the combined final full glyph key path of the element identifiers bound to the Action if available. This can be used to get the key for an element that doesn't actually exist but is a sub-set of element members of a Compound Element. For example, when passing in two Action Element Maps that are bound buttons D-Pad Left and D-Pad Right, the glyph for D-Pad Horizontal will be returned if available. When passing in four Action Element Maps that are bound to all four buttons of a D-Pad, the key for D-Pad will be returned if available.
Public methodStatic memberTryGetCombinedElementIdentifierGlyph
Gets the combined glyph of the element identifiers bound to the Action if available. This can be used to get a glyph for an element that doesn't actually exist but is a sub-set of element members of a Compound Element. For example, when passing in two Action Element Maps that are bound buttons D-Pad Left and D-Pad Right, the glyph for D-Pad Horizontal will be returned if available. When passing in four Action Element Maps that are bound to all four buttons of a D-Pad, the glyph for D-Pad will be returned if available.
Public methodStatic memberTryGetCombinedElementIdentifierName
Gets the combined descriptive name of the element identifiers bound to the Action if available. This can be used to get a descriptive name of an element that doesn't actually exist but is a sub-set of element members of a Compound Element. For example, when passing in two Action Element Maps that are bound buttons D-Pad Left and D-Pad Right, "D-Pad Horizontal" will be returned. When passing in four Action Element Maps that are bound to all four buttons of a D-Pad, "D-Pad" will be returned. The returned value will be localized if localization is in use.
Top
See Also