ConsoleSettings.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 "ConsoleSettings.generated.h"
 
 
USTRUCT()
struct FAutoCompleteCommand
{
    GENERATED_USTRUCT_BODY()
 
    UPROPERTY(config, EditAnywhere, Category=Command)
    FString Command;
 
    UPROPERTY(config, EditAnywhere, Category=Command)
    FString Desc;
 
    FColor Color = FColor(180, 180, 180);
 
    bool operator<(const FAutoCompleteCommand& rhs) const
    {
        return Command < rhs.Command;
    }
 
    // for game console 
    const FString& GetLeft() const
    {
        return IsHistory() ? Desc : Command;
    }
 
    // for game console 
    const FString& GetRight() const
    {
        return IsHistory() ? Command : Desc;
    }
 
    // @return true:history, false: autocompletion
    bool IsHistory() const
    {
        return Desc == TEXT(">");
    }
    void SetHistory()
    {
        Desc = TEXT(">");
    }
};
 
 
UCLASS(config=Input, defaultconfig, MinimalAPI)
class UConsoleSettings
    : public UObject
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(globalconfig, EditAnywhere, Category=General)
    int32 MaxScrollbackSize;
 
    UPROPERTY(config, EditAnywhere, Category=AutoComplete)
    TArray<struct FAutoCompleteCommand> ManualAutoCompleteList;
 
    UPROPERTY(config, EditAnywhere, Category=AutoComplete)
    TArray<FString> AutoCompleteMapPaths;
 
    UPROPERTY(config, EditAnywhere, Category=Colors, meta=(UIMin="0", UIMax="100", ClampMin="0", ClampMax="100"))
    float BackgroundOpacityPercentage;
 
    UPROPERTY(config, EditAnywhere, Category = AutoComplete)
    bool bOrderTopToBottom;
 
    UPROPERTY(config, EditAnywhere, Category = AutoComplete)
    bool bDisplayHelpInAutoComplete = true;
 
    UPROPERTY(config, EditAnywhere, Category=Colors)
    FColor InputColor;
 
    UPROPERTY(config, EditAnywhere, Category=Colors)
    FColor HistoryColor;
 
    UPROPERTY(config, EditAnywhere, Category=Colors)
    FColor AutoCompleteCommandColor;
 
    UPROPERTY(config, EditAnywhere, Category=Colors)
    FColor AutoCompleteCVarColor;
 
    UPROPERTY(config, EditAnywhere, Category=Colors)
    FColor AutoCompleteFadedColor;
 
    ENGINESETTINGS_API TArray<FString> GetFilteredManualAutoCompleteCommands(FStringView Substring) const;
};