InputRemappingNodes.h

Go to the documentation of this file.

// Copyright Blue Isle Studios Inc 2018. All Rights Reserved.
 
#pragma once
#include "Kismet/BlueprintFunctionLibrary.h"
#include "Engine.h"
#include "InputRemappingNodes.generated.h"
 
USTRUCT(Blueprintable)
struct FInputActionMappingStruct
{
    GENERATED_USTRUCT_BODY()
 
    FInputActionMappingStruct() : MappingName(TEXT("")), Key(FKey()), Shift(false), Ctrl(false), Alt(false), Cmd(false) {}
    FInputActionMappingStruct(const FName& InMappingName, const FKey& InKey, const bool& InShift, const bool& InCtrl, const bool& InAlt, const bool& InCmd) : MappingName(InMappingName), Key(InKey), Shift(InShift), Ctrl(InCtrl), Alt(InAlt), Cmd(InCmd) {}
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Action Mapping Struct")
    FName MappingName;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Action Mapping Struct")
    FKey Key;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Action Mapping Struct")
    bool Shift;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Action Mapping Struct")
    bool Ctrl;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Action Mapping Struct")
    bool Alt;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Action Mapping Struct")
    bool Cmd;
};
 
inline bool operator==(const FInputActionMappingStruct &A, const FInputActionMappingStruct &B) {
    return (A.MappingName == B.MappingName) & (A.Key == B.Key) & (A.Shift == B.Shift) & (A.Ctrl == B.Ctrl) & (A.Alt == B.Alt) & (A.Cmd == B.Cmd);
}
 
inline bool operator!=(const FInputActionMappingStruct &A, const FInputActionMappingStruct &B) {
    return !(A.MappingName == B.MappingName) & (A.Key == B.Key) & (A.Shift == B.Shift) & (A.Ctrl == B.Ctrl) & (A.Alt == B.Alt) & (A.Cmd == B.Cmd);
}
 
UENUM(BlueprintType)
enum class EInputCategory : uint8
{
    Movement = 0,
    Combat = 1,
    Communication = 2,
    Miscellaneous = 3
};
// Used for flagging key bindings that shouldn't fire as duplicates
UENUM(BlueprintType)
enum class ELinkedInputTag : uint8
{
    None = 0,
    Boosting = 1,
    QuickChat = 2,
    EscapeButton = 3,
};
 
USTRUCT(BlueprintType)
struct FInputActionRow : public FTableRowBase
{
    GENERATED_USTRUCT_BODY()
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = Customization)
    FText DisplayName;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = Customization)
    FKey GamepadInput;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = Customization)
    FKey KeyboardMouseInput;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = Customization)
    EInputCategory DisplayCategory;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = Customization)
    ELinkedInputTag SubCategory;
};
 
USTRUCT(BlueprintType)
struct FInputAxisRow : public FTableRowBase
{
    GENERATED_USTRUCT_BODY()
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = Customization)
    FName AxisName;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = Customization)
    FText DisplayName;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = Customization)
    FKey GamepadInput;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = Customization)
    FKey KeyboardMouseInput;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = Customization)
    EInputCategory DisplayCategory;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = Customization)
    float Scale;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = Customization)
    bool bShowInSettings;
};
 
USTRUCT(Blueprintable)
struct FInputAxisMappingStruct
{
    GENERATED_USTRUCT_BODY()
 
    FInputAxisMappingStruct() : MappingName(TEXT("")), Key(FKey()), Scale(0) {}
    FInputAxisMappingStruct(const FName& InMappingName, const FKey& InKey, const float& InScale) : MappingName(InMappingName), Key(InKey), Scale(InScale) {}
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Axis Mapping Struct")
    FName MappingName;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Axis Mapping Struct")
    FKey Key;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Axis Mapping Struct")
    float Scale;
};
 
inline bool operator==(const FInputAxisMappingStruct &A, const FInputAxisMappingStruct &B) {
    return (A.MappingName == B.MappingName) & (A.Key == B.Key) & (A.Scale == B.Scale);
}
 
inline bool operator!=(const FInputAxisMappingStruct &A, const FInputAxisMappingStruct &B) {
    return !((A.MappingName == B.MappingName) & (A.Key == B.Key) & (A.Scale == B.Scale));
}
 
 
UENUM(BlueprintType)
enum class EMappingType : uint8
{
    Axis    UMETA(DisplayName = "Axis Mapping"),
    Action  UMETA(DisplayName = "Action Mapping"),
    Auto    UMETA(DisplayName = "Auto")
};
 
UENUM(BlueprintType)
enum class EActionMappingFilter : uint8
{
    Name                    UMETA(DisplayName = "Name"),
    Key                     UMETA(DisplayName = "Key"),
    Shift                   UMETA(DisplayName = "Shift"),
    Ctrl                    UMETA(DisplayName = "Ctrl"),
    Alt                     UMETA(DisplayName = "Alt"),
    Cmd                     UMETA(DisplayName = "Cmd"),
    IsNotGamepad            UMETA(DisplayName = "Exclude Gamepad"),
    IsNotKeyboard           UMETA(DisplayName = "Exclude Keyboard"),
    IsNotMouse              UMETA(DisplayName = "Exclude Mouse Button")
};
 
UENUM(BlueprintType)
enum class EAxisMappingFilter : uint8
{
    Name                    UMETA(DisplayName = "Name"),
    Key                     UMETA(DisplayName = "Key"),
    Scale                   UMETA(DisplayName = "Scale"),
    IsNotGamepad            UMETA(DisplayName = "Exclude Gamepad"),
    IsNotKeyboard           UMETA(DisplayName = "Exclude Keyboard"),
    IsNotMouse              UMETA(DisplayName = "Exclude Mouse Button"),
    IsNotAxis               UMETA(DisplayName = "Exclude Axis Keys")
};
 
UCLASS()
class UInputRebindingNodes : public UBlueprintFunctionLibrary
{
    GENERATED_UCLASS_BODY()
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Mouse Button From Pointer Event", Keywords = "Mouse Button From Pointer Event", Tooltip = "Gives a blueprint accesible way to get the ouse button pressed from A point event"), Category = "Easy Input Remapping")
    static FKey GetMouseButtonPressed(FPointerEvent Event,bool &ValidMouseButton);
 
    UFUNCTION(BlueprintCallable, meta = (DisplayName = "Reset All Key Mappings To Default", Keywords = "Reset Key Bindings To Default", Tooltip = "Restores stock bindings."), Category = "Easy Input Remapping")
    static void ResetToDefault(UDataTable* const InActionMapDataTable, UDataTable* const InAxisMapDataTable);
 
    UFUNCTION(BlueprintCallable, meta = (DisplayName = "Rebind Action Mapping", Keywords = "Map Action Key", Tooltip = "Rebinds the provided action mapping to a new key. Returns false if unsuccessfull."), Category = "Easy Input Remapping")
    static void RebindActionMapping(FInputActionMappingStruct ActionMapping, FInputActionMappingStruct NewData, bool& ReturnValue);
 
    UFUNCTION(BlueprintCallable, meta = (DisplayName = "Rebind Axis Mapping", Keywords = "Map Axis Key", Tooltip = "Rebinds the provided axis mapping to a new key. Returns false if unsuccessfull."), Category = "Easy Input Remapping")
    static void RebindAxisMapping(FInputAxisMappingStruct AxisMapping, FInputAxisMappingStruct NewData, bool& ReturnValue);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Get All Action Mappings", Tooltip = "This returns action mappings, which can be filtered by the filters you input (Both inputs are optional). To only get action mappings that have a certain property, add a filter, and specify the value of that property in the 'Filter Data' input. As an example, if you add 'Key' as a filter, it will only return action mappings that use the key specified in the 'Filter Data' input. As another example: If you add the filter 'Exclude Keyboard', only non-keyboard keys will be outputted, such as Mouse & Gamepad. Adding more than 1 of the same filter will not do anything.", AutoCreateRefTerm = "Filters"), Category = "Easy Input Remapping")
    static void GetAllActionMappings(FInputActionMappingStruct FilterData, TArray<EActionMappingFilter> Filters, bool& ReturnValue, TArray<FInputActionMappingStruct>& ActionMappings);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Get All Axis Mappings", Tooltip = "This returns action mappings, which can be filtered by the filters you input (Both inputs are optional). To only get action mappings that have a certain property, add a filter, and specify the value of that property in the 'Filter Data' input. As an example, if you add 'Key' as a filter, it will only return action mappings that use the key specified in the 'Filter Data' input. As another example: If you add the filter 'Exclude Keyboard', only non-keyboard keys will be outputted, such as Mouse & Gamepad. Adding more than 1 of the same filter will not do anything.", AutoCreateRefTerm = "Filters"), Category = "Easy Input Remapping")
    static void GetAllAxisMappings(FInputAxisMappingStruct FilterData, TArray<EAxisMappingFilter> Filters, bool& ReturnValue, TArray<FInputAxisMappingStruct>& AxisMappings);
 
    UFUNCTION(BlueprintCallable, meta = (DisplayName = "Create New Action Mapping", Tooltip = "Creates a new action mapping using the data specified. This can easily clutter your config files if you blindly make new action mappings without ever deleting them, so be aware. Returns false if the specified action mapping already exists."), Category = "Easy Input Remapping")
    static void CreateNewActionMapping(FInputActionMappingStruct MappingData, bool& ReturnValue);
 
    UFUNCTION(BlueprintCallable, meta = (DisplayName = "Create New Axis Mapping", Tooltip = "Creates a new axis mapping using the data specified. This can easily clutter your config files if you blindly make new axis mappings without ever deleting them, so be aware. Returns false if the specified axis mapping already exists."), Category = "Easy Input Remapping")
    static void CreateNewAxisMapping(FInputAxisMappingStruct MappingData, bool& ReturnValue);
 
    UFUNCTION(BlueprintCallable, meta = (DisplayName = "Remove Action Mapping", Tooltip = "Completely removes/deletes the specified action mapping. Returns false if the specified action mapping is not found."), Category = "Easy Input Remapping")
    static void RemoveActionMapping(FInputActionMappingStruct MappingData, bool& ReturnValue);
 
    UFUNCTION(BlueprintCallable, meta = (DisplayName = "Remove Axis Mapping", Tooltip = "Completely removes/deletes the specified axis mapping. Returns false if the specified axis mapping is not found."), Category = "Easy Input Remapping")
    static void RemoveAxisMapping(FInputAxisMappingStruct MappingData, bool& ReturnValue);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Equal (ActionMapping)", Tooltip = "Returns true if A is exactly equal to B (A == B)", CompactNodeTitle = "==", AutoCreateRefTerm = "A,B"), Category = "Easy Input Remapping")
    static bool ActionMappingEqualActionMapping(const FInputActionMappingStruct& A, const FInputActionMappingStruct& B);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "NotEqual (ActionMapping)", Tooltip = "Returns true if A does not equal B (A != B)", CompactNodeTitle = "!=", AutoCreateRefTerm = "A,B"), Category = "Easy Input Remapping")
    static bool ActionMappingNotEqualActionMapping(const FInputActionMappingStruct& A, const FInputActionMappingStruct& B);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Equal (AxisMapping)", Tooltip = "Returns true if A is exactly equal to B (A == B)", CompactNodeTitle = "==", AutoCreateRefTerm = "A,B"), Category = "Easy Input Remapping")
    static bool AxisMappingEqualActionMapping(const FInputAxisMappingStruct& A, const FInputAxisMappingStruct& B);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "NotEqual (AxisMapping)", Tooltip = "Returns true if A does not equal B (A != B)", CompactNodeTitle = "!=", AutoCreateRefTerm = "A,B"), Category = "Easy Input Remapping")
    static bool AxisMappingNotEqualActionMapping(const FInputAxisMappingStruct& A, const FInputAxisMappingStruct& B);
};