Navigation
API > API/Plugins > API/Plugins/EnhancedInput
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UDataAsset
- UInputMappingContext
References
| Module | EnhancedInput |
| Header | /Engine/Plugins/EnhancedInput/Source/EnhancedInput/Public/InputMappingContext.h |
| Include | #include "InputMappingContext.h" |
Syntax
UCLASS&40;BlueprintType, Config&61;Input&41;
class UInputMappingContext : public UDataAsset
Remarks
UInputMappingContext : A collection of key to action mappings for a specific input context Could be used to: Store predefined controller mappings (allow switching between controller config variants). TODO: Build a system allowing redirects of UInputMappingContexts to handle this. Define per-vehicle control mappings Define context specific mappings (e.g. I switch from a gun (shoot action) to a grappling hook (reel in, reel out, disconnect actions). Define overlay mappings to be applied on top of existing control mappings (e.g. Hero specific action mappings in a MOBA)
Variables
| Type | Name | Description | |
|---|---|---|---|
     |
FText | ContextDescription | Localized context descriptor. |
     |
TArray< FEnhancedActionKeyMapping > | Mappings | List of key to action mappings. |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
FEnhancedActionKeyMapping & | GetMapping
(
TArray< FEnhancedActionKeyMapping >::SizeType Index |
|
  |
const TArray< FEnhancedActionKeyMapping > & | GetMappings () |
Mapping accessors. |
   |
FEnhancedActionKeyMapping & | MapKey
(
const UInputAction* Action, |
Map a key to an action within the mapping context. |
   |
void | UnmapAll () |
Unmap everything within the mapping context. |
   |
void | UnmapAllKeysFromAction
(
const UInputAction* Action |
Unmap all key maps to an action within the mapping context. |
   |
void | UnmapKey
(
const UInputAction* Action, |
Unmap a key from an action within the mapping context. |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
   |
EDataValidationResult | IsDataValid
(
FDataValidationContext& Context |
Generic function to validate objects during changelist validations, etc. |
  |
void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
   |
void | UnmapAction
(
const UInputAction* Action |
UnmapAction has been deprecated, please use UnmapAllKeysFromAction instead. |