1. Epic GamesDeveloper
  3. FEnhancedActionKeyMapping

FEnhancedActionKeyMapping

Defines a mapping between a key activation and the resulting enhanced action An key could be a button press, joystick axis movement, etc.

API > API/Plugins > API/Plugins/EnhancedInput

References

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

Syntax

USTRUCT&40;BlueprintType&41;  
struct FEnhancedActionKeyMapping

Remarks

Defines a mapping between a key activation and the resulting enhanced action An key could be a button press, joystick axis movement, etc. An enhanced action could be MoveForward, Jump, Fire, etc.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TObjectPtr< const UInputAction > Action Action to be affected by the key
Public variable UProperty Transient uint8: 1 bShouldBeIgnored If true, then this Key Mapping should be ignored.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FKey Key Key that affect the action.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite instanced TArray< TObjectPtr< UInputModifier > > Modifiers Modifiers applied to the raw key value.
Protected variable UProperty Category, EditAnywhere, Meta instanced TObjectPtr< UPlayerMappableKeySettings > PlayerMappableKeySettings Used to expose this mapping or to opt-out of settings completely.
Protected variable UProperty Category, EditAnywhere EPlayerMappableKeySettingBehaviors SettingBehavior Defines which Player Mappable Key Setting to use for a Action Key Mapping.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite instanced TArray< TObjectPtr< UInputTrigger > > Triggers Trigger qualifiers.

Constructors

  Type Name Description
Public function  

FEnhancedActionKeyMapping ( const UInputAction* InAction,
const FKey InKey
)

  

Functions

  Type Name Description
Public function Static bool

CompareByObjectTypes ( const TArray< TObjectPtr< T >>& A,
const TArray< TObjectPtr< T >>& B
)

 Compares if two TArray of UObjects contain the same number and types of objects, but doesn't compare their values.
Public function Const bool If the template bIgnoreModifierAndTriggerValues is true, compare to Other ignoring different trigger states, like pending activation time, but only accept both as equal if the Trigger types are the same and in the same order.
Public function Const const FText & The localized display category of this key mapping
Public function Const const FText & The localized display name of this key mapping
Public function Const FName Returns the name of the mapping based on setting behavior used.
Public function Const UPlayerMappableKeySettings * Returns the Player Mappable Key Settings owned by the Action Key Mapping or by the referenced Input Action, or nothing based of the Setting Behavior.
Public function Const T *  
Public function Const EDataValidationResult  
Public function Const bool Returns true if this Action Key Mapping either holds a Player Mappable Key Settings or is set bIsPlayerMappable.

Operators

  Type Name Description
Public function Const bool Identical comparison, including Triggers and Modifiers current inner values.

Deprecated Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bIsPlayerMappable bIsPlayerMappable has been deprecated, please use SettingBehavior instead.
Public variable UProperty Category, EditAnywhere, Meta FPlayerMappableKeyOptions PlayerMappableOptions PlayerMappableOptions has been deprecated, please use PlayerMappableKeySettings instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page