UConsoleSettings

Implements the settings for the [UConsole](API\Runtime\Engine\Engine\UConsole) class.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

EngineSettings

Header

/Engine/Source/Runtime/EngineSettings/Classes/ConsoleSettings.h

Include

#include "ConsoleSettings.h"

Syntax

class UConsoleSettings : public UObject

Remarks

Implements the settings for the UConsole class.

Variables

Name Description

Public variable

FColor

 

AutoCompleteCommandColor

The autocomplete color used for executable commands.

Public variable

FColor

 

AutoCompleteCVarColor

The autocomplete color used for mutable CVars.

Public variable

FColor

 

AutoCompleteFadedColor

The autocomplete color used for command descriptions and read-only CVars.

Public variable

TArray< FString...

 

AutoCompleteMapPaths

List of relative paths (e.g. Content/Maps) to search for map names for auto-complete usage.

Public variable

float

 

BackgroundOpacityPercentage

Amount of transparency of the console background.

Public variable

bool

 

bDisplayHelpInAutoComplete

Display the first line of any available help text in the auto-complete window, if a description isn't available

Public variable

bool

 

bOrderTopToBottom

Whether we legacy bottom-to-top ordering or regular top-to-bottom ordering

Public variable

FColor

 

HistoryColor

The color used for the previously typed commands history.

Public variable

FColor

 

InputColor

The color used for text input.

Public variable

TArray< struct ...

 

ManualAutoCompleteList

Manual list of auto-complete commands and info specified in BaseInput.ini

Public variable

int32

 

MaxScrollbackSize

Visible Console stuff

Constructors

Name Description

Public function

UConsoleSettings

(
    const FObjectInitializer& ObjectIn...
)
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss