UEnhancedPlayerMappableKeyProfile | Unreal Engine 5.6 Documentation

API > API/Plugins > API/Plugins/EnhancedInput

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


Name	UEnhancedPlayerMappableKeyProfile
Type	class
Header File	/Engine/Plugins/EnhancedInput/Source/EnhancedInput/Public/UserSettings/EnhancedInputUserSettings.h
Include Path	#include "UserSettings/EnhancedInputUserSettings.h"

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class UEnhancedPlayerMappableKeyProfile : public UObject

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UEnhancedPlayerMappableKeyProfile

Functions

Public

Name	Remarks	Include Path	Unreal Specifiers
virtual bool DoesMappingPassQueryOptions ( const FPlayerKeyMapping& PlayerMapping, const FPlayerMappableKeyQueryOptions& Options ) const	Returns true if the given player key mapping passes the query filter provided.	UserSettings/EnhancedInputUserSettings.h	BlueprintCallable Category="Enhanced Input\|User Settings"
virtual void DumpProfileToLog()	A helper function to print out all the current profile settings to the log.	UserSettings/EnhancedInputUserSettings.h	BlueprintCallable Category="Enhanced Input\|User Settings"
virtual FPlayerKeyMapping * FindKeyMapping ( const FMapPlayerKeyArgs& InArgs ) const	Returns a pointer to the player key mapping that fits with the given arguments.	UserSettings/EnhancedInputUserSettings.h
const FKeyMappingRow * FindKeyMappingRow ( const FName InMappingName ) const	Get all the key mappings associated with the given mapping name on this profile	UserSettings/EnhancedInputUserSettings.h
FKeyMappingRow * FindKeyMappingRowMutable ( const FName InMappingName )	Get all the key mappings associated with the given mapping name on this profile	UserSettings/EnhancedInputUserSettings.h
virtual int32 GetMappedKeysInRow ( UPARAM(Meta=(GetOptions="EnhancedInput.PlayerMappableKeySettings.GetKnownMappingNames")) const FName..., TArray< FKey >& OutKeys ) const	Returns all FKey's bound to the given mapping Name on this profile.	UserSettings/EnhancedInputUserSettings.h	BlueprintCallable Category="Enhanced Input\|User Settings" Meta=(ReturnDisplayName="Number of keys")
virtual int32 GetMappingNamesForKey ( const FKey& InKey, TArray< FName >& OutMappingNames ) const	Populates the OutMappedMappingNames with every mapping on this profile that has a mapping to the given key.	UserSettings/EnhancedInputUserSettings.h	BlueprintCallable Category="Enhanced Input\|User Settings" Meta=(ReturnDisplayName="Number of mappings")
virtual int32 GetPlayerMappedKeysForRebuildControlMappings ( const FEnhancedActionKeyMapping& DefaultMapping, TArray< FKey >& OutKeys ) const	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.	UserSettings/EnhancedInputUserSettings.h
const TMap< FName, FKeyMappingRow > & GetPlayerMappingRows ()	Get all known key mappings for this profile.	UserSettings/EnhancedInputUserSettings.h	BlueprintCallable BlueprintPure Category="Enhanced Input\|User Settings"
const FText & GetProfileDisplayName()	Get the localized display name for this profile	UserSettings/EnhancedInputUserSettings.h	BlueprintCallable BlueprintPure Category="Enhanced Input\|User Settings"
const FGameplayTag & GetProfileIdentifer()		UserSettings/EnhancedInputUserSettings.h
const FString & GetProfileIdString()		UserSettings/EnhancedInputUserSettings.h	BlueprintCallable BlueprintPure Category="Enhanced Input\|User Settings"
void K2_FindKeyMapping ( FPlayerKeyMapping& OutKeyMapping, const FMapPlayerKeyArgs& InArgs ) const		UserSettings/EnhancedInputUserSettings.h	BlueprintCallable Category="Enhanced Input\|User Settings" Meta=(DisplayName="Find Key Mapping", AutoCreateRefTerm="OutKeyMapping")
virtual int32 QueryPlayerMappedKeys ( const FPlayerMappableKeyQueryOptions& Options, TArray< FKey >& OutKeys ) const	Populates the OutKeys array with any player mapped FKeys for the given default mapping.	UserSettings/EnhancedInputUserSettings.h	BlueprintCallable Category="Enhanced Input\|User Settings" Meta=(ReturnDisplayName="Number of mappings")
void ResetMappingToDefault ( UPARAM(Meta=(GetOptions="EnhancedInput.PlayerMappableKeySettings.GetKnownMappingNames")) const FName... )	Resets every player key mapping to this mapping back to it's default value	UserSettings/EnhancedInputUserSettings.h	BlueprintCallable Category="Enhanced Input\|User Settings"
virtual void ResetToDefault()	Resets all the key mappings in this profile to their default value from their Input Mapping Context.	UserSettings/EnhancedInputUserSettings.h	BlueprintCallable Category="Enhanced Input\|User Settings"
virtual void Serialize ( FArchive& Ar )	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.	UserSettings/EnhancedInputUserSettings.h
virtual void SetDisplayName ( const FText& NewDisplayName )		UserSettings/EnhancedInputUserSettings.h	BlueprintCallable Category="Enhanced Input\|User Settings"
virtual FString ToString()	Returns a string that can be used to debug the current key mappings.	UserSettings/EnhancedInputUserSettings.h	BlueprintCallable Category="Enhanced Input\|User Settings"

Protected

Name	Remarks	Include Path	Unreal Specifiers
virtual void EquipProfile ()	Equips the current key profile.	UserSettings/EnhancedInputUserSettings.h
virtual void UnEquipProfile ()	UnEquips the current profile.	UserSettings/EnhancedInputUserSettings.h

Navigation

Syntax

Inheritance Hierarchy

Functions

Public

Protected