1. Epic GamesDeveloper
  3. FInputKeyEventArgs

FInputKeyEventArgs

Input key event arguments.

API > API/Runtime > API/Runtime/Engine

Input key event arguments. This is data that is required for the viewport client to process input via its InputKey/InputAxis functions.

It represents a single "input event" which has happened which we want game or editor code to be able to process. This may accumulate several "raw" input events from the message handler into one with multiple sample readings, or it could be just one single key press event.

This data can represent gamepad, keyboard, mouse, or touch data.

   
Name FInputKeyEventArgs
Type struct
Header File /Engine/Source/Runtime/Engine/Public/InputKeyEventArgs.h
Include Path #include "InputKeyEventArgs.h"

Syntax

struct FInputKeyEventArgs

Constructors

Name Remarks Include Path Unreal Specifiers
  InputKeyEventArgs.h  

FInputKeyEventArgs ( FViewport* InViewport,
FInputDeviceId InInputDevice,
FKey InKey,
EInputEvent InEvent
)

   InputKeyEventArgs.h  

FInputKeyEventArgs ( FViewport* InViewport,
int32 InControllerId,
FKey InKey,
EInputEvent InEvent
)

   InputKeyEventArgs.h  

FInputKeyEventArgs ( FViewport* InViewport,
const FInputDeviceId InInputDevice,
const FKey& InKey,
const EInputEvent InEvent,
const uint64 InEventTimestamp
)

 Constrcut a FInputKeyEventArgs based on data acquired from the Slate input events. InputKeyEventArgs.h  

FInputKeyEventArgs ( FViewport* InViewport,
FInputDeviceId InInputDevice,
FKey InKey,
EInputEvent InEvent,
float InAmountDepressed,
bool bInIsTouchEvent
)

   InputKeyEventArgs.h  

FInputKeyEventArgs ( FViewport* InViewport,
int32 InControllerId,
FKey InKey,
EInputEvent InEvent,
float InAmountDepressed,
bool bInIsTouchEvent
)

   InputKeyEventArgs.h  

FInputKeyEventArgs ( FViewport* InViewport,
const FInputDeviceId InInputDevice,
const FKey& InKey,
const EInputEvent InEvent,
const float InAmountDepressed,
const bool bInIsTouchEvent,
const uint64 InEventTimestamp
)

 Construct a FInputKeyEventArgs based on data acquired from the Slate input events. InputKeyEventArgs.h  

FInputKeyEventArgs ( FViewport* InViewport,
const FInputDeviceId InInputDevice,
const FKey& InKey,
const float InDelta,
const float InDeltaTime,
const int32 InNumSamples,
const uint64 InEventTimestamp
)

 Construct a FInputKeyEventArgs based on the old params of the ViewportClient InputAxis function. InputKeyEventArgs.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AmountDepressed float The value that this input event represents.    

For analog keys, the depression percent. | InputKeyEventArgs.h | |

bIsTouchEvent bool True if this input event originated from a touch surface. InputKeyEventArgs.h  
ControllerId int32 The controller which the key event is from. InputKeyEventArgs.h  
DeltaTime float The time between the previous frame and the current one InputKeyEventArgs.h  
Event EInputEvent The type of event which occurred. InputKeyEventArgs.h  
EventTimestamp uint64 The timestamp of when this input event was originally polled. InputKeyEventArgs.h  
InputDevice FInputDeviceId The input device which this event originated from. InputKeyEventArgs.h  
Key FKey The Key that this input event is for InputKeyEventArgs.h  
NumSamples int32 For analog key events. InputKeyEventArgs.h  
Viewport FViewport * The viewport from which this key event originated from. InputKeyEventArgs.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsSimulatedInput bool True if this input event is NOT sourced from a physical Human Interface Device (controller, keyboard, mouse, etc) and is instead sourced from code, such as faking input events or simulating input for touch screens. InputKeyEventArgs.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FPlatformUserId GetPlatformUser()

   InputKeyEventArgs.h  

bool IsGamepad()

 This may be true for non-gamepad FKeys if the input event is simulated input. InputKeyEventArgs.h  

bool IsSimulatedInput()

   InputKeyEventArgs.h  

Static

Name Remarks Include Path Unreal Specifiers

static FInputKeyEventArgs CreateSimulated ( const FKey& InKey,
const EInputEvent InEvent,
const float AmountDepressed,
const int32 InNumSamplesOverride,
const FInputDeviceId InputDevice,
const bool bIsTouchEvent,
FViewport* Viewport
)

   InputKeyEventArgs.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page