1. Epic GamesDeveloper
  3. UEnhancedInputComponent

UEnhancedInputComponent

Implement an Actor component for input bindings.

API > API/Plugins > API/Plugins/EnhancedInput

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;Transient, Config&61;Input, HideCategories&61;&40;Activation, "Components&124;Activation"&41;&41;  
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

  Type Name Description
Public function  

UEnhancedInputComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function FEnhancedInputActionEventBinding &

BindAction ( const UInputAction* Action,
ETriggerEvent TriggerEvent,
UObject* Object,
FName FunctionName
)

 Binds to an object UFUNCTION
Public function FInputActionBinding &

BindAction ( const FName ActionName,
const EInputEvent KeyEvent,
UserClass* Object,
typename FInputActionHandlerWithKeySignature::TMethodPtr< UserClass > Func
)

  
Public function FEnhancedInputActionEventBinding &

BindAction ( const UInputAction* Action,
ETriggerEvent TriggerEvent,
UserClass* Object,
typename FEnhancedInputActionHandlerSignature::template TMethodPtr< UserClass, VarTypes... > Func,
VarTypes... Vars
)

  
Public function FEnhancedInputActionEventBinding &

BindAction ( const UInputAction* Action,
ETriggerEvent TriggerEvent,
UserClass* Object,
typename FEnhancedInputActionHandlerValueSignature::template TMethodPtr< UserClass, VarTypes... > Fu...,
VarTypes... Vars
)

  
Public function FEnhancedInputActionEventBinding &

BindAction ( const UInputAction* Action,
ETriggerEvent TriggerEvent,
UserClass* Object,
typename FEnhancedInputActionHandlerInstanceSignature::template TMethodPtr< UserClass, VarTypes... >...,
VarTypes... Vars
)

  
Public function FInputActionBinding &

BindAction ( const FName ActionName,
const EInputEvent KeyEvent,
UserClass* Object,
typename DelegateType::template TMethodPtr< UserClass > Func,
VarTypes... Vars
)

  
Public function FInputActionBinding &

BindAction ( const FName ActionName,
const EInputEvent KeyEvent,
UserClass* Object,
typename FInputActionHandlerSignature::TMethodPtr< UserClass > Func
)

 Delete all InputComponent binding helpers. Indicates intentions going forward and improves intellisense/VAX when working with EnhancedInputCompoennts.
Public function FEnhancedInputActionValueBinding &

BindActionValue ( const UInputAction* Action
)

 Binds a UInputAction assigned via UInputMappingContext to this component.
Public function FInputAxisBinding &

BindAxis ( const FName AxisName,
UserClass* Object,
typename FInputAxisHandlerSignature::TMethodPtr< UserClass > Func
)

  
Public function FInputAxisBinding &

BindAxis ( const FName AxisName
)

  
Public function FInputAxisKeyBinding &

BindAxisKey ( const FKey AxisKey,
UserClass* Object,
typename FInputAxisHandlerSignature::TMethodPtr< UserClass > Func
)

  
Public function FInputAxisKeyBinding &

BindAxisKey ( const FKey AxisKey
)

  
Public function FInputDebugKeyBinding &

BindDebugKey ( const FInputChord Chord,
const EInputEvent KeyEvent,
UserClass* Object,
typename FInputDebugKeyHandlerSignature::TMethodPtr< UserClass > Func,
bool bExecuteWhenPaused
)

 Binds a chord event to a delegate function in development builds only.
Public function FInputDebugKeyBinding &

BindDebugKey ( const FInputChord Chord,
const EInputEvent KeyEvent,
UObject* Object,
FName FunctionName,
bool bExecuteWhenPaused
)

 Binds to an object UFUNCTION
Public function FInputGestureBinding &

BindGesture ( const FKey GestureKey,
UserClass* Object,
typename FInputGestureHandlerSignature::TMethodPtr< UserClass > Func
)

  
Public function FInputKeyBinding &

BindKey ( const FInputChord Chord,
const EInputEvent KeyEvent,
UserClass* Object,
typename FInputActionHandlerSignature::TMethodPtr< UserClass > Func
)

  
Public function FInputKeyBinding &

BindKey ( const FKey Key,
const EInputEvent KeyEvent,
UserClass* Object,
typename FInputActionHandlerSignature::TMethodPtr< UserClass > Func
)

  
Public function FInputTouchBinding &

BindTouch ( const EInputEvent KeyEvent,
UserClass* Object,
typename FInputTouchHandlerSignature::TMethodPtr< UserClass > Func
)

  
Public function FInputVectorAxisBinding &

BindVectorAxis ( const FKey AxisKey,
UserClass* Object,
typename FInputVectorAxisHandlerSignature::TMethodPtr< UserClass > Func
)

  
Public function FInputVectorAxisBinding &

BindVectorAxis ( const FKey AxisKey
)

  
Public function void Removes all action bindings.
Public function void  
Public function void  
Public function Const const TArray< TUniquePtr< FEnhancedInputActionEventBinding > > & Gets all action bindings of type
Public function Const const TArray< FEnhancedInputActionValueBinding > &  
Public function Const FInputActionValue

GetBoundActionValue ( const UInputAction* Action
)

 Helper function to pull the action value for a bound action value.
Public function Const const TArray< TUniquePtr< FInputDebugKeyBinding > > &  
Public function Const bool Checks whether this component has any input bindings.
Public function bool

RemoveActionEventBinding ( const int32 BindingIndex
)

 Removes the action binding at the specified index.
Public function bool

RemoveActionValueBinding ( const int32 BindingIndex
)

  
Public function bool

RemoveBinding ( const FInputBindingHandle& BindingToRemove
)

 Removes an arbitrary binding
Public function bool

RemoveBindingByHandle ( const uint32 Handle
)

 Removes the binding with the specified handle. Binding handles are unique across all bindings.
Public function bool

RemoveDebugKeyBinding ( const int32 BindingIndex
)

  
Public function void

SetShouldFireDelegatesInEditor ( const bool bInNewValue
)

  
Public function Const bool  

Overridden from UInputComponent

  Type Name Description
Public function Virtual void Removes all action bindings.
Public function Virtual void Clears any input callback delegates from the given UObject

See Also

https://docs.unrealengine.com/latest/INT/Gameplay/Input/index.html

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page