UConsoleSettings | Unreal Engine 5.6 Documentation

API > API/Runtime > API/Runtime/EngineSettings

Implements the settings for the UConsole class.


Name	UConsoleSettings
Type	class
Header File	/Engine/Source/Runtime/EngineSettings/Classes/ConsoleSettings.h
Include Path	#include "ConsoleSettings.h"

Syntax

UCLASS (Config=Input, defaultconfig, MinimalAPI)  
class UConsoleSettings : public UObject

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UConsoleSettings

Constructors

Name	Remarks	Include Path	Unreal Specifiers
UConsoleSettings ( const FObjectInitializer& ObjectInitializer )		ConsoleSettings.h

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
AutoCompleteCommandColor	FColor	The autocomplete color used for executable commands.	ConsoleSettings.h	Config EditAnywhere Category=Colors
AutoCompleteCVarColor	FColor	The autocomplete color used for mutable CVars.	ConsoleSettings.h	Config EditAnywhere Category=Colors
AutoCompleteFadedColor	FColor	The autocomplete color used for command descriptions and read-only CVars.	ConsoleSettings.h	Config EditAnywhere Category=Colors
AutoCompleteMapPaths	TArray< FString >	List of relative paths (e.g. Content/Maps) to search for map names for auto-complete usage.	ConsoleSettings.h	Config EditAnywhere Category=AutoComplete
BackgroundOpacityPercentage	float	Amount of transparency of the console background.	ConsoleSettings.h	Config EditAnywhere Category=Colors Meta=(UIMin="0", UIMax="100", ClampMin="0", ClampMax="100")
bDisplayHelpInAutoComplete	bool	Display the first line of any available help text in the auto-complete window, if a description isn't available	ConsoleSettings.h	Config EditAnywhere Category=AutoComplete
bOrderTopToBottom	bool	Whether we legacy bottom-to-top ordering or regular top-to-bottom ordering	ConsoleSettings.h	Config EditAnywhere Category=AutoComplete
HistoryColor	FColor	The color used for the previously typed commands history.	ConsoleSettings.h	Config EditAnywhere Category=Colors
InputColor	FColor	The color used for text input.	ConsoleSettings.h	Config EditAnywhere Category=Colors
ManualAutoCompleteList	TArray< struct FAutoCompleteCommand >	Manual list of auto-complete commands and info specified in BaseInput.ini	ConsoleSettings.h	Config EditAnywhere Category=AutoComplete
MaxScrollbackSize	int32	The maximum number of lines the console keeps in its output history.	ConsoleSettings.h	GlobalConfig EditAnywhere Category=General

Functions

Public

Name	Remarks	Include Path	Unreal Specifiers
TArray< FString > GetFilteredManualAutoCompleteCommands ( FStringView Substring ) const	Returns an array with the auto-complete command names that match all the words in the substring.	ConsoleSettings.h

Navigation

Syntax

Inheritance Hierarchy

Constructors

Variables

Public

Functions

Public