InputSettings.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 "UObject/Object.h"
#include "InputCoreTypes.h"
#include "UObject/SoftObjectPath.h"
#include "GameFramework/PlayerInput.h"
#include "GenericPlatform/InputDeviceMappingPolicy.h"
#include "Components/InputComponent.h"
#include "Engine/PlatformSettings.h"
 
#include "InputSettings.generated.h"
 
UCLASS(config=Input, defaultconfig, MinimalAPI)
class UInputSettings
    : public UObject
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(config, EditAnywhere, EditFixedSize, Category="Bindings", meta=(ToolTip="List of Axis Properties"), AdvancedDisplay)
    TArray<struct FInputAxisConfigEntry> AxisConfig;
 
    UPROPERTY(EditAnywhere, Category = "Platforms")
    FPerPlatformSettings PlatformSettings;
 
    UPROPERTY(config, EditAnywhere, Category="Bindings", AdvancedDisplay)
    uint8 bAltEnterTogglesFullscreen:1;
 
    UPROPERTY(config, EditAnywhere, Category = "Bindings", AdvancedDisplay)
    uint8 bF11TogglesFullscreen : 1;
 
    // Allow mouse to be used for touch
    UPROPERTY(config, EditAnywhere, Category="MouseProperties", AdvancedDisplay)
    uint8 bUseMouseForTouch:1;
 
    // Mouse smoothing control
    UPROPERTY(config, EditAnywhere, Category="MouseProperties", AdvancedDisplay)
    uint8 bEnableMouseSmoothing:1;
 
    // Scale the mouse based on the player camera manager's field of view
    UPROPERTY(config, EditAnywhere, Category="MouseProperties", AdvancedDisplay)
    uint8 bEnableFOVScaling:1;
 
    UPROPERTY(config, EditAnywhere, Category = "ViewportProperties")
    uint8 bCaptureMouseOnLaunch:1;
 
    UPROPERTY(config, EditAnywhere, Category = "Input")
    uint8 bEnableLegacyInputScales:1;
    
    UPROPERTY(config, EditAnywhere, Category = "Input")
    uint8 bEnableMotionControls:1;
 
    UPROPERTY(config, EditAnywhere, Category = "Input")
    uint8 bFilterInputByPlatformUser:1;
 
    UPROPERTY(config, EditAnywhere, Category = "Input")
    uint8 bShouldFlushPressedKeysOnViewportFocusLost:1;
 
    UE_DEPRECATED(5.7, "bEnableDynamicComponentInputBinding is deprecated.")
    UPROPERTY(config, meta = (DeprecatedProperty, DeprecationMessage = "bEnableDynamicComponentInputBinding is deprecated, it will be treated as always being true."))
    uint8 bEnableDynamicComponentInputBinding:1;
    
    UPROPERTY(config, EditAnywhere, Category="Mobile")
    uint8 bAlwaysShowTouchInterface:1;
 
    UPROPERTY(config, EditAnywhere, Category="Mobile")
    uint8 bShowConsoleOnFourFingerTap:1;
 
    UPROPERTY(config, EditAnywhere, Category = "Mobile")
    uint8 bEnableGestureRecognizer:1;
 
    UPROPERTY(config, EditAnywhere, Category = "Virtual Keyboard (Mobile)")
    uint8 bUseAutocorrect:1;
    
    UPROPERTY(config, EditAnywhere, Category="Bindings")
    uint8 bEnabledLegacyMappingDeprecationWarnings : 1;
 
    UPROPERTY(config, EditAnywhere, AdvancedDisplay, Category = "Virtual Keyboard (Mobile)")
    TArray<FString> ExcludedAutocorrectOS;
 
    UPROPERTY(config, EditAnywhere, AdvancedDisplay, Category = "Virtual Keyboard (Mobile)")
    TArray<FString> ExcludedAutocorrectCultures;
 
    UPROPERTY(config, EditAnywhere, AdvancedDisplay, Category = "Virtual Keyboard (Mobile)")
    TArray<FString> ExcludedAutocorrectDeviceModels;
 
    UPROPERTY(config, EditAnywhere, Category = "ViewportProperties")
    EMouseCaptureMode DefaultViewportMouseCaptureMode;
 
    UPROPERTY(config, EditAnywhere, Category = "ViewportProperties")
    EMouseLockMode DefaultViewportMouseLockMode;
 
    // The scaling value to multiply the field of view by
    UPROPERTY(config, EditAnywhere, Category="MouseProperties", AdvancedDisplay, meta=(editcondition="bEnableFOVScaling"))
    float FOVScale;
 
    UPROPERTY(config, EditAnywhere, Category="MouseProperties", AdvancedDisplay)
    float DoubleClickTime;
 
private:
    UPROPERTY(config, EditAnywhere, Category="Bindings")
    TArray<struct FInputActionKeyMapping> ActionMappings;
 
    UPROPERTY(config, EditAnywhere, Category="Bindings")
    TArray<struct FInputAxisKeyMapping> AxisMappings;
 
    UPROPERTY(config, VisibleAnywhere, Category="Bindings")
    TSet<FName> DeprecatedActionAndAxisNames;
 
    UE_DEPRECATED(5.7, "SpeechMappings are deprecated. These were only used by a now deprecated platform.")
    PRAGMA_DISABLE_DEPRECATION_WARNINGS
    UPROPERTY(config, EditAnywhere, Category = "Bindings")
    TArray<struct FInputActionSpeechMapping> SpeechMappings;
    PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
    UPROPERTY(config, EditAnywhere, NoClear, Category = DefaultClasses)
    TSoftClassPtr<UPlayerInput> DefaultPlayerInputClass;
 
    UPROPERTY(config, EditAnywhere, NoClear, Category = DefaultClasses)
    TSoftClassPtr<UInputComponent> DefaultInputComponentClass;
 
public:
    UPROPERTY(config, EditAnywhere, Category="Mobile", meta=(AllowedClasses="/Script/Engine.TouchInterface"))
    FSoftObjectPath DefaultTouchInterface;
 
    UPROPERTY(config, EditAnywhere, Category="Console")
    TArray<FKey> ConsoleKeys;
 
    // UObject interface
#if WITH_EDITOR
    ENGINE_API virtual void PostEditChangeChainProperty(struct FPropertyChangedChainEvent& PropertyChangedEvent) override;
#endif
 
    ENGINE_API virtual void PostReloadConfig(class FProperty* PropertyThatWasLoaded) override;
 
    ENGINE_API void RemoveInvalidKeys();
 
    ENGINE_API virtual void PostInitProperties() override;
    // End of UObject interface
 
    UFUNCTION(BlueprintPure, Category = Settings)
    static ENGINE_API UInputSettings* GetInputSettings();
 
    UFUNCTION(BlueprintCallable, Category = Settings)
    ENGINE_API void AddActionMapping(const FInputActionKeyMapping& KeyMapping, bool bForceRebuildKeymaps = true);
 
    UFUNCTION(BlueprintPure, Category = Settings)
    ENGINE_API void GetActionMappingByName(const FName InActionName, TArray<FInputActionKeyMapping>& OutMappings) const;
 
    UFUNCTION(BlueprintCallable, Category = Settings)
    ENGINE_API void RemoveActionMapping(const FInputActionKeyMapping& KeyMapping, bool bForceRebuildKeymaps = true);
 
    UFUNCTION(BlueprintCallable, Category = Settings)
    ENGINE_API void AddAxisMapping(const FInputAxisKeyMapping& KeyMapping, bool bForceRebuildKeymaps = true);
 
    UFUNCTION(BlueprintPure, Category = Settings)
    ENGINE_API void GetAxisMappingByName(const FName InAxisName, TArray<FInputAxisKeyMapping>& OutMappings) const;
 
    UFUNCTION(BlueprintCallable, Category = Settings)
    ENGINE_API void RemoveAxisMapping(const FInputAxisKeyMapping& KeyMapping, bool bForceRebuildKeymaps = true);
 
#if WITH_EDITOR 
    UFUNCTION()
    static ENGINE_API const TArray<FName>& GetAllActionAndAxisNames();
#endif// WITH_EDITOR
 
    UFUNCTION(BlueprintCallable, Category=Settings)
    ENGINE_API void SaveKeyMappings();
 
    UFUNCTION(BlueprintCallable, Category = Settings)
    ENGINE_API void GetActionNames(TArray<FName>& ActionNames) const;
 
    ENGINE_API bool IsActionMappingDeprecated(const FName ActionName) const;
    ENGINE_API void SetActionMappingDeprecated(const FName ActionName, const bool bIsDeprecated);
 
    UFUNCTION(BlueprintCallable, Category = Settings)
    ENGINE_API void GetAxisNames(TArray<FName>& AxisNames) const;
 
    UFUNCTION(BlueprintCallable, Category = Settings)
    ENGINE_API void ForceRebuildKeymaps();
 
    ENGINE_API FName GetUniqueActionName(const FName BaseActionMappingName);
    ENGINE_API FName GetUniqueAxisName(const FName BaseAxisMappingName);
 
    ENGINE_API void AddActionMapping(FInputActionKeyMapping& NewMapping);
    ENGINE_API void AddAxisMapping(FInputAxisKeyMapping& NewMapping);
 
    ENGINE_API const TArray <FInputActionKeyMapping>& GetActionMappings() const;
    ENGINE_API const TArray <FInputAxisKeyMapping>& GetAxisMappings() const;
 
    UE_DEPRECATED(5.7, "Speech Mappings are deprecated. These were only used by a now deprecated platform.")
    PRAGMA_DISABLE_DEPRECATION_WARNINGS
    ENGINE_API const TArray <FInputActionSpeechMapping>& GetSpeechMappings() const;
    PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
    ENGINE_API bool DoesActionExist(const FName InActionName);
    ENGINE_API bool DoesAxisExist(const FName InAxisName);
    
    UE_DEPRECATED(5.7, "Speech Mappings are deprecated. These were only used by a now deprecated platform.")
    ENGINE_API bool DoesSpeechExist(const FName InSpeechName);
 
 
    static ENGINE_API const FName GetActionMappingsPropertyName();
    static ENGINE_API const FName GetAxisMappingsPropertyName();
 
    // Class accessors
    static ENGINE_API UClass* GetDefaultPlayerInputClass();
    static ENGINE_API UClass* GetDefaultInputComponentClass();
    
    static ENGINE_API void SetDefaultPlayerInputClass(TSubclassOf<UPlayerInput> NewDefaultPlayerInputClass);
 
    static ENGINE_API void SetDefaultInputComponentClass(TSubclassOf<UInputComponent> NewDefaultInputComponentClass);
    
private:
    void PopulateAxisConfigs();
    void AddInternationalConsoleKey();
};
 
 
UENUM(BlueprintType, Meta = (Bitflags, UseEnumValuesAsMaskValuesInEditor = "true"))
namespace EHardwareDeviceSupportedFeatures
{
    enum Type : int32
    {
        Unspecified         = 0x00000000,
 
        Keypress            = 0x00000001,
 
        Pointer             = 0x00000002,
 
        Gamepad             = 0x00000004,
 
        Touch               = 0x00000008,
 
        Camera              = 0x00000010,
 
        MotionTracking      = 0x00000020,
 
        Lights              = 0x00000040,
 
        TriggerHaptics      = 0x00000080,
 
        ForceFeedback       = 0x00000100,
 
        AudioBasedVibrations= 0x00000200,
 
        Acceleration        = 0x00000400,
 
        Virtual             = 0x00000800,
 
        Microphone          = 0x00001000,
 
        Orientation         = 0x00002000,
 
        Guitar              = 0x00004000,
 
        Drums               = 0x00008000,
 
        CustomA             = 0x01000000,
        CustomB             = 0x02000000,
        CustomC             = 0x04000000,
        CustomD             = 0x08000000,
 
        All = 0x7FFFFFFF UMETA(Hidden),
    };
}
 
ENUM_CLASS_FLAGS(EHardwareDeviceSupportedFeatures::Type);
 
UENUM(BlueprintType)
enum class EHardwareDevicePrimaryType : uint8
{
    Unspecified,
    KeyboardAndMouse,
    Gamepad,
    Touch,
    MotionTracking,
    RacingWheel,
    FlightStick,
    Camera,
    Instrument,
 
    // Some custom devices that can be used for your game specific hardware if desired
    CustomTypeA,
    CustomTypeB,
    CustomTypeC,
    CustomTypeD,
};
 
USTRUCT(BlueprintType)
struct FHardwareDeviceIdentifier
{
    GENERATED_BODY()
 
    ENGINE_API FHardwareDeviceIdentifier();
    
    ENGINE_API FHardwareDeviceIdentifier(
        const FName InClassName,
        const FName InHardwareDeviceIdentifier,
        EHardwareDevicePrimaryType InPrimaryType = EHardwareDevicePrimaryType::Unspecified,
        EHardwareDeviceSupportedFeatures::Type Flags = EHardwareDeviceSupportedFeatures::Unspecified);
    
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Hardware")
    FName InputClassName;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Hardware")
    FName HardwareDeviceIdentifier;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Hardware")
    EHardwareDevicePrimaryType PrimaryDeviceType;
    
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Hardware", meta=(Bitmask, BitmaskEnum="/Script/Engine.EHardwareDeviceSupportedFeatures"))
    int32 SupportedFeaturesMask;
 
    ENGINE_API bool HasAnySupportedFeatures(const EHardwareDeviceSupportedFeatures::Type FlagsToCheck) const;
 
    ENGINE_API bool HasAllSupportedFeatures(const EHardwareDeviceSupportedFeatures::Type FlagsToCheck) const;
 
    ENGINE_API bool IsValid() const;
 
    ENGINE_API FString ToString() const;
    
    static ENGINE_API FHardwareDeviceIdentifier Invalid;
 
    static ENGINE_API FHardwareDeviceIdentifier DefaultKeyboardAndMouse;
 
    static ENGINE_API FHardwareDeviceIdentifier DefaultGamepad;
 
    static ENGINE_API FHardwareDeviceIdentifier DefaultMobileTouch;
 
    ENGINE_API bool operator==(const FHardwareDeviceIdentifier& Other) const;
    ENGINE_API bool operator!=(const FHardwareDeviceIdentifier& Other) const;
 
    ENGINE_API friend uint32 GetTypeHash(const FHardwareDeviceIdentifier& InDevice);
    ENGINE_API friend FArchive& operator<<(FArchive& Ar, FHardwareDeviceIdentifier& InDevice);
};
 
UCLASS(config=Input, defaultconfig, MinimalAPI)
class UInputPlatformSettings : public UPlatformSettings
{
    GENERATED_BODY()
 
public:
 
    ENGINE_API UInputPlatformSettings();
    
    static ENGINE_API UInputPlatformSettings* Get();
 
#if WITH_EDITOR
    UFUNCTION()
    static ENGINE_API const TArray<FName>& GetAllHardwareDeviceNames();
#endif  // WITH_EDITOR
 
 
    ENGINE_API const FHardwareDeviceIdentifier* GetHardwareDeviceForClassName(const FName InHardwareDeviceIdentifier) const;
    
    ENGINE_API void AddHardwareDeviceIdentifier(const FHardwareDeviceIdentifier& InHardwareDevice);
 
    ENGINE_API const TArray<FHardwareDeviceIdentifier>& GetHardwareDevices() const;
 
    // Input Device Mapping
 
    UPROPERTY(config, EditAnywhere, Category = "Device Mapping")
    int32 MaxPlatformUserCount;
 
    UPROPERTY(config, EditAnywhere, Category = "Device Mapping", meta=(ConsoleVariable="input.DeviceMappingPolicy"))
    EInputDeviceMappingPolicy DeviceMappingPolicy;
    
    // Trigger Feedback
    
    UPROPERTY(config, EditAnywhere, Category = "Device Properties|Trigger Feedback", meta = (UIMin = "0"))
    int32 MaxTriggerFeedbackPosition;
 
    UPROPERTY(config, EditAnywhere, Category = "Device Properties|Trigger Feedback", meta = (UIMin = "0"))
    int32 MaxTriggerFeedbackStrength;
 
    // Trigger Vibrations
    
    UPROPERTY(config, EditAnywhere, Category = "Device Properties|Trigger Vibration", meta = (UIMin = "0"))
    int32 MaxTriggerVibrationTriggerPosition;
 
    UPROPERTY(config, EditAnywhere, Category = "Device Properties|Trigger Vibration", meta = (UIMin = "0"))
    int32 MaxTriggerVibrationFrequency;
 
    UPROPERTY(config, EditAnywhere, Category = "Device Properties|Trigger Vibration", meta = (UIMin = "0"))
    int32 MaxTriggerVibrationAmplitude;
    
protected:
 
#if WITH_EDITOR
    ENGINE_API virtual void PostEditChangeChainProperty(struct FPropertyChangedChainEvent& PropertyChangedEvent) override;
#endif
 
    UPROPERTY(config, EditAnywhere, Category = "Hardware")
    TArray<FHardwareDeviceIdentifier> HardwareDevices;
};