#include "Algo/Reverse.h"
#include "Containers/Array.h"
#include "Containers/Map.h"
#include "Containers/Set.h"
#include "Containers/SparseArray.h"
#include "Containers/StringFwd.h"
#include "Containers/UnrealString.h"
#include "CoreGlobals.h"
#include "CoreTypes.h"
#include "Delegates/Delegate.h"
#include "HAL/PlatformCrt.h"
#include "Internationalization/Text.h"
#include "Internationalization/TextLocalizationResource.h"
#include "Logging/LogMacros.h"
#include "Math/Color.h"
#include "Math/MathFwd.h"
#include "Math/Rotator.h"
#include "Math/Vector.h"
#include "Math/Vector2D.h"
#include "Math/Vector4.h"
#include "Misc/AccessDetection.h"
#include "Misc/Build.h"
#include "Misc/ConfigTypes.h"
#include "Misc/Paths.h"
#include "Serialization/Archive.h"
#include "Serialization/StructuredArchive.h"
#include "Serialization/StructuredArchiveAdapters.h"
#include "Serialization/StructuredArchiveSlots.h"
#include "Templates/ChooseClass.h"
#include "Templates/Function.h"
#include "Templates/UnrealTemplate.h"
#include "UObject/NameTypes.h"

Include dependency graph for ConfigCacheIni.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	FConfigValue

struct	UE::ConfigCacheIni::Private::FAccessor

class	FConfigSection

struct	FConfigCommandlineOverride

class	FConfigFile

class	FConfigCacheIni

struct	FConfigCacheIni::FKnownConfigFiles

struct	FConfigCacheIni::FKnownConfigFiles::FKnownConfigFile

Namespaces
namespace	UE

namespace	UE::ConfigCacheIni

namespace	UE::ConfigCacheIni::Private

Macros
#define	ALLOW_INI_OVERRIDE_FROM_COMMANDLINE (UE_SERVER \|\| !(UE_BUILD_SHIPPING))

#define	CONFIG_REMEMBER_ACCESS_PATTERN (WITH_EDITOR \|\| 0)

#define	ENUMERATE_KNOWN_INI_FILES(op)

#define	KNOWN_INI_ENUM(IniName) IniName,

Typedefs
typedef TMultiMap< FName, FConfigValue >	FConfigSectionMap

Enumerations
enum class	EKnownIniFile : uint8 { Engine = 0x0 , Game = 0x1 , Input = 0x2 , DeviceProfiles = 0x3 , GameUserSettings = 0x4 , Scalability = 0x5 , RuntimeOptions = 0x6 , InstallBundle = 0x7 , Hardware = 0x8 , GameplayTags = 0x9 , NumKnownFiles = 0xA , NumKnownFiles }

enum class	EConfigCacheType : uint8 { DiskBacked = 0x0 , Temporary = 0x1 , DiskBacked , Temporary }

Macro Definition Documentation

◆ ALLOW_INI_OVERRIDE_FROM_COMMANDLINE

#define ALLOW_INI_OVERRIDE_FROM_COMMANDLINE (UE_SERVER || !(UE_BUILD_SHIPPING))

Definition at line 51 of file ConfigCacheIni.h.

◆ CONFIG_REMEMBER_ACCESS_PATTERN

#define CONFIG_REMEMBER_ACCESS_PATTERN (WITH_EDITOR || 0)

Definition at line 52 of file ConfigCacheIni.h.

◆ ENUMERATE_KNOWN_INI_FILES

#define ENUMERATE_KNOWN_INI_FILES ( op )

Value:

    op(Engine) \
	op(Game) \
	op(Input) \
	op(DeviceProfiles) \
	op(GameUserSettings) \
	op(Scalability) \
	op(RuntimeOptions) \
	op(InstallBundle) \
	op(Hardware) \
	op(GameplayTags)

Definition at line 66 of file ConfigCacheIni.h.

◆ KNOWN_INI_ENUM

#define KNOWN_INI_ENUM ( IniName ) IniName,

Definition at line 79 of file ConfigCacheIni.h.

Typedef Documentation

◆ FConfigSectionMap

typedef TMultiMap<FName,FConfigValue> FConfigSectionMap

Definition at line 314 of file ConfigCacheIni.h.

Enumeration Type Documentation

◆ EConfigCacheType

enum class EConfigCacheType : uint8

strong

Enumerator
DiskBacked
Temporary
DiskBacked
Temporary

Definition at line 629 of file ConfigCacheIni.h.

◆ EKnownIniFile

enum class EKnownIniFile : uint8

strong

Enumerator
Engine
Game
Input
DeviceProfiles
GameUserSettings
Scalability
RuntimeOptions
InstallBundle
Hardware
GameplayTags
NumKnownFiles
NumKnownFiles

Definition at line 80 of file ConfigCacheIni.h.

Function Documentation

◆ ApplyCVarSettingsFromIni()

void ApplyCVarSettingsFromIni	(	const TCHAR *	InSectionBaseName,
		const TCHAR *	InIniFilename,
		uint32	SetBy,
		bool	bAllowCheating = false )

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

◆ ConvertValueFromHumanFriendlyValue()

const TCHAR * ConvertValueFromHumanFriendlyValue ( const TCHAR * Value )

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

◆ DECLARE_DELEGATE_TwoParams()

DECLARE_DELEGATE_TwoParams	(	FKeyValueSink	,
		const TCHAR *	,
		const TCHAR *	)

Declares a delegate type that's used by the config system to allow iteration of key value pairs.

◆ DECLARE_LOG_CATEGORY_EXTERN()

DECLARE_LOG_CATEGORY_EXTERN	(	LogConfig	,
		Log	,
		All	)

◆ DeleteRecordedConfigReadsFromIni()

void DeleteRecordedConfigReadsFromIni ( )

Helper function to clean up config read history

◆ DeleteRecordedCVarSettingsFromIni()

void DeleteRecordedCVarSettingsFromIni ( )

Helper function to clean up ini history

◆ DumpRecordedConfigReadsFromIni()

void DumpRecordedConfigReadsFromIni ( )

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

◆ ForEachCVarInSectionFromIni()

void 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

◆ ReapplyRecordedCVarSettingsFromIni()

void ReapplyRecordedCVarSettingsFromIni ( )

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

◆ RecordApplyCVarSettingsFromIni()

void 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()

void RecordConfigReadsFromIni ( )

Helper function to start recording config reads

Functions
	DECLARE_LOG_CATEGORY_EXTERN (LogConfig, Log, All)

	DECLARE_DELEGATE_TwoParams (FKeyValueSink, const TCHAR , const TCHAR )

void	ApplyCVarSettingsFromIni (const TCHAR InSectionBaseName, const TCHAR InIniFilename, uint32 SetBy, bool bAllowCheating=false)

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 ()

const TCHAR *	ConvertValueFromHumanFriendlyValue (const TCHAR *Value)

Classes

Namespaces

Macros

Typedefs

Enumerations

Functions