1. Epic GamesDeveloper
  3. UInputComponent

UInputComponent

Implement an Actor component for input bindings.

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Components

Inheritance Hierarchy

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

  Type Name Description
Public variable TArray< FInputAxisBinding > AxisBindings The collection of axis bindings.
Public variable TArray< FInputAxisKeyBinding > AxisKeyBindings The collection of axis key bindings.
Public variable uint8: 1 bBlockInput Whether any components lower on the input stack should be allowed to receive input.
Public variable TArray< FInputGestureBinding > GestureBindings The collection of gesture bindings.
Public variable TArray< FInputKeyBinding > KeyBindings The collection of key bindings.
Public variable int32 Priority The priority of this input component when pushed in to the stack.
Public variable TArray< FInputTouchBinding > TouchBindings The collection of touch bindings.
Public variable TArray< FInputVectorAxisBinding > VectorAxisBindings The collection of vector axis bindings.

Constructors

  Type Name Description
Public function  

UInputComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function FInputActionBinding & Adds the specified action binding.
Public function FInputActionBinding &

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

 Binds a delegate function to an Action defined in the project settings.
Public function FInputActionBinding &

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

 Binds a delegate function to an Action defined in the project settings.
Public function FInputActionBinding &

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

 Binds a delegate function to an Action defined in the project settings.
Public function FInputAxisBinding &

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

 Binds a delegate function an Axis defined in the project settings.
Public function FInputAxisBinding &

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.
Public function FInputAxisKeyBinding &

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

 Binds a delegate function for an axis key (e.g. Mouse X).
Public function FInputAxisKeyBinding &

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.
Public function FInputGestureBinding &

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

 Binds a gesture event to a delegate function.
Public function FInputKeyBinding &

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

 Binds a chord event to a delegate function.
Public function FInputKeyBinding &

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

 Binds a key event to a delegate function.
Public function FInputKeyBinding &

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

 Binds a key event to a delegate function with key signature.
Public function FInputTouchBinding &

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

 Binds this input component to touch events.
Public function FInputVectorAxisBinding &

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

 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.
Public function FInputVectorAxisBinding &

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.
Public function Virtual void Removes all action bindings.
Public function void Removes all axis bindings.
Public function Virtual void Clears any inut callback delegates from the given UObject
Public function void Clears all cached binding values.
Public function void  
Public function Const FInputActionBinding &

GetActionBinding ( const int32 BindingIndex
)

 Gets the action binding with the specified index.
Public function Const float

GetAxisKeyValue ( const FKey AxisKey
)

 Gets the current value of the axis with the specified key.
Public function Const float

GetAxisValue ( const FName AxisName
)

 Gets the current value of the axis with the specified name.
Public function Const int32 Gets the number of action bindings.
Public function Const FVector

GetVectorAxisValue ( const FKey AxisKey
)

 Gets the current vector value of the axis with the specified key.
Public function Const bool Checks whether this component has any input bindings.
Public function void

RemoveActionBinding ( const int32 BindingIndex
)

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

RemoveActionBinding ( const FInputActionBinding& BindingToRemove,
const int32 BindingIndex
)

 Removes the action binding (index need for multi-name fixups).
Public function void

RemoveActionBinding ( FName ActionName,
EInputEvent KeyEvent
)

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

RemoveActionBindingForHandle ( const int32 Handle
)

 Removes the action binding at the specified handle.
Public function void

RemoveAxisBinding ( const FName AxisName
)

 Removes the axis binding with the specified name.

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