1. Epic GamesDeveloper
  3. UKismetInputLibrary

UKismetInputLibrary

Unreal Engine C++ API Reference > Runtime > Engine > Kismet

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

  Type Name Description
Public function  

UKismetInputLibrary ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Static void Calibrate the tilt for the input device
Public function Static bool Test if the input chords are equal (A == B)
Public function Static bool Test if the input key are equal (A == B)
Public function Static float  
Public function Static FKey

GetKey ( const FKeyEvent& Input
)

 Returns the key for this event.
Public function Static FSlateModifierKeysState Returns a snapshot of the cached modifier-keys state for the application.
Public function Static int32

GetUserIndex ( const FKeyEvent& Input
)

  
Public function Static FText  
Public function Static bool Returns true if either alt key was down when this event occurred
Public function Static bool Returns true if either command key was down when this event occurred
Public function Static bool Returns true if either control key was down when this event occurred
Public function Static bool Returns true if left alt key was down when this event occurred
Public function Static bool Returns true if left command key was down when this event occurred
Public function Static bool Returns true if left control key was down when this event occurred
Public function Static bool 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 Returns true if right alt key was down when this event occurred
Public function Static bool Returns true if right command key was down when this event occurred
Public function Static bool Returns true if left control key was down when this event occurred
Public function Static bool Returns true if right shift key was down when this event occurred
Public function Static bool Returns true if either shift key was down when this event occurred
Public function Static FText

Key_GetDisplayName ( const FKey& Key,
bool bLongDisplayName
)

 Returns the display name of the key.
Public function Static EUINavigationAction

Key_GetNavigationAction ( const FKey& InKey
)

  
Public function Static EUINavigationAction Returns the navigation action corresponding to this key, or Invalid if not found
Public function Static EUINavigation Returns the navigation action corresponding to this key, or Invalid if not found
Public function Static EUINavigation 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 Deprecated. Use Is Axis 2D/3D instead.
Public function Static bool Returns true if either alt key was down when the key state was captured
Public function Static bool Returns true if either command key was down when the key state was captured
Public function Static bool Returns true if either control key was down when the key state was captured
Public function Static bool Returns true if either shift key was down when the key state was captured
Public function Static FVector2D Returns the distance the mouse traveled since the last event was handled.
Public function Static FKey Mouse button that caused this event to be raised (possibly FKey::Invalid)
Public function Static FVector2D Returns the change in gesture value since the last gesture event of the same type.
Public function Static ESlateGesture Returns the type of touch gesture
Public function Static FVector2D Returns the position of the cursor in screen space last time we handled an input event
Public function Static int32 Returns the unique identifier of the pointer (e.g., finger index)
Public function Static FVector2D Returns The position of the cursor in screen space
Public function Static int32 Returns the index of the touch pad that generated this event (for platforms with multiple touch pads per user)
Public function Static int32 Returns the index of the user that caused the event
Public function Static float 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 Returns true if this event a result from a touch (as opposed to a mouse)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page