UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
ConsoleSettings.h
Go to the documentation of this file.
1// Copyright Epic Games, Inc. All Rights Reserved.
2
3#pragma once
4
5#include "CoreMinimal.h"
7#include "UObject/Object.h"
8#include "ConsoleSettings.generated.h"
9
10
14USTRUCT()
16{
18
19 UPROPERTY(config, EditAnywhere, Category=Command)
20 FString Command;
21
22 UPROPERTY(config, EditAnywhere, Category=Command)
23 FString Desc;
24
25 FColor Color = FColor(180, 180, 180);
26
27 bool operator<(const FAutoCompleteCommand& rhs) const
28 {
29 return Command < rhs.Command;
30 }
31
32 // for game console
33 const FString& GetLeft() const
34 {
35 return IsHistory() ? Desc : Command;
36 }
37
38 // for game console
39 const FString& GetRight() const
40 {
41 return IsHistory() ? Command : Desc;
42 }
43
44 // @return true:history, false: autocompletion
45 bool IsHistory() const
46 {
47 return Desc == TEXT(">");
48 }
50 {
51 Desc = TEXT(">");
52 }
53};
54
55
59UCLASS(config=Input, defaultconfig, MinimalAPI)
62{
64
65
66 UPROPERTY(globalconfig, EditAnywhere, Category=General)
67 int32 MaxScrollbackSize;
68
70 UPROPERTY(config, EditAnywhere, Category=AutoComplete)
71 TArray<struct FAutoCompleteCommand> ManualAutoCompleteList;
72
74 UPROPERTY(config, EditAnywhere, Category=AutoComplete)
75 TArray<FString> AutoCompleteMapPaths;
76
78 UPROPERTY(config, EditAnywhere, Category=Colors, meta=(UIMin="0", UIMax="100", ClampMin="0", ClampMax="100"))
79 float BackgroundOpacityPercentage;
80
82 UPROPERTY(config, EditAnywhere, Category = AutoComplete)
83 bool bOrderTopToBottom;
84
86 UPROPERTY(config, EditAnywhere, Category = AutoComplete)
87 bool bDisplayHelpInAutoComplete = true;
88
90 UPROPERTY(config, EditAnywhere, Category=Colors)
91 FColor InputColor;
92
94 UPROPERTY(config, EditAnywhere, Category=Colors)
95 FColor HistoryColor;
96
98 UPROPERTY(config, EditAnywhere, Category=Colors)
99 FColor AutoCompleteCommandColor;
100
102 UPROPERTY(config, EditAnywhere, Category=Colors)
103 FColor AutoCompleteCVarColor;
104
106 UPROPERTY(config, EditAnywhere, Category=Colors)
107 FColor AutoCompleteFadedColor;
108
110 ENGINESETTINGS_API TArray<FString> GetFilteredManualAutoCompleteCommands(FStringView Substring) const;
111};
#define TEXT(x)
Definition Platform.h:1272
FPlatformTypes::int32 int32
A 32-bit signed integer.
Definition Platform.h:1125
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127
@ General
Definition MaterialExpressionFunctionInput.h:41
#define UPROPERTY(...)
UObject definition macros.
Definition ObjectMacros.h:744
#define GENERATED_UCLASS_BODY(...)
Definition ObjectMacros.h:768
#define UCLASS(...)
Definition ObjectMacros.h:776
#define USTRUCT(...)
Definition ObjectMacros.h:746
#define GENERATED_USTRUCT_BODY(...)
Definition ObjectMacros.h:767
Definition Array.h:670
Definition ConsoleSettings.h:62
Definition Object.h:95
Definition ConsoleSettings.h:16
const FString & GetLeft() const
Definition ConsoleSettings.h:33
bool IsHistory() const
Definition ConsoleSettings.h:45
void SetHistory()
Definition ConsoleSettings.h:49
const FString & GetRight() const
Definition ConsoleSettings.h:39
Definition Color.h:486