1. Epic GamesDeveloper
  3. FPlayerKeyMapping

FPlayerKeyMapping

Represents a single key mapping that is set by the player

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

References

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

Syntax

USTRUCT&40;BlueprintType&41;  
struct FPlayerKeyMapping

Remarks

Represents a single key mapping that is set by the player

Variables

  Type Name Description
Protected variable UProperty Category BlueprintReadOnly Transient visibleanywhere TObjectPtr< const UInputAction > AssociatedInputAction The input action associated with this player key mapping
Protected variable UProperty Category BlueprintReadOnly Transient visibleanywhere uint8: 1 bIsDirty True if this key mapping is dirty (i.e. has been changed by the player)
Protected variable UProperty Category, Meta BlueprintReadOnly visibleanywhere FKey CurrentKey The key that the player has mapped to
Protected variable UProperty Category, Meta BlueprintReadOnly Transient visibleanywhere FKey DefaultKey The default key that this mapping was set to in its input mapping context
Protected variable UProperty Category BlueprintReadOnly Transient visibleanywhere FText DisplayCategory Localized display category of this mapping
Protected variable UProperty Category BlueprintReadOnly Transient visibleanywhere FText DisplayName Localized display name of this mapping
Protected variable UProperty Category BlueprintReadOnly visibleanywhere FHardwareDeviceIdentifier HardwareDeviceId An optional Hardware Device specifier for this mapping
Protected variable UProperty Category BlueprintReadOnly visibleanywhere FName MappingName The name of the mapping for this key
Protected variable UProperty Category BlueprintReadOnly visibleanywhere EPlayerMappableKeySlot Slot What slot this key is mapped to

Constructors

  Type Name Description
Public function    
Public function  

FPlayerKeyMapping ( const FEnhancedActionKeyMapping& OriginalMapping,
EPlayerMappableKeySlot InSlot,
const FHardwareDeviceIdentifier& InHardwareDevice
)

  

Functions

  Type Name Description
Public function Const const UInputAction * Returns the input action asset associated with this player key mapping
Public function Const const FKey & Returns the key that the player has mapped.
Public function Const const FKey & Returns the default key that this mapping is to
Public function Const const FText & The localized display name for the category to use for this mapping
Public function Const const FText & The localized display name to use for this mapping
Public function Const const FHardwareDeviceIdentifier & Returns the optional hardware device ID that this mapping is specific to
Public function Const EHardwareDeviceSupportedFeatures::Type Gets the supported hardware device feature flags associated with this key mapping.
Public function Const const FName The unique FName associated with this mapping.
Public function Const EHardwareDevicePrimaryType Gets the primary device type associated with this key mapping. Taken from the HardwareDeviceId.
Public function Const EPlayerMappableKeySlot

GetSlot ()

 Returns what player mappable slot this mapping is in
Public function Const bool Returns true if this mapping has been customized by the player, and false if it has not been.
Public function Const const bool

IsDirty ()

 Returns true if this mapping has been modified since it was registered from an IMC
Public function Const bool

IsValid ()

 Returns true if this player mapping is valid
Public function void Resets the current mapping to the default one
Public function void

SetCurrentKey ( const FKey& NewKey
)

 Sets the value of the current key to the one given
Public function void Sets the value of the hardware device ID that this custom key mapping is associated with.
Public function Const FString Print out some debug information about this player key mappings
Public function void Sets the Default Key on this mapping to that of the given ActionKeyMapping.
Public function void Updates the metadata properties on this player mapped key based on the given enhanced action mapping.

Operators

  Type Name Description
Public function Const bool

operator!= ( const FPlayerKeyMapping& Other
)

  
Public function Const bool

operator== ( const FPlayerKeyMapping& Other
)

  

Constants

Name Description
InvalidMapping A static invalid player key mapping to be used for easy comparisons in blueprint

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page