Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > EnhancedInput > UEnhancedInputComponent

Light Theme

Dark Theme

UEnhancedInputComponent

Implement an Actor component for input bindings.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

UInputComponent

UEnhancedInputComponent

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Transient, Config=Input, HideCategories=(Activation, "Components|Activation"))
class UEnhancedInputComponent : public UInputComponent

Remarks

Implement an Actor component for input bindings.

An Enhanced Input Component is a transient component that enables an Actor to bind enhanced actions to delegate functions, or monitor those actions. Input components are processed from a stack managed by the PlayerController and processed by the PlayerInput. These bindings will not consume input events, but this behaviour can be replicated using UInputMappingContext::Priority.

Constructors

	Name	Description
	UEnhancedInputComponent ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
FEnhancedInp...	BindAction ( const UInputAction* Action, ETriggerEvent TriggerEvent, UserClass* Object, typename FEnhancedInputActionHandle... )
FInputAction...	BindAction ( const FName ActionName, const EInputEvent KeyEvent, UserClass* Object, typename DelegateType::template TUO..., VarTypes... Vars )
FEnhancedInp...	BindAction ( const UInputAction* Action, ETriggerEvent TriggerEvent, UserClass* Object, FuncType Func, VarTypes... Vars )
FInputAction...	BindAction ( const FName ActionName, const EInputEvent KeyEvent, UserClass* Object, typename FInputActionHandlerWithKey... )
FInputAction...	BindAction ( const FName ActionName, const EInputEvent KeyEvent, UserClass* Object, typename FInputActionHandlerSignatu... )	Delete all InputComponent binding helpers. Indicates intentions going forward and improves intellisense/VAX when working with EnhancedInputCompoennts.
FEnhancedInp...	BindAction ( const UInputAction* Action, ETriggerEvent TriggerEvent, UObject* Object, FName FunctionName )	Binds to an object UFUNCTION
FEnhancedInp...	BindAction ( const UInputAction* Action, ETriggerEvent TriggerEvent, UserClass* Object, typename FEnhancedInputActionHandle... )
FEnhancedInp...	BindAction ( const UInputAction* Action, ETriggerEvent TriggerEvent, UserClass* Object, typename FEnhancedInputActionHandle... )
FEnhancedInp...	BindActionValue ( const UInputAction* Action )	Binds a UInputAction assigned via UInputMappingContext to this component.
FInputAxisBi...	BindAxis ( const FName AxisName, UserClass* Object, typename FInputAxisHandlerSignature... )
FInputAxisBi...	BindAxis ( const FName AxisName )
FInputAxisKe...	BindAxisKey ( const FKey AxisKey, UserClass* Object, typename FInputAxisHandlerSignature... )
FInputAxisKe...	BindAxisKey ( const FKey AxisKey )
FInputDebugK...	BindDebugKey ( const FInputChord Chord, const EInputEvent KeyEvent, UObject* Object, FName FunctionName, bool bExecuteWhenPaused )	Binds to an object UFUNCTION
FInputDebugK...	BindDebugKey ( const FInputChord Chord, const EInputEvent KeyEvent, UserClass* Object, typename FInputDebugKeyHandlerSigna..., bool bExecuteWhenPaused )	Binds a chord event to a delegate function in development builds only.
FInputGestur...	BindGesture ( const FKey GestureKey, UserClass* Object, typename FInputGestureHandlerSignat... )
FInputKeyBin...	BindKey ( const FKey Key, const EInputEvent KeyEvent, UserClass* Object, typename FInputActionHandlerSignatu... )
FInputKeyBin...	BindKey ( const FInputChord Chord, const EInputEvent KeyEvent, UserClass* Object, typename FInputActionHandlerSignatu... )
FInputTouchB...	BindTouch ( const EInputEvent KeyEvent, UserClass* Object, typename FInputTouchHandlerSignatur... )
FInputVector...	BindVectorAxis ( const FKey AxisKey, UserClass* Object, typename FInputVectorAxisHandlerSig... )
FInputVector...	BindVectorAxis ( const FKey AxisKey )
void	ClearActionEventBindings()	Removes all action bindings.
void	ClearActionValueBindings()
void	ClearDebugKeyBindings()
const TArray...	GetActionEventBindings()	Gets all action bindings of type
const TArray...	GetActionValueBindings()
FInputAction...	GetBoundActionValue ( const UInputAction* Action )	Helper function to pull the action value for a bound action value.
const TArray...	GetDebugKeyBindings()
bool	HasBindings()	Checks whether this component has any input bindings.
bool	RemoveActionEventBinding ( const int32 BindingIndex )	Removes the action binding at the specified index.
bool	RemoveActionValueBinding ( const int32 BindingIndex )
bool	RemoveBinding ( const FInputBindingHandle& Binding... )	Removes an arbitrary binding
bool	RemoveBindingByHandle ( const uint32 Handle )	Removes the binding with the specified handle. Binding handles are unique across all bindings.
bool	RemoveDebugKeyBinding ( const int32 BindingIndex )