1. Epic GamesDeveloper
  3. FInputEvent

FInputEvent

Base class for all mouse and keyevents.

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

USTRUCT (BlueprintType )  
struct FInputEvent

Remarks

Base class for all mouse and keyevents.

Variables

  Type Name Description
Protected variable bool bIsRepeat True if this key was auto-repeated.
Protected variable const FWidgetPath * EventPath Events are sent along paths. See (GetEventPath).
Protected variable FInputDeviceId InputDeviceId The ID of the input device that caused this event.
Protected variable FModifierKeysState ModifierKeys State of modifier keys when this event happened.
Protected variable uint32 UserIndex The index of the user that caused the event.

Constructors

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

FInputEvent ( const FModifierKeysState& InModifierKeys,
const int32 InUserIndex,
const bool bInIsRepeat
)

 Constructor. Events are immutable once constructed.
Public function  

FInputEvent ( const FModifierKeysState& InModifierKeys,
const FInputDeviceId InDeviceId,
const bool bInIsRepeat
)

  

Destructors

  Type Name Description
Public function Virtual   Virtual destructor.

Functions

  Type Name Description
Public function Const bool Returns true if caps lock was on when this event occurred
Public function Const FGeometry

FindGeometry ( const TSharedRef< SWidget >& WidgetToFind
)

 The event path provides additional context for handling
Public function Const const FWidgetPath *  
Public function Const FInputDeviceId Returns the input device that caused this event.
Public function Const const FModifierKeysState & Returns the complete set of modifier keys
Public function Const FPlatformUserId Returns the associated platform user that caused this event
Public function Const uint32 Returns the index of the user that generated this event.
Public function Const TSharedRef< SWindow >  
Public function Const bool Returns true if either alt key was down when this event occurred
Public function Const bool Returns true if either command key was down when this event occurred
Public function Const bool Returns true if either control key was down when this event occurred
Public function Virtual Const bool Is this event a key event.
Public function Const bool Returns true if left alt key was down when this event occurred
Public function Const bool Returns true if left command key was down when this event occurred
Public function Const bool Returns true if left control key was down when this event occurred
Public function Const bool Returns true if left shift key was down when this event occurred
Public function Virtual Const bool Is this event a pointer event (touch or cursor).
Public function Const bool Returns whether or not this character is an auto-repeated keystroke
Public function Const bool Returns true if right alt key was down when this event occurred
Public function Const bool Returns true if right command key was down when this event occurred
Public function Const bool Returns true if right control key was down when this event occurred
Public function Const bool Returns true if right shift key was down when this event occurred
Public function Const bool Returns true if either shift key was down when this event occurred
Public function void

SetEventPath ( const FWidgetPath& InEventPath
)

 Set the widget path along which this event will be routed
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