KismetInputLibrary.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "InputCoreTypes.h"
#include "Framework/Commands/InputChord.h"
#include "Input/Events.h"
#include "Kismet/BlueprintFunctionLibrary.h"
#include "KismetInputLibrary.generated.h"
 
class FModifierKeysState;
 
UENUM(BlueprintType)
enum class ESlateGesture : uint8
{
    None,
    Scroll,
    Magnify,
    Swipe,
    Rotate,
    LongPress
};
 
USTRUCT(BlueprintType, DisplayName="Modifier Keys State")
struct FSlateModifierKeysState
{
    GENERATED_USTRUCT_BODY()
 
    UPROPERTY()
    uint8 ModifierKeysStateMask = 0;
 
    FSlateModifierKeysState() {}
    FSlateModifierKeysState(const FModifierKeysState& InModifierKeysState); 
};
 
UCLASS(meta=(ScriptName="InputLibrary"), MinimalAPI)
class UKismetInputLibrary : public UBlueprintFunctionLibrary
{
    GENERATED_UCLASS_BODY()
 
    
    UFUNCTION(BlueprintCallable, Category="Input|MotionTracking")
    static ENGINE_API void CalibrateTilt();
 
    UFUNCTION(BlueprintPure, meta=(DisplayName = "Equal (Key)", CompactNodeTitle = "=="), Category="Input|Key")
    static ENGINE_API bool EqualEqual_KeyKey(FKey A, FKey B);
 
    UFUNCTION( BlueprintPure, meta = ( DisplayName = "Equal (InputChord)", CompactNodeTitle = "==" ), Category = "Input|Key" )
    static ENGINE_API bool EqualEqual_InputChordInputChord( FInputChord A, FInputChord B );
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Is Modifier Key"), Category="Input|Key")
    static ENGINE_API bool Key_IsModifierKey(const FKey& Key);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Is Gamepad Key"), Category="Input|Key")
    static ENGINE_API bool Key_IsGamepadKey(const FKey& Key);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Is Mouse Button"), Category="Input|Key")
    static ENGINE_API bool Key_IsMouseButton(const FKey& Key);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Is Keyboard Key"), Category="Input|Key")
    static ENGINE_API bool Key_IsKeyboardKey(const FKey& Key);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Is Axis 1D"), Category="Input|Key")
    static ENGINE_API bool Key_IsAxis1D(const FKey& Key);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Is Axis 2D"), Category="Input|Key")
    static ENGINE_API bool Key_IsAxis2D(const FKey& Key);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Is Axis 3D"), Category="Input|Key")
    static ENGINE_API bool Key_IsAxis3D(const FKey& Key);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Is Button Axis"), Category = "Input|Key")
    static ENGINE_API bool Key_IsButtonAxis(const FKey& Key);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Is Analog"), Category = "Input|Key")
    static ENGINE_API bool Key_IsAnalog(const FKey& Key);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Is Digital"), Category = "Input|Key")
    static ENGINE_API bool Key_IsDigital(const FKey& Key);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Is Valid Key"), Category = "Input|Key")
    static ENGINE_API bool Key_IsValid(const FKey& Key);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Get Key Navigation Action", DeprecatedFunction, DeprecationMessage = "Use Get Key Event Navigation Action instead"), Category = "Input|Key")
    static ENGINE_API EUINavigationAction Key_GetNavigationAction(const FKey& InKey);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Get Key Event Navigation Action"), Category = "Input|KeyEvent")
    static ENGINE_API EUINavigationAction Key_GetNavigationActionFromKey(const FKeyEvent& InKeyEvent);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Get Key Event Navigation Direction"), Category = "Input|KeyEvent")
    static ENGINE_API EUINavigation Key_GetNavigationDirectionFromKey(const FKeyEvent& InKeyEvent);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Get Analog Event Navigation Direction"), Category = "Input|AnalogEvent")
    static ENGINE_API EUINavigation Key_GetNavigationDirectionFromAnalog(const FAnalogInputEvent& InAnalogEvent);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Get Key Display Name", BlueprintAutocast), Category="Input|Key")
    static ENGINE_API FText Key_GetDisplayName(const FKey& Key, bool bLongDisplayName = true);
 
    UFUNCTION(BlueprintPure, meta=( DisplayName = "Is Repeat" ), Category="Input|InputEvent")
    static ENGINE_API bool InputEvent_IsRepeat(const FInputEvent& Input);
 
    UFUNCTION(BlueprintPure, meta=( DisplayName = "Is Shift Down" ), Category="Input|InputEvent")
    static ENGINE_API bool InputEvent_IsShiftDown(const FInputEvent& Input);
 
    UFUNCTION(BlueprintPure, meta=( DisplayName = "Is Left Shift Down" ), Category="Input|InputEvent")
    static ENGINE_API bool InputEvent_IsLeftShiftDown(const FInputEvent& Input);
 
    UFUNCTION(BlueprintPure, meta=( DisplayName = "Is Right Shift Down" ), Category="Input|InputEvent")
    static ENGINE_API bool InputEvent_IsRightShiftDown(const FInputEvent& Input);
 
    UFUNCTION(BlueprintPure, meta=( DisplayName = "Is Control Down" ), Category="Input|InputEvent")
    static ENGINE_API bool InputEvent_IsControlDown(const FInputEvent& Input);
 
    UFUNCTION(BlueprintPure, meta=( DisplayName = "Is Left Control Down" ), Category="Input|InputEvent")
    static ENGINE_API bool InputEvent_IsLeftControlDown(const FInputEvent& Input);
 
    UFUNCTION(BlueprintPure, meta=( DisplayName = "Is Right Control Down" ), Category="Input|InputEvent")
    static ENGINE_API bool InputEvent_IsRightControlDown(const FInputEvent& Input);
 
    UFUNCTION(BlueprintPure, meta=( DisplayName = "Is Alt Down" ), Category="Input|InputEvent")
    static ENGINE_API bool InputEvent_IsAltDown(const FInputEvent& Input);
 
    UFUNCTION(BlueprintPure, meta=( DisplayName = "Is Left Alt Down" ), Category="Input|InputEvent")
    static ENGINE_API bool InputEvent_IsLeftAltDown(const FInputEvent& Input);
 
    UFUNCTION(BlueprintPure, meta=( DisplayName = "Is Right Alt Down" ), Category="Input|InputEvent")
    static ENGINE_API bool InputEvent_IsRightAltDown(const FInputEvent& Input);
 
    UFUNCTION(BlueprintPure, meta=( DisplayName = "Is Command Down" ), Category="Input|InputEvent")
    static ENGINE_API bool InputEvent_IsCommandDown(const FInputEvent& Input);
 
    UFUNCTION(BlueprintPure, meta=( DisplayName = "Is Left Command Down" ), Category="Input|InputEvent")
    static ENGINE_API bool InputEvent_IsLeftCommandDown(const FInputEvent& Input);
 
    UFUNCTION(BlueprintPure, meta=( DisplayName = "Is Right Command Down" ), Category="Input|InputEvent")
    static ENGINE_API bool InputEvent_IsRightCommandDown(const FInputEvent& Input);
 
    UFUNCTION(BlueprintPure, meta=( DisplayName = "Is Shift Down" ), Category="Input|ModifierKeys")
    static ENGINE_API bool ModifierKeysState_IsShiftDown(const FSlateModifierKeysState& KeysState);
 
    UFUNCTION(BlueprintPure, meta=( DisplayName = "Is Control Down" ), Category="Input|ModifierKeys")
    static ENGINE_API bool ModifierKeysState_IsControlDown(const FSlateModifierKeysState& KeysState);
 
    UFUNCTION(BlueprintPure, meta=( DisplayName = "Is Alt Down" ), Category="Input|ModifierKeys")
    static ENGINE_API bool ModifierKeysState_IsAltDown(const FSlateModifierKeysState& KeysState);
 
    UFUNCTION(BlueprintPure, meta=( DisplayName = "Is Command Down" ), Category="Input|ModifierKeys")
    static ENGINE_API bool ModifierKeysState_IsCommandDown(const FSlateModifierKeysState& KeysState);
 
    UFUNCTION(BlueprintPure, Category = "Input|ModifierKeys")
    static ENGINE_API FSlateModifierKeysState GetModifierKeysState();
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Get Input Chord Display Name"), Category = "Input|Key")
    static ENGINE_API FText InputChord_GetDisplayName(const FInputChord& Key);
 
    UFUNCTION(BlueprintPure, Category="Input|KeyEvent")
    static ENGINE_API FKey GetKey(const FKeyEvent& Input);
 
    UFUNCTION(BlueprintPure, Category = "Input|KeyEvent")
    static ENGINE_API int32 GetUserIndex(const FKeyEvent& Input);
 
    UFUNCTION(BlueprintPure, Category = "Input|InputEvent")
    static ENGINE_API float GetAnalogValue(const FAnalogInputEvent& Input);
 
    UFUNCTION(BlueprintPure, meta=( DisplayName = "Get Screen Space Position" ), Category="Input|PointerEvent")
    static ENGINE_API FVector2D PointerEvent_GetScreenSpacePosition(const FPointerEvent& Input);
 
    UFUNCTION(BlueprintPure, meta=( DisplayName = "Get Last Screen Space Position" ), Category="Input|PointerEvent")
    static ENGINE_API FVector2D PointerEvent_GetLastScreenSpacePosition(const FPointerEvent& Input);
 
    UFUNCTION(BlueprintPure, meta=( DisplayName = "Get Cursor Delta" ), Category="Input|PointerEvent")
    static ENGINE_API FVector2D PointerEvent_GetCursorDelta(const FPointerEvent& Input);
 
    UFUNCTION(BlueprintPure, meta=( DisplayName = "Is Mouse Button Down" ), Category="Input|PointerEvent")
    static ENGINE_API bool PointerEvent_IsMouseButtonDown(const FPointerEvent& Input, FKey MouseButton);
 
    UFUNCTION(BlueprintPure, meta=( DisplayName = "Get Effecting Button" ), Category="Input|PointerEvent")
    static ENGINE_API FKey PointerEvent_GetEffectingButton(const FPointerEvent& Input);
 
    UFUNCTION(BlueprintPure, meta=( DisplayName = "Get Wheel Delta" ), Category="Input|PointerEvent")
    static ENGINE_API float PointerEvent_GetWheelDelta(const FPointerEvent& Input);
 
    UFUNCTION(BlueprintPure, meta=( DisplayName = "Get User Index" ), Category="Input|PointerEvent")
    static ENGINE_API int32 PointerEvent_GetUserIndex(const FPointerEvent& Input);
 
    UFUNCTION(BlueprintPure, meta=( DisplayName = "Get Pointer Index" ), Category="Input|PointerEvent")
    static ENGINE_API int32 PointerEvent_GetPointerIndex(const FPointerEvent& Input);
 
    UFUNCTION(BlueprintPure, meta=( DisplayName = "Get Touchpad Index" ), Category="Input|PointerEvent")
    static ENGINE_API int32 PointerEvent_GetTouchpadIndex(const FPointerEvent& Input);
 
    UFUNCTION(BlueprintPure, meta=( DisplayName = "Is Touch Event" ), Category="Input|PointerEvent")
    static ENGINE_API bool PointerEvent_IsTouchEvent(const FPointerEvent& Input);
 
    UFUNCTION(BlueprintPure, Category="Input|PointerEvent")
    static ENGINE_API ESlateGesture PointerEvent_GetGestureType(const FPointerEvent& Input);
 
    UFUNCTION(BlueprintPure, meta=( DisplayName = "Get Gesture Delta" ), Category="Input|PointerEvent")
    static ENGINE_API FVector2D PointerEvent_GetGestureDelta(const FPointerEvent& Input);
};