Navigation
API > API/Plugins > API/Plugins/EnhancedInput
Hold setting information of an Action Input or a Action Key Mapping for setting screen and save purposes.
| Name | UPlayerMappableKeySettings |
| Type | class |
| Header File | /Engine/Plugins/EnhancedInput/Source/EnhancedInput/Public/PlayerMappableKeySettings.h |
| Include Path | #include "PlayerMappableKeySettings.h" |
Syntax
UCLASS (MinimalAPI, DefaultToInstanced, EditInlineNew, DisplayName="Player Mappable Key Settings")
class UPlayerMappableKeySettings : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UPlayerMappableKeySettings
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DisplayCategory | FText | The category that this player mapping is in | PlayerMappableKeySettings.h |
|
| DisplayName | FText | The localized display name of this key mapping. Use this when displaying the mappings to a user. | PlayerMappableKeySettings.h |
|
| Metadata | TObjectPtr< UObject > | Metadata that can used to store any other related items to this key mapping such as icons, ability assets, etc. | PlayerMappableKeySettings.h |
|
| Name | FName | A unique name for this player mapping to be saved with. | PlayerMappableKeySettings.h |
|
| SupportedKeyProfileIds | TArray< FString > | If this key mapping should only be added when a specific key profile is equipped, then set those here. | PlayerMappableKeySettings.h |
|
| SupportedKeyProfiles | FGameplayTagContainer | If this key mapping should only be added when a specific key profile is equipped, then set those here. | PlayerMappableKeySettings.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FName GetMappingName() |
PlayerMappableKeySettings.h | ||
virtual EDataValidationResult IsDataValid
(
FDataValidationContext& Context |
PlayerMappableKeySettings.h | ||
virtual FName MakeMappingName
(
const FEnhancedActionKeyMapping* OwningActionKeyMapping |
PlayerMappableKeySettings.h | ||
virtual void PostLoad() |
PlayerMappableKeySettings.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const TArray< FName > & GetKnownMappingNames () |
Get the known mapping names that are current in use. | PlayerMappableKeySettings.h |