1. Epic GamesDeveloper
  3. FKeyEvent

FKeyEvent

[FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) describes a key action (keyboard/controller key/button pressed or released.) It is passed to event handlers dealing with key input.

API > API/Runtime > API/Runtime/SlateCore > API/Runtime/SlateCore/Input

Inheritance Hierarchy

References

   
Module SlateCore
Header /Engine/Source/Runtime/SlateCore/Public/Input/Events.h
Include #include "Input/Events.h"

Syntax

struct FKeyEvent : public FInputEvent

Remarks

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

Constructors

  Type Name Description
Public function   UStruct Constructor. Not meant for normal usage.
Public function  

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.
Public function  

FKeyEvent ( const FKey InKey,
const FModifierKeysState& InModifierKeys,
const FInputDeviceId InDeviceId,
const bool bInIsRepeat,
const uint32 InCharacterCode,
const uint32 InKeyCode,
const TOptional< int32 > InOptionalSlateUserIndex
)

  

Functions

  Type Name Description
Public function Const uint32 Returns the character code for this event.
Public function Const FKey

GetKey ()

 Returns the name of the key for this event
Public function Const uint32 Returns the key code received from hardware before any conversion/mapping.

Overridden from FInputEvent

  Type Name Description
Public function Virtual Const bool Is this event a key event.
Public function Virtual Const FText

ToText ()

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page