UKismetInputLibrary

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Kismet/KismetInputLibrary.h

Include

#include "Kismet/KismetInputLibrary.h"

Syntax

class UKismetInputLibrary : public UBlueprintFunctionLibrary

Constructors

Name Description

Public function

UKismetInputLibrary

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Static

void

 

CalibrateTilt()

Calibrate the tilt for the input device

Public function Static

bool

 

EqualEqual_InputChordInputChord

(
    FInputChord A,
    FInputChord B
)

Test if the input chords are equal (A == B)

Public function Static

bool

 

EqualEqual_KeyKey

(
    FKey A,
    FKey B
)

Test if the input key are equal (A == B)

Public function Static

float

 

GetAnalogValue

(
    const FAnalogInputEvent& Input
)

Public function Static

FKey

 

GetKey

(
    const FKeyEvent& Input
)

Returns the key for this event.

Public function Static

int32

 

GetUserIndex

(
    const FKeyEvent& Input
)

Public function Static

FText

 

InputChord_GetDisplayName

(
    const FInputChord& Key
)

Public function Static

bool

 

InputEvent_IsAltDown

(
    const FInputEvent& Input
)

Returns true if either alt key was down when this event occurred

Public function Static

bool

 

InputEvent_IsCommandDown

(
    const FInputEvent& Input
)

Returns true if either command key was down when this event occurred

Public function Static

bool

 

InputEvent_IsControlDown

(
    const FInputEvent& Input
)

Returns true if either control key was down when this event occurred

Public function Static

bool

 

InputEvent_IsLeftAltDown

(
    const FInputEvent& Input
)

Returns true if left alt key was down when this event occurred

Public function Static

bool

 

InputEvent_IsLeftCommandDown

(
    const FInputEvent& Input
)

Returns true if left command key was down when this event occurred

Public function Static

bool

 

InputEvent_IsLeftControlDown

(
    const FInputEvent& Input
)

Returns true if left control key was down when this event occurred

Public function Static

bool

 

InputEvent_IsLeftShiftDown

(
    const FInputEvent& Input
)

Returns true if left shift key was down when this event occurred

Public function Static

bool

 

InputEvent_IsRepeat

(
    const FInputEvent& Input
)

Returns whether or not this character is an auto-repeated keystroke

Public function Static

bool

 

InputEvent_IsRightAltDown

(
    const FInputEvent& Input
)

Returns true if right alt key was down when this event occurred

Public function Static

bool

 

InputEvent_IsRightCommandDown

(
    const FInputEvent& Input
)

Returns true if right command key was down when this event occurred

Public function Static

bool

 

InputEvent_IsRightControlDown

(
    const FInputEvent& Input
)

Returns true if left control key was down when this event occurred

Public function Static

bool

 

InputEvent_IsRightShiftDown

(
    const FInputEvent& Input
)

Returns true if right shift key was down when this event occurred

Public function Static

bool

 

InputEvent_IsShiftDown

(
    const FInputEvent& Input
)

Returns true if either shift key was down when this event occurred

Public function Static

FText

 

Key_GetDisplayName

(
    const FKey& Key
)

Returns the display name of the key.

Public function Static

EUINavigatio...

 

Key_GetNavigationAction

(
    const FKey& InKey
)

Public function Static

EUINavigatio...

 

Key_GetNavigationActionFromKey

(
    const FKeyEvent& InKeyEvent
)

Returns the navigation action corresponding to this key, or Invalid if not found

Public function Static

EUINavigatio...

 

Key_GetNavigationDirectionFromAnalog

(
    const FAnalogInputEvent& InAnalogE...
)

Returns the navigation action corresponding to this key, or Invalid if not found

Public function Static

EUINavigatio...

 

Key_GetNavigationDirectionFromKey

(
    const FKeyEvent& InKeyEvent
)

Returns the navigation action corresponding to this key, or Invalid if not found

Public function Static

bool

 

Key_IsAnalog

(
    const FKey& Key
)

Returns true if the key is an analog axis

Public function Static

bool

 

Key_IsAxis1D

(
    const FKey& Key
)

Returns true if the key is a 1D (float) axis

Public function Static

bool

 

Key_IsAxis2D

(
    const FKey& Key
)

Returns true if the key is a 2D (vector) axis

Public function Static

bool

 

Key_IsAxis3D

(
    const FKey& Key
)

Returns true if the key is a 3D (vector) axis

Public function Static

bool

 

Key_IsButtonAxis

(
    const FKey& Key
)

Returns true if the key is a 1D axis emulating a digital button press.

Public function Static

bool

 

Key_IsDigital

(
    const FKey& Key
)

Returns true if the key is a digital button press

Public function Static

bool

 

Key_IsGamepadKey

(
    const FKey& Key
)

Returns true if the key is a gamepad button

Public function Static

bool

 

Key_IsKeyboardKey

(
    const FKey& Key
)

Returns true if the key is a keyboard button

Public function Static

bool

 

Key_IsModifierKey

(
    const FKey& Key
)

Returns true if the key is a modifier key: Ctrl, Command, Alt, Shift

Public function Static

bool

 

Key_IsMouseButton

(
    const FKey& Key
)

Returns true if the key is a mouse button

Public function Static

bool

 

Key_IsValid

(
    const FKey& Key
)

Returns true if this is a valid key.

Public function Static

bool

 

Key_IsVectorAxis

(
    const FKey& Key
)

Returns true if the key is a vector axis @note Deprecated. Use Is Axis 2D/3D instead.

Public function Static

FVector2D

 

PointerEvent_GetCursorDelta

(
    const FPointerEvent& Input
)

Returns the distance the mouse traveled since the last event was handled.

Public function Static

FKey

 

PointerEvent_GetEffectingButton

(
    const FPointerEvent& Input
)

Mouse button that caused this event to be raised (possibly FKey::Invalid)

Public function Static

FVector2D

 

PointerEvent_GetGestureDelta

(
    const FPointerEvent& Input
)

Returns the change in gesture value since the last gesture event of the same type.

Public function Static

ESlateGestur...

 

PointerEvent_GetGestureType

(
    const FPointerEvent& Input
)

Returns the type of touch gesture

Public function Static

FVector2D

 

PointerEvent_GetLastScreenSpacePosition

(
    const FPointerEvent& Input
)

Returns the position of the cursor in screen space last time we handled an input event

Public function Static

int32

 

PointerEvent_GetPointerIndex

(
    const FPointerEvent& Input
)

Returns the unique identifier of the pointer (e.g., finger index)

Public function Static

FVector2D

 

PointerEvent_GetScreenSpacePosition

(
    const FPointerEvent& Input
)

Returns The position of the cursor in screen space

Public function Static

int32

 

PointerEvent_GetTouchpadIndex

(
    const FPointerEvent& Input
)

Returns the index of the touch pad that generated this event (for platforms with multiple touch pads per user)

Public function Static

int32

 

PointerEvent_GetUserIndex

(
    const FPointerEvent& Input
)

Returns the index of the user that caused the event

Public function Static

float

 

PointerEvent_GetWheelDelta

(
    const FPointerEvent& Input
)

How much did the mouse wheel turn since the last mouse event

Public function Static

bool

 

PointerEvent_IsMouseButtonDown

(
    const FPointerEvent& Input,
    FKey MouseButton
)

Mouse buttons that are currently pressed

Public function Static

bool

 

PointerEvent_IsTouchEvent

(
    const FPointerEvent& Input
)

Returns true if this event a result from a touch (as opposed to a mouse)