Navigation
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, |
Returns true if the given player key mapping passes the query filter provided. | UserSettings/EnhancedInputUserSettings.h |
|
virtual void DumpProfileToLog() |
A helper function to print out all the current profile settings to the log. | UserSettings/EnhancedInputUserSettings.h |
|
virtual FPlayerKeyMapping * FindKeyMapping
(
const FMapPlayerKeyArgs& InArgs |
Returns a pointer to the player key mapping that fits with the given arguments. | UserSettings/EnhancedInputUserSettings.h | |
const FKeyMappingRow * FindKeyMappingRow
(
const FName InMappingName |
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..., |
Returns all FKey's bound to the given mapping Name on this profile. | UserSettings/EnhancedInputUserSettings.h |
|
virtual int32 GetMappingNamesForKey
(
const FKey& InKey, |
Populates the OutMappedMappingNames with every mapping on this profile that has a mapping to the given key. | UserSettings/EnhancedInputUserSettings.h |
|
virtual int32 GetPlayerMappedKeysForRebuildControlMappings
(
const FEnhancedActionKeyMapping& DefaultMapping, |
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 |
|
const FText & GetProfileDisplayName() |
Get the localized display name for this profile | UserSettings/EnhancedInputUserSettings.h |
|
const FGameplayTag & GetProfileIdentifer() |
UserSettings/EnhancedInputUserSettings.h | ||
const FString & GetProfileIdString() |
UserSettings/EnhancedInputUserSettings.h |
|
|
void K2_FindKeyMapping
(
FPlayerKeyMapping& OutKeyMapping, |
UserSettings/EnhancedInputUserSettings.h |
|
|
virtual int32 QueryPlayerMappedKeys
(
const FPlayerMappableKeyQueryOptions& Options, |
Populates the OutKeys array with any player mapped FKeys for the given default mapping. | UserSettings/EnhancedInputUserSettings.h |
|
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 |
|
virtual void ResetToDefault() |
Resets all the key mappings in this profile to their default value from their Input Mapping Context. | UserSettings/EnhancedInputUserSettings.h |
|
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 |
|
|
virtual FString ToString() |
Returns a string that can be used to debug the current key mappings. | UserSettings/EnhancedInputUserSettings.h |
|
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 |