1. Epic GamesDeveloper
  3. FMapPlayerKeyArgs

FMapPlayerKeyArgs

Arguments that can be used when mapping a player key

API > API/Plugins > API/Plugins/EnhancedInput

Arguments that can be used when mapping a player key

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

Syntax

USTRUCT (BlueprintType )  
struct FMapPlayerKeyArgs

Constructors

Name Remarks Include Path Unreal Specifiers

PRAGMA_DISABLE_DEPRECATION_WARNINGS FMapPlayerKeyArgs ()

   UserSettings/EnhancedInputUserSettings.h  
  UserSettings/EnhancedInputUserSettings.h  
  UserSettings/EnhancedInputUserSettings.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FMapPlayerKeyArgs()

   UserSettings/EnhancedInputUserSettings.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bCreateMatchingSlotIfNeeded uint8 If there is not a player mapping already with the same Slot and Hardware Device ID, then create a new mapping for this slot. UserSettings/EnhancedInputUserSettings.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Enhanced Input|User Settings"
bDeferOnSettingsChangedBroadcast uint8 Defers setting changed delegates until the next frame if set to true. UserSettings/EnhancedInputUserSettings.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Enhanced Input|User Settings"
HardwareDeviceId FName An OPTIONAL specifier about what kind of hardware this mapping is for. UserSettings/EnhancedInputUserSettings.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Enhanced Input|User Settings"
  • Meta=(AllowPrivateAccess=true, GetOptions="Engine.InputPlatformSettings.GetAllHardwareDeviceNames")
MappingName PRAGMA_ENABLE_DEPRECATION_WARNINGS FName The name of the mapping for this key. UserSettings/EnhancedInputUserSettings.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Enhanced Input|User Settings"
NewKey FKey The new Key that this should be mapped to UserSettings/EnhancedInputUserSettings.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Enhanced Input|User Settings"
ProfileId FGameplayTag The Key Mapping Profile identifier that this mapping should be set on. UserSettings/EnhancedInputUserSettings.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Use ProfileIdString instead.")
ProfileIdString FString The Key Mapping Profile identifier that this mapping should be set on. UserSettings/EnhancedInputUserSettings.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Enhanced Input|User Settings"
Slot EPlayerMappableKeySlot What slot this key mapping is for UserSettings/EnhancedInputUserSettings.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Enhanced Input|User Settings"

Functions

Public

Operators

Name Remarks Include Path Unreal Specifiers
  UserSettings/EnhancedInputUserSettings.h  
  UserSettings/EnhancedInputUserSettings.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page