Navigation
API > API/Plugins > API/Plugins/EnhancedInput
Represents a single key mapping that is set by the player
| Name | FPlayerKeyMapping |
| Type | struct |
| Header File | /Engine/Plugins/EnhancedInput/Source/EnhancedInput/Public/UserSettings/EnhancedInputUserSettings.h |
| Include Path | #include "UserSettings/EnhancedInputUserSettings.h" |
Syntax
USTRUCT (BlueprintType )
struct FPlayerKeyMapping
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FPlayerKeyMapping
(
const FEnhancedActionKeyMapping& OriginalMapping, |
UserSettings/EnhancedInputUserSettings.h | ||
FPlayerKeyMapping
(
const FPlayerKeyMapping& Other |
UserSettings/EnhancedInputUserSettings.h | ||
| UserSettings/EnhancedInputUserSettings.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| InvalidMapping | FPlayerKeyMapping | A static invalid player key mapping to be used for easy comparisons in blueprint | UserSettings/EnhancedInputUserSettings.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const UInputAction * GetAssociatedInputAction() |
Returns the input action asset associated with this player key mapping | UserSettings/EnhancedInputUserSettings.h | |
const FKey & GetCurrentKey () |
Returns the key that the player has mapped. | UserSettings/EnhancedInputUserSettings.h | |
const FKey & GetDefaultKey() |
Returns the default key that this mapping is to | UserSettings/EnhancedInputUserSettings.h | |
const FText & GetDisplayCategory() |
The localized display name for the category to use for this mapping | UserSettings/EnhancedInputUserSettings.h | |
const FText & GetDisplayName() |
The localized display name to use for this mapping | UserSettings/EnhancedInputUserSettings.h | |
const FHardwareDeviceIdentifier & GetHardwareDeviceId() |
Returns the optional hardware device ID that this mapping is specific to | UserSettings/EnhancedInputUserSettings.h | |
EHardwareDeviceSupportedFeatures::Type GetHardwareDeviceSupportedFeatures () |
Gets the supported hardware device feature flags associated with this key mapping. | UserSettings/EnhancedInputUserSettings.h | |
const FName GetMappingName () |
The unique FName associated with this mapping. | UserSettings/EnhancedInputUserSettings.h | |
EHardwareDevicePrimaryType GetPrimaryDeviceType() |
Gets the primary device type associated with this key mapping. Taken from the HardwareDeviceId. | UserSettings/EnhancedInputUserSettings.h | |
EPlayerMappableKeySlot GetSlot() |
Returns what player mappable slot this mapping is in | UserSettings/EnhancedInputUserSettings.h | |
bool IsCustomized() |
Returns true if this mapping has been customized by the player, and false if it has not been. | UserSettings/EnhancedInputUserSettings.h | |
const bool IsDirty() |
Returns true if this mapping has been modified since it was registered from an IMC | UserSettings/EnhancedInputUserSettings.h | |
bool IsValid() |
Returns true if this player mapping is valid | UserSettings/EnhancedInputUserSettings.h | |
void ResetToDefault() |
Resets the current mapping to the default one | UserSettings/EnhancedInputUserSettings.h | |
void SetCurrentKey
(
const FKey& NewKey |
Sets the value of the current key to the one given | UserSettings/EnhancedInputUserSettings.h | |
void SetHardwareDeviceId
(
const FHardwareDeviceIdentifier& InDeviceId |
Sets the value of the hardware device ID that this custom key mapping is associated with. | UserSettings/EnhancedInputUserSettings.h | |
FString ToString() |
Print out some debug information about this player key mappings | UserSettings/EnhancedInputUserSettings.h | |
void UpdateDefaultKeyFromActionKeyMapping
(
const FEnhancedActionKeyMapping& OriginalMapping |
Sets the Default Key on this mapping to that of the given ActionKeyMapping. | UserSettings/EnhancedInputUserSettings.h | |
void UpdateMetadataFromActionKeyMapping
(
const FEnhancedActionKeyMapping& OriginalMapping |
Updates the metadata properties on this player mapped key based on the given enhanced action mapping. | UserSettings/EnhancedInputUserSettings.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!=
(
const FPlayerKeyMapping& Other |
UserSettings/EnhancedInputUserSettings.h | ||
FPlayerKeyMapping & operator=
(
FPlayerKeyMapping& Other |
UserSettings/EnhancedInputUserSettings.h | ||
FPlayerKeyMapping & operator=
(
const FPlayerKeyMapping& Other |
UserSettings/EnhancedInputUserSettings.h | ||
bool operator==
(
const FPlayerKeyMapping& Other |
UserSettings/EnhancedInputUserSettings.h |