UInputAction | Unreal Engine 5.3 Documentation

Unreal Engine C++ API Reference > Plugins > EnhancedInput

Inheritance Hierarchy

References


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

Syntax

UCLASS&40;BlueprintType&41;  
class UInputAction : public UDataAsset

Remarks

An Input Action is a logical representation of something the user can do, such as "Jump" or "Crouch". These are what your gameplay code binds to in order to listen for input state changes. For most scenarios your gameplay code should be listening for the "Triggered" event on an input action. This will allow for the most scalable and customizable input configuration because you can add different triggers for each key mapping in the Input Mapping Context.

They are the conceptual equivalent to "Action" and "Axis" mapping names from the Legacy Input System.

Note: These are instanced per player (via FInputActionInstance)

Variables

Type	Name	Description
EInputActionAccumulationBehavior	AccumulationBehavior	This defines how the value of this input action will be calcuated in the case that there are multiple key mappings to the same input action.
FText	ActionDescription	A localized descriptor of this input action.
bool	bConsumeInput	Should this action swallow any inputs bound to it or allow them to pass through to affect lower priority bound actions?
bool	bReserveAllMappings	This action's mappings are not intended to be automatically overridden by higher priority context mappings. Users must explicitly remove the mapping first. NOTE: It is the responsibility of the author of the mapping code to enforce this!
bool	bTriggerWhenPaused	Should this action be able to trigger whilst the game is paused - Replaces bExecuteWhenPaused.
TArray< TObjectPtr< UInputModifier > >	Modifiers	Modifiers are applied to the final action value.
FModifiersChanged	OnModifiersChanged
FTriggersChanged	OnTriggersChanged
TObjectPtr< UPlayerMappableKeySettings >	PlayerMappableKeySettings	Holds setting information about this Action Input for setting screen and save purposes.
TArray< TObjectPtr< UInputTrigger > >	Triggers	Trigger qualifiers.
EInputActionValueType	ValueType	The type that this action returns from a GetActionValue query or action event.

Functions

	Type	Name	Description
	const TObjectPtr< UPlayerMappableKeySettings > &	GetPlayerMappableKeySettings ()	Returns the Player Mappable Key Settings for this Input Action.
	ETriggerEventsSupported	GetSupportedTriggerEvents ()	Returns a bitmask of supported trigger events that is built from each UInputTrigger on this Action.

Overridden from UObject

	Type	Name	Description
	EDataValidationResult	IsDataValid ( FDataValidationContext& Context )	Generic function to validate objects during changelist validations, etc.
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent )	Track actions that have had their ValueType changed to update blueprints referencing them.