1. Epic GamesDeveloper
  3. UKismetInputLibrary

UKismetInputLibrary

API > API/Runtime > API/Runtime/Engine

   
Name UKismetInputLibrary
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Kismet/KismetInputLibrary.h
Include Path #include "Kismet/KismetInputLibrary.h"

Syntax

UCLASS (Meta=(ScriptName="InputLibrary"), MinimalAPI)  
class UKismetInputLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UKismetInputLibrary ( const FObjectInitializer& ObjectInitializer
)

   Kismet/KismetInputLibrary.h  

Functions

Public

Static

Name Remarks Include Path Unreal Specifiers

static void CalibrateTilt()

 Calibrate the tilt for the input device Kismet/KismetInputLibrary.h
  • BlueprintCallable
  • Category="Input|MotionTracking"

static bool EqualEqual_InputChordInputChord ( FInputChord A,
FInputChord B
)

 Test if the input chords are equal (A == B) Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Equal (InputChord)", CompactNodeTitle="==")
  • Category="Input|Key"

static bool EqualEqual_KeyKey ( FKey A,
FKey B
)

 Test if the input key are equal (A == B) Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Equal (Key)", CompactNodeTitle="==")
  • Category="Input|Key"

static float GetAnalogValue ( const FAnalogInputEvent& Input
)

   Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Category="Input|InputEvent"

static FKey GetKey ( const FKeyEvent& Input
)

 Returns the key for this event. Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Category="Input|KeyEvent"

static FSlateModifierKeysState GetModifierKeysState()

 Returns a snapshot of the cached modifier-keys state for the application. Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Category="Input|ModifierKeys"

static int32 GetUserIndex ( const FKeyEvent& Input
)

   Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Category="Input|KeyEvent"

static FText InputChord_GetDisplayName ( const FInputChord& Key
)

   Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Get Input Chord Display Name")
  • Category="Input|Key"

static bool InputEvent_IsAltDown ( const FInputEvent& Input
)

 Returns true if either alt key was down when this event occurred Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Alt Down")
  • Category="Input|InputEvent"

static bool InputEvent_IsCommandDown ( const FInputEvent& Input
)

 Returns true if either command key was down when this event occurred Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Command Down")
  • Category="Input|InputEvent"

static bool InputEvent_IsControlDown ( const FInputEvent& Input
)

 Returns true if either control key was down when this event occurred Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Control Down")
  • Category="Input|InputEvent"

static bool InputEvent_IsLeftAltDown ( const FInputEvent& Input
)

 Returns true if left alt key was down when this event occurred Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Left Alt Down")
  • Category="Input|InputEvent"

static bool InputEvent_IsLeftCommandDown ( const FInputEvent& Input
)

 Returns true if left command key was down when this event occurred Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Left Command Down")
  • Category="Input|InputEvent"

static bool InputEvent_IsLeftControlDown ( const FInputEvent& Input
)

 Returns true if left control key was down when this event occurred Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Left Control Down")
  • Category="Input|InputEvent"

static bool InputEvent_IsLeftShiftDown ( const FInputEvent& Input
)

 Returns true if left shift key was down when this event occurred Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Left Shift Down")
  • Category="Input|InputEvent"

static bool InputEvent_IsRepeat ( const FInputEvent& Input
)

 Returns whether or not this character is an auto-repeated keystroke Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Repeat")
  • Category="Input|InputEvent"

static bool InputEvent_IsRightAltDown ( const FInputEvent& Input
)

 Returns true if right alt key was down when this event occurred Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Right Alt Down")
  • Category="Input|InputEvent"

static bool InputEvent_IsRightCommandDown ( const FInputEvent& Input
)

 Returns true if right command key was down when this event occurred Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Right Command Down")
  • Category="Input|InputEvent"

static bool InputEvent_IsRightControlDown ( const FInputEvent& Input
)

 Returns true if left control key was down when this event occurred Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Right Control Down")
  • Category="Input|InputEvent"

static bool InputEvent_IsRightShiftDown ( const FInputEvent& Input
)

 Returns true if right shift key was down when this event occurred Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Right Shift Down")
  • Category="Input|InputEvent"

static bool InputEvent_IsShiftDown ( const FInputEvent& Input
)

 Returns true if either shift key was down when this event occurred Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Shift Down")
  • Category="Input|InputEvent"

static FText Key_GetDisplayName ( const FKey& Key,
bool bLongDisplayName
)

 Returns the display name of the key. Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Get Key Display Name", BlueprintAutocast)
  • Category="Input|Key"

static EUINavigationAction Key_GetNavigationAction ( const FKey& InKey
)

   Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Get Key Navigation Action", DeprecatedFunction, DeprecationMessage="Use Get Key Event Navigation Action instead")
  • Category="Input|Key"

static EUINavigationAction Key_GetNavigationActionFromKey ( const FKeyEvent& InKeyEvent
)

 Returns the navigation action corresponding to this key, or Invalid if not found Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Get Key Event Navigation Action")
  • Category="Input|KeyEvent"

static EUINavigation Key_GetNavigationDirectionFromAnalog ( const FAnalogInputEvent& InAnalogEvent
)

 Returns the navigation action corresponding to this key, or Invalid if not found Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Get Analog Event Navigation Direction")
  • Category="Input|AnalogEvent"

static EUINavigation Key_GetNavigationDirectionFromKey ( const FKeyEvent& InKeyEvent
)

 Returns the navigation action corresponding to this key, or Invalid if not found Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Get Key Event Navigation Direction")
  • Category="Input|KeyEvent"

static bool Key_IsAnalog ( const FKey& Key
)

 Returns true if the key is an analog axis Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Analog")
  • Category="Input|Key"

static bool Key_IsAxis1D ( const FKey& Key
)

 Returns true if the key is a 1D (float) axis Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Axis 1D")
  • Category="Input|Key"

static bool Key_IsAxis2D ( const FKey& Key
)

 Returns true if the key is a 2D (vector) axis Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Axis 2D")
  • Category="Input|Key"

static bool Key_IsAxis3D ( const FKey& Key
)

 Returns true if the key is a 3D (vector) axis Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Axis 3D")
  • Category="Input|Key"

static bool Key_IsButtonAxis ( const FKey& Key
)

 Returns true if the key is a 1D axis emulating a digital button press. Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Button Axis")
  • Category="Input|Key"

static bool Key_IsDigital ( const FKey& Key
)

 Returns true if the key is a digital button press Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Digital")
  • Category="Input|Key"

static bool Key_IsGamepadKey ( const FKey& Key
)

 Returns true if the key is a gamepad button Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Gamepad Key")
  • Category="Input|Key"

static bool Key_IsKeyboardKey ( const FKey& Key
)

 Returns true if the key is a keyboard button Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Keyboard Key")
  • Category="Input|Key"

static bool Key_IsModifierKey ( const FKey& Key
)

 Returns true if the key is a modifier key: Ctrl, Command, Alt, Shift Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Modifier Key")
  • Category="Input|Key"

static bool Key_IsMouseButton ( const FKey& Key
)

 Returns true if the key is a mouse button Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Mouse Button")
  • Category="Input|Key"

static bool Key_IsValid ( const FKey& Key
)

 Returns true if this is a valid key. Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Valid Key")
  • Category="Input|Key"

static bool ModifierKeysState_IsAltDown ( const FSlateModifierKeysState& KeysState
)

 Returns true if either alt key was down when the key state was captured Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Alt Down")
  • Category="Input|ModifierKeys"

static bool ModifierKeysState_IsCommandDown ( const FSlateModifierKeysState& KeysState
)

 Returns true if either command key was down when the key state was captured Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Command Down")
  • Category="Input|ModifierKeys"

static bool ModifierKeysState_IsControlDown ( const FSlateModifierKeysState& KeysState
)

 Returns true if either control key was down when the key state was captured Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Control Down")
  • Category="Input|ModifierKeys"

static bool ModifierKeysState_IsShiftDown ( const FSlateModifierKeysState& KeysState
)

 Returns true if either shift key was down when the key state was captured Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Shift Down")
  • Category="Input|ModifierKeys"

static FVector2D PointerEvent_GetCursorDelta ( const FPointerEvent& Input
)

 Returns the distance the mouse traveled since the last event was handled. Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Get Cursor Delta")
  • Category="Input|PointerEvent"

static FKey PointerEvent_GetEffectingButton ( const FPointerEvent& Input
)

 Mouse button that caused this event to be raised (possibly FKey::Invalid) Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Get Effecting Button")
  • Category="Input|PointerEvent"

static FVector2D PointerEvent_GetGestureDelta ( const FPointerEvent& Input
)

 Returns the change in gesture value since the last gesture event of the same type. Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Get Gesture Delta")
  • Category="Input|PointerEvent"

static ESlateGesture PointerEvent_GetGestureType ( const FPointerEvent& Input
)

 Returns the type of touch gesture Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Category="Input|PointerEvent"

static FVector2D PointerEvent_GetLastScreenSpacePosition ( const FPointerEvent& Input
)

 Returns the position of the cursor in screen space last time we handled an input event Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Get Last Screen Space Position")
  • Category="Input|PointerEvent"

static int32 PointerEvent_GetPointerIndex ( const FPointerEvent& Input
)

 Returns the unique identifier of the pointer (e.g., finger index) Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Get Pointer Index")
  • Category="Input|PointerEvent"

static FVector2D PointerEvent_GetScreenSpacePosition ( const FPointerEvent& Input
)

 Returns The position of the cursor in screen space Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Get Screen Space Position")
  • Category="Input|PointerEvent"

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) Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Get Touchpad Index")
  • Category="Input|PointerEvent"

static int32 PointerEvent_GetUserIndex ( const FPointerEvent& Input
)

 Returns the index of the user that caused the event Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Get User Index")
  • Category="Input|PointerEvent"

static float PointerEvent_GetWheelDelta ( const FPointerEvent& Input
)

 How much did the mouse wheel turn since the last mouse event Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Get Wheel Delta")
  • Category="Input|PointerEvent"

static bool PointerEvent_IsMouseButtonDown ( const FPointerEvent& Input,
FKey MouseButton
)

 Mouse buttons that are currently pressed Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Mouse Button Down")
  • Category="Input|PointerEvent"

static bool PointerEvent_IsTouchEvent ( const FPointerEvent& Input
)

 Returns true if this event a result from a touch (as opposed to a mouse) Kismet/KismetInputLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Touch Event")
  • Category="Input|PointerEvent"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page