Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > SlateCore > Input > FInputEvent

Light Theme

Dark Theme

FInputEvent

Base class for all mouse and keyevents.

Windows

MacOS

Linux

Inheritance Hierarchy

FInputEvent

FCharacterEvent

FKeyEvent

FAnalogInputEvent

FMotionEvent

FNavigationEvent

FPointerEvent

FDragDropEvent

References

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

Syntax

struct FInputEvent

Remarks

Base class for all mouse and keyevents.

Variables

	Name	Description
bool	bIsRepeat	True if this key was auto-repeated.
const FWidgetPa...	EventPath	Events are sent along paths. See (GetEventPath).
FModifierKeysSt...	ModifierKeys	State of modifier keys when this event happened.
uint32	UserIndex	The index of the user that caused the event.

Constructors

	Name	Description
	FInputEvent()	UStruct Constructor. Not meant for normal usage.
	FInputEvent ( const FModifierKeysState& InModifi..., const int32 InUserIndex, const bool bInIsRepeat )	Events are immutable once constructed.

Destructors

	Name	Description
	~FInputEvent()	Virtual destructor.

Functions

	Name	Description
bool	AreCapsLocked()	Returns true if caps lock was on when this event occurred
FGeometry	FindGeometry ( const TSharedRef< SWidget >& Widge... )	The event path provides additional context for handling
const FWidge...	GetEventPath()
const FModif...	GetModifierKeys()	Returns the complete set of modifier keys
uint32	GetUserIndex()	Returns the index of the user that generated this event.
TSharedRef< ...	GetWindow()
bool	IsAltDown()	Returns true if either alt key was down when this event occurred
bool	IsCommandDown()	Returns true if either command key was down when this event occurred
bool	IsControlDown()	Returns true if either control key was down when this event occurred
bool	IsKeyEvent()	Is this event a key event.
bool	IsLeftAltDown()	Returns true if left alt key was down when this event occurred
bool	IsLeftCommandDown()	Returns true if left command key was down when this event occurred
bool	IsLeftControlDown()	Returns true if left control key was down when this event occurred
bool	IsLeftShiftDown()	Returns true if left shift key was down when this event occurred
bool	IsPointerEvent()	Is this event a pointer event (touch or cursor).
bool	IsRepeat()	Returns whether or not this character is an auto-repeated keystroke
bool	IsRightAltDown()	Returns true if right alt key was down when this event occurred
bool	IsRightCommandDown()	Returns true if right command key was down when this event occurred
bool	IsRightControlDown()	Returns true if right control key was down when this event occurred
bool	IsRightShiftDown()	Returns true if right shift key was down when this event occurred
bool	IsShiftDown()	Returns true if either shift key was down when this event occurred
void	SetEventPath ( const FWidgetPath& InEventPath )	Set the widget path along which this event will be routed
FText	ToText()

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss