FInputKeyParams

Paramaters to be considered when calling [UPlayerInput::InputKey](API\Runtime\Engine\GameFramework\UPlayerInput\InputKey\2).

Choose your operating system:

Windows

macOS

Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/GameFramework/PlayerInput.h

Include

#include "GameFramework/PlayerInput.h"

Syntax

struct FInputKeyParams

Remarks

Paramaters to be considered when calling UPlayerInput::InputKey.

Variables

Name Description

Public variable

bool

 

bIsGamepadOverride

If set to true, treat this input event as if it were from a gamepad, whether the FKey is a gamepad key or not.

Public variable

FVector

 

Delta

The Delta that the given key/axis has been changed by

Public variable

float

 

DeltaTime

The time between the previous frame and the current one

Public variable

enum EInputEven...

 

Event

The event that has caused a Button key to be considered

Public variable

FKey

 

Key

The key that has been pressed

Public variable

int32

 

NumSamples

The number of samples to be taken into account with the FKeyState::SampleCountAccumulator

Constructors

Name Description

Public function

FInputKeyParams()

Public function

FInputKeyParams

(
    FKey InKey,
    enum EInputEvent InEvent,
    FVector InDelta,
    bool bGamepadOverride
)

Public function

FInputKeyParams

(
    FKey InKey,
    enum EInputEvent InEvent,
    double InDelta,
    bool bGamepadOverride
)

Public function

FInputKeyParams

(
    FKey InKey,
    double InDelta,
    float InDeltaTime,
    int32 InNumSamples,
    bool bGamepadOverride
)

Functions

Name Description

Public function Const

double

 

Get1DAxisDelta()

Get the delta of the given axis for 1D axis

Public function Const

FVector2D

 

Get2DAxisDelta()

Get the delta of the given axis for 2D axis

Public function Const

FVector

 

Get3DAxisDelta()

Get the delta of the given axis for 3D axis

Public function Const

bool

 

IsGamepad()

Returns true if the Key used for this input is a gamepad key