UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
ConsoleManager.cpp File Reference
#include "HAL/ConsoleManager.h"
#include "HAL/FileManager.h"
#include "HAL/PlatformProcess.h"
#include "Logging/MessageLog.h"
#include "Misc/ConfigCacheIni.h"
#include "Misc/ConfigContext.h"
#include "Misc/ConfigUtilities.h"
#include "Misc/CoreDelegates.h"
#include "Modules/ModuleManager.h"
#include "ProfilingDebugging/CsvProfiler.h"
#include "Stats/Stats.h"
#include "Trace/Trace.h"
#include "Trace/Trace.inl"
#include <clocale>

Classes

struct  UE::ConsoleManager::Private::FConsoleManagerLocaleScope
 
class  FConsoleVariableBase
 
class  FConsoleCommandBase
 
class  FConsoleVariableHistory< T >
 
class  FConsoleVariableExtendedData< T >
 
class  FConsoleVariableConversionHelper< T >
 
class  FConsoleVariable< T >
 
class  FConsoleVariableRef< T >
 
class  FConsoleVariableStringRef
 
class  FConsoleVariableNameRef
 
class  FConsoleVariableBitRef
 
class  FRangedConsoleVariable< T >
 
class  FConsoleCommand
 
class  FConsoleCommandWithArgs
 
class  FConsoleCommandWithWorld
 
class  FConsoleCommandWithWorldAndArgs
 
class  FConsoleCommanWithArgsAndOutputDevice
 
class  FConsoleCommandWithWorldArgsAndOutputDevice
 
class  FConsoleCommandWithOutputDevice
 
class  FConsoleCommandExec
 
class  FConsoleObjectShadowData
 
class  FConsoleVariableShadow
 
class  FConsoleCommandShadow
 

Namespaces

namespace  UE
 
namespace  UE::ConsoleManager
 
namespace  UE::ConsoleManager::Private
 
namespace  ConsoleVariablePlatformMapping
 

Macros

#define LOCTEXT_NAMESPACE   "ConsoleManager"
 
#define CASE(x)   case ECVF_SetBy##x: return TEXT(#x);
 
#define TEST(x)   if (FCString::Stricmp(SetByName, TEXT(#x)) == 0) { return ECVF_SetBy##x; }
 
#define RECURSE(x)   Unset(ECVF_SetBy##x, Tag);
 
#define LOGOP(x)   Ar.Logf(TEXT(" %s%s"), TEXT(#x), IsArrayPriority(ECVF_SetBy##x) ? TEXT(" [*]") : TEXT(""));
 

Functions

 DEFINE_LOG_CATEGORY (LogConsoleResponse)
 
 DEFINE_LOG_CATEGORY_STATIC (LogConsoleManager, Log, All)
 
template<typename T >
void UE::ConsoleManager::Private::GetValueFromString (T &Value, const TCHAR *Buffer)
 
template<>
void UE::ConsoleManager::Private::GetValueFromString< float > (float &Value, const TCHAR *Buffer)
 
bool IsGoodHelpString (const TCHAR *In)
 
const TCHARGetConsoleVariableSetByName (EConsoleVariableFlags ConsoleVariableFlags)
 
EConsoleVariableFlags GetConsoleVariableSetByValue (const TCHAR *SetByName)
 
template<class T >
void OnCVarChange (T &Dst, const T &Src, EConsoleVariableFlags Flags, EConsoleVariableFlags SetBy)
 
constexpr bool IsArrayPriority (EConsoleVariableFlags Priority)
 
void UnsetCVarTag (const TCHAR *Params, FOutputDevice &Ar)
 
void CreateConsoleVariables ()
 

Variables

TMap< FName, TSet< IConsoleVariable * > * > UE::ConsoleManager::Private::TaggedCVars
 

Macro Definition Documentation

◆ CASE

#define CASE (   x)    case ECVF_SetBy##x: return TEXT(#x);

◆ LOCTEXT_NAMESPACE

#define LOCTEXT_NAMESPACE   "ConsoleManager"

◆ LOGOP

#define LOGOP (   x)    Ar.Logf(TEXT(" %s%s"), TEXT(#x), IsArrayPriority(ECVF_SetBy##x) ? TEXT(" [*]") : TEXT(""));

◆ RECURSE

#define RECURSE (   x)    Unset(ECVF_SetBy##x, Tag);

◆ TEST

#define TEST (   x)    if (FCString::Stricmp(SetByName, TEXT(#x)) == 0) { return ECVF_SetBy##x; }

Function Documentation

◆ CreateConsoleVariables()

void CreateConsoleVariables ( )

◆ DEFINE_LOG_CATEGORY()

DEFINE_LOG_CATEGORY ( LogConsoleResponse  )

◆ DEFINE_LOG_CATEGORY_STATIC()

DEFINE_LOG_CATEGORY_STATIC ( LogConsoleManager  ,
Log  ,
All   
)

◆ GetConsoleVariableSetByName()

const TCHAR * GetConsoleVariableSetByName ( EConsoleVariableFlags  ConsoleVariableFlags)

Returns human readable ECVF_SetByMask bits of the console variable flags.

◆ GetConsoleVariableSetByValue()

EConsoleVariableFlags GetConsoleVariableSetByValue ( const TCHAR SetByName)

◆ IsArrayPriority()

constexpr bool IsArrayPriority ( EConsoleVariableFlags  Priority)
constexpr

◆ IsGoodHelpString()

bool IsGoodHelpString ( const TCHAR In)

◆ OnCVarChange()

template<class T >
void OnCVarChange ( T &  Dst,
const T &  Src,
EConsoleVariableFlags  Flags,
EConsoleVariableFlags  SetBy 
)

◆ UnsetCVarTag()

void UnsetCVarTag ( const TCHAR Params,
FOutputDevice Ar 
)