UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
InputComponent.h File Reference
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "InputCoreTypes.h"
#include "Components/ActorComponent.h"
#include "Framework/Commands/InputChord.h"
#include "InputComponent.generated.h"

Go to the source code of this file.

Classes

struct  TInputUnifiedDelegate< DelegateType, DynamicDelegateType >
 
struct  FInputBinding
 
struct  FInputActionUnifiedDelegate
 
struct  FInputActionBinding
 
struct  FInputKeyBinding
 
struct  FInputTouchUnifiedDelegate
 
struct  FInputTouchBinding
 
struct  FInputAxisUnifiedDelegate
 
struct  FInputAxisBinding
 
struct  FInputAxisKeyBinding
 
struct  FInputVectorAxisUnifiedDelegate
 
struct  FInputVectorAxisBinding
 
struct  FInputGestureUnifiedDelegate
 
struct  FInputGestureBinding
 
struct  FCachedKeyToActionInfo
 
class  UInputComponent
 
struct  FGetActionsBoundToKey
 

Namespaces

namespace  EControllerAnalogStick
 

Enumerations

enum  EControllerAnalogStick::Type : int { EControllerAnalogStick::CAS_LeftStick , EControllerAnalogStick::CAS_RightStick , EControllerAnalogStick::CAS_MAX }
 

Functions

 DECLARE_DELEGATE (FInputActionHandlerSignature)
 
 DECLARE_DELEGATE_OneParam (FInputActionHandlerWithKeySignature, FKey)
 
 DECLARE_DYNAMIC_DELEGATE_OneParam (FInputActionHandlerDynamicSignature, FKey, Key)
 
 DECLARE_DELEGATE_TwoParams (FInputTouchHandlerSignature, ETouchIndex::Type, FVector)
 
 DECLARE_DYNAMIC_DELEGATE_TwoParams (FInputTouchHandlerDynamicSignature, ETouchIndex::Type, FingerIndex, FVector, Location)
 
 DECLARE_DELEGATE_OneParam (FInputAxisHandlerSignature, float)
 
 DECLARE_DYNAMIC_DELEGATE_OneParam (FInputAxisHandlerDynamicSignature, float, AxisValue)
 
 DECLARE_DELEGATE_OneParam (FInputVectorAxisHandlerSignature, FVector)
 
 DECLARE_DYNAMIC_DELEGATE_OneParam (FInputVectorAxisHandlerDynamicSignature, FVector, AxisValue)
 
 DECLARE_DELEGATE_OneParam (FInputGestureHandlerSignature, float)
 
 DECLARE_DYNAMIC_DELEGATE_OneParam (FInputGestureHandlerDynamicSignature, float, Value)
 

Function Documentation

◆ DECLARE_DELEGATE()

DECLARE_DELEGATE ( FInputActionHandlerSignature  )

Delegate signature for action events.

◆ DECLARE_DELEGATE_OneParam() [1/4]

DECLARE_DELEGATE_OneParam ( FInputActionHandlerWithKeySignature  ,
FKey   
)

◆ DECLARE_DELEGATE_OneParam() [2/4]

DECLARE_DELEGATE_OneParam ( FInputAxisHandlerSignature  ,
float   
)

Delegate signature for axis handlers. @AxisValue: "Value" to pass to the axis. This value will be the device-dependent, so a mouse will report absolute change since the last update, a joystick will report total displacement from the center, etc. It is up to the handler to interpret this data as it sees fit, i.e. treating joystick values as a rate of change would require scaling by frametime to get an absolute delta.

◆ DECLARE_DELEGATE_OneParam() [3/4]

DECLARE_DELEGATE_OneParam ( FInputGestureHandlerSignature  ,
float   
)

Delegate signature for gesture handlers. @Value: "Value" to pass to the axis. Note that by convention this is assumed to be a framerate-independent "delta" value, i.e. absolute change for this frame so the handler need not scale by frametime.

◆ DECLARE_DELEGATE_OneParam() [4/4]

DECLARE_DELEGATE_OneParam ( FInputVectorAxisHandlerSignature  ,
FVector   
)

Delegate signature for vector axis handlers. @AxisValue: "Value" to pass to the axis.

◆ DECLARE_DELEGATE_TwoParams()

DECLARE_DELEGATE_TwoParams ( FInputTouchHandlerSignature  ,
ETouchIndex::Type  ,
FVector   
)

Delegate signature for touch handlers. @FingerIndex: Which finger touched @Location: The 2D screen location that was touched

◆ DECLARE_DYNAMIC_DELEGATE_OneParam() [1/4]

DECLARE_DYNAMIC_DELEGATE_OneParam ( FInputActionHandlerDynamicSignature  ,
FKey  ,
Key   
)

◆ DECLARE_DYNAMIC_DELEGATE_OneParam() [2/4]

DECLARE_DYNAMIC_DELEGATE_OneParam ( FInputAxisHandlerDynamicSignature  ,
float  ,
AxisValue   
)

◆ DECLARE_DYNAMIC_DELEGATE_OneParam() [3/4]

DECLARE_DYNAMIC_DELEGATE_OneParam ( FInputGestureHandlerDynamicSignature  ,
float  ,
Value   
)

◆ DECLARE_DYNAMIC_DELEGATE_OneParam() [4/4]

DECLARE_DYNAMIC_DELEGATE_OneParam ( FInputVectorAxisHandlerDynamicSignature  ,
FVector  ,
AxisValue   
)

◆ DECLARE_DYNAMIC_DELEGATE_TwoParams()

DECLARE_DYNAMIC_DELEGATE_TwoParams ( FInputTouchHandlerDynamicSignature  ,
ETouchIndex::Type  ,
FingerIndex  ,
FVector  ,
Location   
)