UInputComponent

Implement an Actor component for input bindings.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

UInputComponent

UEnhancedInputComponent

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Components/InputComponent.h
Include	#include "Components/InputComponent.h"

Syntax

class UInputComponent : public UActorComponent

Remarks

Implement an Actor component for input bindings.

An Input Component is a transient component that enables an Actor to bind various forms of input events to delegate functions. Input components are processed from a stack managed by the PlayerController and processed by the PlayerInput. Each binding can consume the input event preventing other components on the input stack from processing the input.

Variables

	Name	Description
TArray< FInputA...	AxisBindings	The collection of axis bindings.
TArray< FInputA...	AxisKeyBindings	The collection of axis key bindings.
uint8: 1	bBlockInput	Whether any components lower on the input stack should be allowed to receive input.
TArray< FInputG...	GestureBindings	The collection of gesture bindings.
TArray< FInputK...	KeyBindings	The collection of key bindings.
int32	Priority	The priority of this input component when pushed in to the stack.
TArray< FInputT...	TouchBindings	The collection of touch bindings.
TArray< FInputV...	VectorAxisBindings	The collection of vector axis bindings.

Constructors

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

Functions

	Name	Description
FInputAction...	AddActionBinding ( FInputActionBinding Binding )	Adds the specified action binding.
FInputAction...	BindAction ( const FName ActionName, const EInputEvent KeyEvent, UserClass* Object, typename DelegateType::template TMe..., VarTypes... Vars )	Binds a delegate function to an Action defined in the project settings.
FInputAction...	BindAction ( const FName ActionName, const EInputEvent KeyEvent, UserClass* Object, typename FInputActionHandlerWithKey... )	Binds a delegate function to an Action defined in the project settings.
FInputAction...	BindAction ( const FName ActionName, const EInputEvent KeyEvent, UserClass* Object, typename FInputActionHandlerSignatu... )	Binds a delegate function to an Action defined in the project settings.
FInputAxisBi...	BindAxis ( const FName AxisName, UserClass* Object, typename FInputAxisHandlerSignature... )	Binds a delegate function an Axis defined in the project settings.
FInputAxisBi...	BindAxis ( const FName AxisName )	Indicates that the InputComponent is interested in knowing the Axis value (via GetAxisValue) but does not want a delegate function called each frame.
FInputAxisKe...	BindAxisKey ( const FKey AxisKey, UserClass* Object, typename FInputAxisHandlerSignature... )	Binds a delegate function for an axis key (e.g. Mouse X).
FInputAxisKe...	BindAxisKey ( const FKey AxisKey )	Indicates that the InputComponent is interested in knowing/consuming an axis key's value (via GetAxisKeyValue) but does not want a delegate function called each frame.
FInputGestur...	BindGesture ( const FKey GestureKey, UserClass* Object, typename FInputGestureHandlerSignat... )	Binds a gesture event to a delegate function.
FInputKeyBin...	BindKey ( const FKey Key, const EInputEvent KeyEvent, UserClass* Object, typename FInputActionHandlerWithKey... )	Binds a key event to a delegate function with key signature.
FInputKeyBin...	BindKey ( const FKey Key, const EInputEvent KeyEvent, UserClass* Object, typename FInputActionHandlerSignatu... )	Binds a key event to a delegate function.
FInputKeyBin...	BindKey ( const FInputChord Chord, const EInputEvent KeyEvent, UserClass* Object, typename FInputActionHandlerSignatu... )	Binds a chord event to a delegate function.
FInputTouchB...	BindTouch ( const EInputEvent KeyEvent, UserClass* Object, typename FInputTouchHandlerSignatur... )	Binds this input component to touch events.
FInputVector...	BindVectorAxis ( const FKey AxisKey, UserClass* Object, typename FInputVectorAxisHandlerSig... )	Binds a delegate function to a vector axis key (e.g. Tilt) Returned reference is only guaranteed to be valid until another vector axis key is bound.
FInputVector...	BindVectorAxis ( const FKey AxisKey )	Indicates that the InputComponent is interested in knowing/consuming a vector axis key's value (via GetVectorAxisKeyValue) but does not want a delegate function called each frame.
void	ClearActionBindings()	Removes all action bindings.
void	ClearBindingValues()	Clears all cached binding values.
void	ConditionalBuildKeyMap ( UPlayerInput* PlayerInput )
FInputAction...	GetActionBinding ( const int32 BindingIndex )	Gets the action binding with the specified index.
float	GetAxisKeyValue ( const FKey AxisKey )	Gets the current value of the axis with the specified key.
float	GetAxisValue ( const FName AxisName )	Gets the current value of the axis with the specified name.
int32	GetNumActionBindings()	Gets the number of action bindings.
FVector	GetVectorAxisValue ( const FKey AxisKey )	Gets the current vector value of the axis with the specified key.
bool	HasBindings()	Checks whether this component has any input bindings.
void	RemoveActionBinding ( const int32 BindingIndex )	Removes the action binding at the specified index.
void	RemoveActionBinding ( FName ActionName, EInputEvent KeyEvent )	Removes the action binding at the specified index.
void	RemoveActionBinding ( const FInputActionBinding& Binding..., const int32 BindingIndex )	Removes the action binding (index need for multi-name fixups).
void	RemoveActionBindingForHandle ( const int32 Handle )	Removes the action binding at the specified handle.