UKismetInputLibrary

class Engine Blueprint Since unknown

Inherits: UObjectBase › UObjectBaseUtility › UObject › UBlueprintFunctionLibrary › UKismetInputLibrary

#include "Kismet/KismetInputLibrary.h"

Description

Blueprint function library exposing input-related helpers: key/chord comparisons, key classification (modifier, gamepad, mouse, axis), motion-tracking calibration, and input/pointer event queries. Backs the 'Input' category nodes in the Blueprint graph editor.

Caveats & Gotchas

• Most functions here are BlueprintPure and exist to let Blueprint graphs branch on key/event properties that in C++ are usually just plain struct members or FKey helper methods — in C++, prefer calling FKey's own methods (e.g. FKey::IsGamepadKey()) directly instead of going through this library.
• CalibrateTilt only has an effect on devices with a tilt/motion sensor (mobile, some gamepads); it is a no-op elsewhere.

Functions (53)

AnalogEvent 1 InputEvent 14 Key 16 KeyEvent 4 ModifierKeys 5 MotionTracking 1 PointerEvent 12

AnalogEvent

1 ▼

Access	Type	Name	Description
public	function	UKismetInputLibrary::Key_GetNavigationDirectionFromAnalog	Returns the directional UI navigation value corresponding to an analog input event, such as a gamepad stick pushed past the navigation threshold.

InputEvent

14 ▼

Access	Type	Name	Description
public	function	UKismetInputLibrary::GetAnalogValue	Returns the analog value carried by an analog input event, such as a gamepad trigger pull or thumbstick axis.
public	function	UKismetInputLibrary::InputEvent_IsAltDown	Returns true if either the left or right Alt key was held down when this input event occurred.
public	function	UKismetInputLibrary::InputEvent_IsControlDown	Returns true if either the left or right Control key was held down when this input event occurred.
public	function	UKismetInputLibrary::InputEvent_IsShiftDown	Returns true if either the left or right Shift key was held down when this input event occurred.
public	function	UKismetInputLibrary::InputEvent_IsCommandDown	Returns true if either the left or right Command key was held down when this input event occurred.
public	function	UKismetInputLibrary::InputEvent_IsLeftAltDown	Returns true if specifically the left Alt key was held down when this input event occurred.
public	function	UKismetInputLibrary::InputEvent_IsLeftControlDown	Returns true if specifically the left Control key was held down when this input event occurred.
public	function	UKismetInputLibrary::InputEvent_IsLeftShiftDown	Returns true if specifically the left Shift key was held down when this input event occurred.
public	function	UKismetInputLibrary::InputEvent_IsRepeat	Returns whether this input event is an auto-repeated keystroke generated by the OS holding a key down, rather than a fresh key press.
public	function	UKismetInputLibrary::InputEvent_IsRightAltDown	Returns true if specifically the right Alt key was held down when this input event occurred.
public	function	UKismetInputLibrary::InputEvent_IsRightControlDown	Returns true if specifically the right Control key was held down when this input event occurred.
public	function	UKismetInputLibrary::InputEvent_IsRightShiftDown	Returns true if specifically the right Shift key was held down when this input event occurred.
public	function	UKismetInputLibrary::InputEvent_IsLeftCommandDown	Returns true if specifically the left Command key was held down when this input event occurred.
public	function	UKismetInputLibrary::InputEvent_IsRightCommandDown	Returns true if specifically the right Command key was held down when this input event occurred.

Key

16 ▼

Access	Type	Name	Description
public	function	UKismetInputLibrary::EqualEqual_KeyKey	Tests whether two FKey values represent the same key.
public	function	UKismetInputLibrary::Key_IsValid	Returns true if this is a valid, recognized key.
public	function	UKismetInputLibrary::EqualEqual_InputChordInputChord	Tests whether two FInputChord values represent the same key combination, including modifier state.
public	function	UKismetInputLibrary::InputChord_GetDisplayName	Returns the localized, human-readable display name for an input chord, such as "Ctrl+Shift+S".
public	function	UKismetInputLibrary::Key_GetDisplayName	Returns the localized, human-readable display name of a key, suitable for showing key bindings in UI.
public	function	UKismetInputLibrary::Key_IsAnalog	Returns true if the key is an analog axis, reporting a continuous value rather than a simple pressed/released state.
public	function	UKismetInputLibrary::Key_IsAxis1D	Returns true if the key is a 1D (float) axis, such as a gamepad trigger or a single thumbstick direction.
public	function	UKismetInputLibrary::Key_IsDigital	Returns true if the key is a digital button press, reporting only a pressed/released state rather than a continuous value.
public	function	UKismetInputLibrary::Key_IsGamepadKey	Returns true if the key is a gamepad button, trigger, or stick axis.
public	function	UKismetInputLibrary::Key_IsKeyboardKey	Returns true if the key is a keyboard button.
public	function	UKismetInputLibrary::Key_IsModifierKey	Returns true if the key is a modifier key: Ctrl, Command, Alt, or Shift.
public	function	UKismetInputLibrary::Key_IsMouseButton	Returns true if the key is a mouse button.
public	function	UKismetInputLibrary::Key_GetNavigationAction deprecated	Returns the UI navigation action (Accept, Back, or Invalid) mapped to this key by Slate's navigation config.
public	function	UKismetInputLibrary::Key_IsAxis2D	Returns true if the key is a 2D (vector) axis, such as mouse movement or a touchpad's XY position.
public	function	UKismetInputLibrary::Key_IsAxis3D	Returns true if the key is a 3D (vector) axis, such as device tilt/motion input.
public	function	UKismetInputLibrary::Key_IsButtonAxis	Returns true if the key is a 1D axis that emulates a digital button press (i.

KeyEvent

4 ▼

Access	Type	Name	Description
public	function	UKismetInputLibrary::GetKey	Returns the FKey associated with a keyboard input event, such as the key pressed in an OnKeyDown handler.
public	function	UKismetInputLibrary::GetUserIndex	Returns the index of the local user (controller/player) that generated this key event, for local multiplayer or split-screen input routing.
public	function	UKismetInputLibrary::Key_GetNavigationActionFromKey	Returns the UI navigation action (Accept, Back, or Invalid) corresponding to the key in this key event, or Invalid if no mapping exists.
public	function	UKismetInputLibrary::Key_GetNavigationDirectionFromKey	Returns the directional UI navigation value (Up, Down, Left, Right, Next, Previous, or Invalid) corresponding to the key in this key event.

ModifierKeys

5 ▼

Access	Type	Name	Description
public	function	UKismetInputLibrary::GetModifierKeysState	Returns a snapshot of the current modifier-key state (Shift, Ctrl, Alt, Command) for the application, independent of any specific input event.
public	function	UKismetInputLibrary::ModifierKeysState_IsAltDown	Returns true if either the left or right Alt key was held down when the modifier-key state snapshot was captured.
public	function	UKismetInputLibrary::ModifierKeysState_IsCommandDown	Returns true if either the left or right Command key was held down when the modifier-key state snapshot was captured.
public	function	UKismetInputLibrary::ModifierKeysState_IsControlDown	Returns true if either the left or right Control key was held down when the modifier-key state snapshot was captured.
public	function	UKismetInputLibrary::ModifierKeysState_IsShiftDown	Returns true if either Shift key was held down at the moment the given modifier-keys snapshot was captured.

MotionTracking

1 ▼

Access	Type	Name	Description
public	function	UKismetInputLibrary::CalibrateTilt	Recalibrates the device's tilt input, treating its current orientation as the new neutral/zero position.

PointerEvent

12 ▼

Access	Type	Name	Description
public	function	UKismetInputLibrary::PointerEvent_GetCursorDelta	Returns how far the mouse cursor moved since the last pointer event was handled — the standard source for camera look and drag deltas.
public	function	UKismetInputLibrary::PointerEvent_GetEffectingButton	Returns the specific mouse button that caused this pointer event to be raised, or FKey::Invalid if the event wasn't triggered by a button.
public	function	UKismetInputLibrary::PointerEvent_GetScreenSpacePosition	Returns the current position of the cursor or touch point in screen space, in pixels.
public	function	UKismetInputLibrary::PointerEvent_IsMouseButtonDown	Returns true if the specified mouse button was held down at the time of this pointer event.
public	function	UKismetInputLibrary::PointerEvent_GetLastScreenSpacePosition	Returns the cursor's screen-space position as of the previous pointer event, useful for computing movement manually.
public	function	UKismetInputLibrary::PointerEvent_GetPointerIndex	Returns the unique identifier of the pointer that raised this event — for touch input this is typically the finger index.
public	function	UKismetInputLibrary::PointerEvent_GetWheelDelta	Returns how far the mouse wheel turned since the last mouse event, positive for scrolling up/forward and negative for down/back.
public	function	UKismetInputLibrary::PointerEvent_IsTouchEvent	Returns true if this pointer event originated from a touch input rather than a mouse.
public	function	UKismetInputLibrary::PointerEvent_GetGestureDelta	Returns the change in gesture value since the last gesture event of the same type, such as a pinch-to-zoom or two-finger scroll delta.
public	function	UKismetInputLibrary::PointerEvent_GetGestureType	Returns the type of trackpad/touch gesture — Scroll, Magnify, Swipe, Rotate, or LongPress — associated with this pointer event.
public	function	UKismetInputLibrary::PointerEvent_GetTouchpadIndex	Returns which touchpad generated this event, for platforms and controllers that expose more than one touch surface per user.
public	function	UKismetInputLibrary::PointerEvent_GetUserIndex	Returns the index of the local user (controller/player) that generated this pointer event, for local multiplayer or split-screen input routing.

Version History

Introduced in: unknown

Version	Status	Notes
5.6	stable	—

Feedback

Was this helpful?