Navigation
API > API/Runtime > API/Runtime/SlateCore
Base class for all mouse and keyevents.
| Name | FInputEvent |
| Type | struct |
| Header File | /Engine/Source/Runtime/SlateCore/Public/Input/Events.h |
| Include Path | #include "Input/Events.h" |
Syntax
USTRUCT (BlueprintType )
struct FInputEvent
Derived Classes
FInputEvent derived class hierarchy
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FInputEvent () |
UStruct Constructor. Not meant for normal usage. | Input/Events.h | |
FInputEvent
(
const FModifierKeysState& InModifierKeys, |
Constructor. Events are immutable once constructed. | Input/Events.h | |
FInputEvent
(
const FModifierKeysState& InModifierKeys, |
Input/Events.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FInputEvent() |
Virtual destructor. | Input/Events.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AreCapsLocked() |
Returns true if caps lock was on when this event occurred | Input/Events.h | |
FGeometry FindGeometry
(
const TSharedRef< SWidget >& WidgetToFind |
The event path provides additional context for handling | Input/Events.h | |
const FWidgetPath * GetEventPath() |
Input/Events.h | ||
uint64 GetEventTimestamp() |
Input/Events.h | ||
FInputDeviceId GetInputDeviceId() |
Returns the input device that caused this event. | Input/Events.h | |
double GetMillisecondsSinceEvent() |
Input/Events.h | ||
const FModifierKeysState & GetModifierKeys() |
Returns the complete set of modifier keys | Input/Events.h | |
FPlatformUserId GetPlatformUserId() |
Returns the associated platform user that caused this event | Input/Events.h | |
uint32 GetUserIndex() |
Returns the index of the user that generated this event. | Input/Events.h | |
TSharedRef< SWindow > GetWindow() |
Input/Events.h | ||
bool IsAltDown() |
Returns true if either alt key was down when this event occurred | Input/Events.h | |
bool IsCommandDown() |
Returns true if either command key was down when this event occurred | Input/Events.h | |
bool IsControlDown() |
Returns true if either control key was down when this event occurred | Input/Events.h | |
virtual bool IsKeyEvent() |
Is this event a key event. | Input/Events.h | |
bool IsLeftAltDown() |
Returns true if left alt key was down when this event occurred | Input/Events.h | |
bool IsLeftCommandDown() |
Returns true if left command key was down when this event occurred | Input/Events.h | |
bool IsLeftControlDown() |
Returns true if left control key was down when this event occurred | Input/Events.h | |
bool IsLeftShiftDown() |
Returns true if left shift key was down when this event occurred | Input/Events.h | |
virtual bool IsPointerEvent() |
Is this event a pointer event (touch or cursor). | Input/Events.h | |
bool IsRepeat() |
Returns whether or not this character is an auto-repeated keystroke | Input/Events.h | |
bool IsRightAltDown() |
Returns true if right alt key was down when this event occurred | Input/Events.h | |
bool IsRightCommandDown() |
Returns true if right command key was down when this event occurred | Input/Events.h | |
bool IsRightControlDown() |
Returns true if right control key was down when this event occurred | Input/Events.h | |
bool IsRightShiftDown() |
Returns true if right shift key was down when this event occurred | Input/Events.h | |
bool IsShiftDown() |
Returns true if either shift key was down when this event occurred | Input/Events.h | |
void SetEventPath
(
const FWidgetPath& InEventPath |
Set the widget path along which this event will be routed | Input/Events.h | |
virtual FText ToText() |
Input/Events.h |