1. Epic GamesDeveloper
  3. UEnhancedPlayerMappableKeyProfile

UEnhancedPlayerMappableKeyProfile

Represents one "Profile" that a user can have for their player mappable keys

API > API/Plugins > API/Plugins/EnhancedInput > API/Plugins/EnhancedInput/UserSettings

Inheritance Hierarchy

References

   
Module EnhancedInput
Header /Engine/Plugins/EnhancedInput/Source/EnhancedInput/Public/UserSettings/EnhancedInputUserSettings.h
Include #include "UserSettings/EnhancedInputUserSettings.h"

Syntax

UCLASS&40;BlueprintType&41;  
class UEnhancedPlayerMappableKeyProfile : public UObject

Remarks

Represents one "Profile" that a user can have for their player mappable keys

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite SaveGame FText DisplayName The localized display name of this profile
Protected variable UProperty Category BlueprintReadOnly Transient visibleanywhere FPlatformUserId OwningUserId The platform user id of the owning Local Player of this profile.
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly Transient TMap< FName, FKeyMappingRow > PlayerMappedKeys A map of "Mapping Row Name" to all key mappings associated with it.
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly SaveGame FGameplayTag ProfileIdentifier The ID of this profile.

Functions

  Type Name Description
Public function Virtual Const UFunction BlueprintCallable, Category bool Returns true if the given player key mapping passes the query filter provided.
Public function Virtual Const UFunction BlueprintCallable, Category void A helper function to print out all the current profile settings to the log.
Protected function Virtual void Equips the current key profile.
Public function Virtual Const FPlayerKeyMapping *

FindKeyMapping ( const FMapPlayerKeyArgs& InArgs
)

 Returns a pointer to the player key mapping that fits with the given arguments.
Public function Const const FKeyMappingRow *

FindKeyMappingRow ( const FName InMappingName
)

 Get all the key mappings associated with the given mapping name on this profile
Public function FKeyMappingRow *

FindKeyMappingRowMutable ( const FName InMappingName
)

 Get all the key mappings associated with the given mapping name on this profile
Public function Virtual Const UFunction BlueprintCallable, Category, Meta int32

GetMappedKeysInRow ( const FName MappingName,
TArray< FKey >& OutKeys
)

 Returns all FKey's bound to the given mapping Name on this profile.
Public function Virtual Const UFunction BlueprintCallable, Category, Meta int32

GetMappingNamesForKey ( const FKey& InKey,
TArray< FName >& OutMappingNames
)

 Populates the OutMappedMappingNames with every mapping on this profile that has a mapping to the given key.
Public function Virtual Const int32 Called during IEnhancedInputSubsystemInterface::RebuildControlMappings, this provides your user settings the opportunity to decide what key mappings get added for a given FEnhancedActionKeyMapping, and applied to the player.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category const TMap< FName, FKeyMappingRow > & Get all known key mappings for this profile.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category const FText & Get the localized display name for this profile
Public function Const UFunction BlueprintCallable, BlueprintPure, Category const FGameplayTag &  
Public function Const UFunction BlueprintCallable, Category, Meta void

K2_FindKeyMapping ( FPlayerKeyMapping& OutKeyMapping,
const FMapPlayerKeyArgs& InArgs
)

  
Public function Virtual Const UFunction BlueprintCallable, Category, Meta int32 Populates the OutKeys array with any player mapped FKeys for the given default mapping.
Public function UFunction BlueprintCallable, Category void

ResetMappingToDefault ( const FName InMappingName
)

 Resets every player key mapping to this mapping back to it's default value
Public function Virtual UFunction BlueprintCallable, Category void Resets all the key mappings in this profile to their default value from their Input Mapping Context.
Public function Virtual UFunction BlueprintCallable, Category void

SetDisplayName ( const FText& NewDisplayName
)

  
Public function Virtual Const UFunction BlueprintCallable, Category FString Returns a string that can be used to debug the current key mappings.
Protected function Virtual void UnEquips the current profile.

Overridden from UObject

  Type Name Description
Public function Virtual void Because the key mapping profile is serialized as a subobject of the UEnhancedInputUserSettings and requires some custom serialization logic, you should not override the Serialize method on your custom key profile.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page