Class InputComponent

Implement an Actor component for input bindings.

Inheritance
System.Object
UObject
ActorComponent
InputComponent
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.Engine
Assembly: UE4DotNet.dll
Syntax
public class InputComponent : ActorComponent
Remarks

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.

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

Properties

| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static InputComponent DefaultObject { get; }
Property Value
Type Description
InputComponent
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class

Methods

| Improve this Doc View Source

BindAction(Name, EInputEvent, ActionDelegate)

Declaration
public void BindAction(Name ActionName, EInputEvent InputEvent, ActionDelegate Handler)
Parameters
Type Name Description
Name ActionName
EInputEvent InputEvent
ActionDelegate Handler
| Improve this Doc View Source

BindAxis(Name, AxisDelegate)

Declaration
public void BindAxis(Name AxisName, AxisDelegate Handler)
Parameters
Type Name Description
Name AxisName
AxisDelegate Handler
| Improve this Doc View Source

GetControllerAnalogKeyState(Key)

Returns the analog value for the given key/button. If analog isn't supported, returns 1 for down and 0 for up.

Declaration
public float GetControllerAnalogKeyState(Key Key)
Parameters
Type Name Description
Key Key
Returns
Type Description
System.Single
| Improve this Doc View Source

GetControllerAnalogStickState(Byte)

Retrieves the X and Y displacement of the given analog stick. For WhickStick, 0 = left, 1 = right.

Declaration
public (float, float) GetControllerAnalogStickState(byte WhichStick)
Parameters
Type Name Description
System.Byte WhichStick
Returns
Type Description
System.ValueTuple<System.Single, System.Single>
| Improve this Doc View Source

GetControllerKeyTimeDown(Key)

Returns how long the given key/button has been down. Returns 0 if it's up or it just went down this frame.

Declaration
public float GetControllerKeyTimeDown(Key Key)
Parameters
Type Name Description
Key Key
Returns
Type Description
System.Single
| Improve this Doc View Source

GetControllerMouseDelta()

Retrieves how far the mouse moved this frame.

Declaration
public (float, float) GetControllerMouseDelta()
Returns
Type Description
System.ValueTuple<System.Single, System.Single>
| Improve this Doc View Source

GetControllerVectorKeyState(Key)

Returns the vector value for the given key/button.

Declaration
public Vector GetControllerVectorKeyState(Key Key)
Parameters
Type Name Description
Key Key
Returns
Type Description
Vector
| Improve this Doc View Source

GetTouchState(Int32)

Returns the location of a touch, and if it's held down

Declaration
public (float, float, bool) GetTouchState(int FingerIndex)
Parameters
Type Name Description
System.Int32 FingerIndex
Returns
Type Description
System.ValueTuple<System.Single, System.Single, System.Boolean>
| Improve this Doc View Source

IsControllerKeyDown(Key)

Returns true if the given key/button is pressed on the input of the controller (if present)

Declaration
public bool IsControllerKeyDown(Key Key)
Parameters
Type Name Description
Key Key
Returns
Type Description
System.Boolean
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static InputComponent New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
InputComponent
| Improve this Doc View Source

WasControllerKeyJustPressed(Key)

Returns true if the given key/button was up last frame and down this frame.

Declaration
public bool WasControllerKeyJustPressed(Key Key)
Parameters
Type Name Description
Key Key
Returns
Type Description
System.Boolean
| Improve this Doc View Source

WasControllerKeyJustReleased(Key)

Returns true if the given key/button was down last frame and up this frame.

Declaration
public bool WasControllerKeyJustReleased(Key Key)
Parameters
Type Name Description
Key Key
Returns
Type Description
System.Boolean

Operators

| Improve this Doc View Source

Implicit(IntPtr to InputComponent)

Convert from IntPtr to UObject

Declaration
public static implicit operator InputComponent(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
InputComponent