FKeyState

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/KeyState.h

Include

#include "KeyState.h"

Syntax

struct FKeyState

Variables

Name Description

Public variable

uint8: 1

 

bConsumed

True if this key has been "consumed" by an InputComponent and should be ignored for further components during this update.

Public variable

uint8: 1

 

bDown

True if this key is "down", false otherwise.

Public variable

uint8: 1

 

bDownPrevious

Queued state information. This data is updated or flushed once player input is processed.

Public variable

TArray< uint32 ...

 

EventAccumulator

Used to accumulate events during the frame and flushed when processed.

Public variable

TArray< uint32 ...

 

EventCounts

How many of each event type had been received when input was last processed.

Public variable

float

 

LastUpDownTransitionTime

Global time of last up->down or down->up transition.

Public variable

uint8: 3

 

PairSampledAxes

Flag paired axes that have been sampled this tick. X = LSB, Z = MSB

Public variable

FVector

 

RawValue

This is the most recent raw value reported by the device.

Public variable

FVector

 

RawValueAccumulator

Used to accumulate input values during the frame and flushed after processing.

Public variable

uint8

 

SampleCountAccumulator

How many samples contributed to RawValueAccumulator. Used for smoothing operations, e.g. mouse

Public variable

FVector

 

Value

The final "value" for this control, after any optional processing.

Constructors

Name Description

Public function

FKeyState()
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss