UE::ConfigUtilities Namespace Reference

Classes
class	FConfigHistoryHelper
class	FCVarIniHistoryHelper

Functions
const TCHAR *	ConvertValueFromHumanFriendlyValue (const TCHAR *Value)
void	LoadCVarsFromFileForNextBoot (TMap< FString, FString > &OutCVars)
void	SaveCVarForNextBoot (const TCHAR *Key, const TCHAR *Value)
void	ApplyCVarsFromBootHotfix ()
void	OnSetCVarFromIniEntry (const TCHAR *IniFile, const TCHAR *Key, const TCHAR *Value, uint32 SetBy, bool bAllowCheating, bool bNoLogging, FName Tag)
void	ApplyCVarSettingsFromIni (const TCHAR *InSectionName, const TCHAR *InIniFilename, uint32 SetBy, bool bAllowCheating, FName Tag)
void	ForEachCVarInSectionFromIni (const TCHAR *InSectionName, const TCHAR *InIniFilename, TFunction< void(IConsoleVariable *CVar, const FString &KeyString, const FString &ValueString)> InEvaluationFunction)
void	RecordApplyCVarSettingsFromIni ()
void	ReapplyRecordedCVarSettingsFromIni ()
void	DeleteRecordedCVarSettingsFromIni ()
void	RecordConfigReadsFromIni ()
void	DumpRecordedConfigReadsFromIni ()
void	DeleteRecordedConfigReadsFromIni ()

Variables
UE::Tasks::FPipe	AsyncTaskPipe (TEXT("SaveHotfixForNextBootPipe"))
TUniquePtr< FCVarIniHistoryHelper >	IniHistoryHelper
TUniquePtr< FConfigHistoryHelper >	ConfigHistoryHelper

Function Documentation

ApplyCVarSettingsFromIni()

CORE_API void UE::ConfigUtilities::ApplyCVarSettingsFromIni	(	const TCHAR *	InSectionBaseName,
		const TCHAR *	InIniFilename,
		uint32	SetBy,
		bool	bAllowCheating = false,
		FName	Tag = NAME_None
	)

Helper function to read the contents of an ini file and a specified group of cvar parameters, where sections in the ini file are marked [InName]

Parameters

InSectionBaseName	- The base name of the section to apply cvars from
InIniFilename	- The ini filename
SetBy	anything in ECVF_LastSetMask e.g. ECVF_SetByScalability

ApplyCVarsFromBootHotfix()

CORE_API void UE::ConfigUtilities::ApplyCVarsFromBootHotfix

(

)

When boot the game, use this function to apply cvars from last saved file from hotfix

ConvertValueFromHumanFriendlyValue()

CORE_API const TCHAR * UE::ConfigUtilities::ConvertValueFromHumanFriendlyValue

(

const TCHAR *

Value

)

Helper function to deal with "True","False","Yes","No","On","Off"

DeleteRecordedConfigReadsFromIni()

CORE_API void UE::ConfigUtilities::DeleteRecordedConfigReadsFromIni

(

)

Helper function to clean up config read history

DeleteRecordedCVarSettingsFromIni()

CORE_API void UE::ConfigUtilities::DeleteRecordedCVarSettingsFromIni

(

)

Helper function to clean up ini history

DumpRecordedConfigReadsFromIni()

CORE_API void UE::ConfigUtilities::DumpRecordedConfigReadsFromIni

(

)

Helper function to dump config reads to csv after RecordConfigReadsFromIni was called

ForEachCVarInSectionFromIni()

CORE_API void UE::ConfigUtilities::ForEachCVarInSectionFromIni	(	const TCHAR *	InSectionName,
		const TCHAR *	InIniFilename,
		TFunction< void(IConsoleVariable *CVar, const FString &KeyString, const FString &ValueString)>	InEvaluationFunction
	)

Helper function to operate a user defined function for each CVar key/value pair in the specified section in an ini file

Parameters

InSectionName	- The name of the section to apply cvars from
InIniFilename	- The ini filename
InEvaluationFunction	- The evaluation function to be called for each key/value pair

LoadCVarsFromFileForNextBoot()

void UE::ConfigUtilities::LoadCVarsFromFileForNextBoot

(

TMap< FString, FString > &

OutCVars

)

OnSetCVarFromIniEntry()

CORE_API void UE::ConfigUtilities::OnSetCVarFromIniEntry	(	const TCHAR *	IniFile,
		const TCHAR *	Key,
		const TCHAR *	Value,
		uint32	SetBy,
		bool	bAllowCheating = false,
		bool	bNoLogging = false,
		FName	Tag = NAME_None
	)

Single function to set a cvar from ini (handing friendly names, cheats for shipping and message about cheats in non shipping)

UE_BUILD_SHIPPING

ReapplyRecordedCVarSettingsFromIni()

CORE_API void UE::ConfigUtilities::ReapplyRecordedCVarSettingsFromIni

(

)

Helper function to reapply inis which have been applied after RecordCVarIniHistory was called

RecordApplyCVarSettingsFromIni()

CORE_API void UE::ConfigUtilities::RecordApplyCVarSettingsFromIni

(

)

CVAR Ini history records all calls to ApplyCVarSettingsFromIni and can re run them Helper function to start recording ApplyCVarSettings function calls uses these to generate a history of applied ini settings sections

RecordConfigReadsFromIni()

CORE_API void UE::ConfigUtilities::RecordConfigReadsFromIni

(

)

Helper function to start recording config reads

SaveCVarForNextBoot()

CORE_API void UE::ConfigUtilities::SaveCVarForNextBoot	(	const TCHAR *	Key,
		const TCHAR *	Value
	)

Variable Documentation

AsyncTaskPipe

UE::Tasks::FPipe UE::ConfigUtilities::AsyncTaskPipe(TEXT("SaveHotfixForNextBootPipe"))

(

TEXT("SaveHotfixForNextBootPipe")

)

ConfigHistoryHelper

TUniquePtr<FConfigHistoryHelper> UE::ConfigUtilities::ConfigHistoryHelper

IniHistoryHelper

TUniquePtr<FCVarIniHistoryHelper> UE::ConfigUtilities::IniHistoryHelper