FKeyEvent | Unreal Engine 5.7 Documentation

FKeyEvent describes a key action (keyboard/controller key/button pressed or released.) It is passed to event handlers dealing with key input.


Name	FKeyEvent
Type	struct
Header File	/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
Include Path	#include "Input/Events.h"

Syntax

USTRUCT (BlueprintType )  
struct FKeyEvent : public FInputEvent

Name	Remarks	Include Path
FKeyEvent ()	UStruct Constructor. Not meant for normal usage.	Input/Events.h
FKeyEvent ( const FKey InKey, const FModifierKeysState& InModifierKeys, const uint32 InUserIndex, const bool bInIsRepeat, const uint32 InCharacterCode, const uint32 InKeyCode )	Constructor. Events are immutable once constructed.	Input/Events.h
FKeyEvent ( const FKey InKey, const FModifierKeysState& InModifierKeys, const FInputDeviceId InDeviceId, const bool bInIsRepeat, const uint32 InCharacterCode, const uint32 InKeyCode, const TOptional< int32 > InOptionalSlateUserIndex )		Input/Events.h

Name	Remarks	Include Path	Unreal Specifiers
virtual ~FKeyEvent()		Input/Events.h

Name	Type	Remarks	Include Path
CharacterCode	uint32	The character code of the key that was pressed. Only applicable to typed character keys, 0 otherwise.	Input/Events.h
Key	FKey	Name of the key that was pressed.	Input/Events.h
KeyCode	uint32	Original key code received from hardware before any conversion/mapping.	Input/Events.h

Name	Remarks	Include Path
uint32 GetCharacter()	Returns the character code for this event.	Input/Events.h
FKey GetKey()	Returns the name of the key for this event	Input/Events.h
uint32 GetKeyCode()	Returns the key code received from hardware before any conversion/mapping.	Input/Events.h

Name	Remarks	Include Path	Unreal Specifiers
virtual bool IsKeyEvent()	Is this event a key event.	Input/Events.h
virtual FText ToText()		Input/Events.h