#include <Other.h>

Collaboration diagram for FConfigCacheIni:

Classes
struct	FKnownConfigFiles

Public Member Functions
bool &	bIsReadyForUseField ()

TMap< FString, FConfigFile , FDefaultSetAllocator, TDefaultMapHashableKeyFuncs< FString, FConfigFile , 0 > > &	OtherFilesField ()

bool	AreFileOperationsDisabled ()

int	GetIntOrDefault (const wchar_t Section, const wchar_t Key, const int DefaultValue, const FString *Filename)

FConfigFile *	FindConfigFile (const FString *Filename)

FConfigFile *	Find (const FString *Filename)

FConfigFile *	FindConfigFileWithBaseName (FName BaseName)

TArray< FString, TSizedDefaultAllocator< 32 > > *	GetFilenames (TArray< FString, TSizedDefaultAllocator< 32 > > *result)

void	Flush (bool bRemoveFromCache, const FString *Filename)

void	Parse1ToNSectionOfNames (const wchar_t Section, const wchar_t KeyOne, const wchar_t KeyN, TMap< FName, TArray< FName, TSizedDefaultAllocator< 32 > >, FDefaultSetAllocator, TDefaultMapHashableKeyFuncs< FName, TArray< FName, TSizedDefaultAllocator< 32 > >, 0 > > OutMap, const FString *Filename)

void	Parse1ToNSectionOfStrings (const wchar_t Section, const wchar_t KeyOne, const wchar_t KeyN, TMap< FString, TArray< FString, TSizedDefaultAllocator< 32 > >, FDefaultSetAllocator, TDefaultMapHashableKeyFuncs< FString, TArray< FString, TSizedDefaultAllocator< 32 > >, 0 > > OutMap, const FString *Filename)

void	LoadFile (const FString Filename, const FConfigFile Fallback, const wchar_t *PlatformString)

void	UnloadFile (const FString *Filename)

bool	GetString (const wchar_t Section, const wchar_t Key, FString Value, const FString Filename)

bool	GetSection (const wchar_t Section, TArray< FString, TSizedDefaultAllocator< 32 > > Result, const FString *Filename)

FConfigSection *	GetSectionPrivate (const wchar_t Section, const bool Force, const bool Const, const FString Filename)

bool	DoesSectionExist (const wchar_t Section, const FString Filename)

void	SetString (const wchar_t Section, const wchar_t Key, const wchar_t Value, const FString Filename)

bool	RemoveKey (const wchar_t Section, const wchar_t Key, const FString *Filename)

bool	EmptySection (const wchar_t Section, const FString Filename)

FString *	GetConfigFilename (FString result, const wchar_t BaseIniName)

bool	GetSectionNames (const FString Filename, TArray< FString, TSizedDefaultAllocator< 32 > > out_SectionNames)

bool	GetPerObjectConfigSections (const FString Filename, const FString SearchClass, TArray< FString, TSizedDefaultAllocator< 32 > > *out_SectionNames)

void	Dump (FOutputDevice Ar, const wchar_t BaseIniName)

FString *	GetStr (FString result, const wchar_t Section, const wchar_t Key, const FString Filename)

bool	GetInt (const wchar_t Section, const wchar_t Key, int Value, const FString Filename)

bool	GetFloat (const wchar_t Section, const wchar_t Key, float Value, const FString Filename)

bool	GetBool (const wchar_t Section, const wchar_t Key, bool Value, const FString Filename)

int	GetArray (const wchar_t Section, const wchar_t Key, TArray< FString, TSizedDefaultAllocator< 32 > > out_Arr, const FString Filename)

int	GetSingleLineArray (const wchar_t Section, const wchar_t Key, TArray< FString, TSizedDefaultAllocator< 32 > > *out_Arr)

bool	GetVector2D (const wchar_t Section, const wchar_t Key, UE::Math::TVector2< double > Value, const FString Filename)

void	SetInt (const wchar_t Section, const wchar_t Key, int Value, const FString *Filename)

void	SetFloat (const wchar_t Section, const wchar_t Key, float Value, const FString *Filename)

void	SetBool (const wchar_t Section, const wchar_t Key, bool Value, const FString *Filename)

void	SetVector (const wchar_t Section, const wchar_t Key, UE::Math::TVector< double > Value, const FString Filename)

void	ShowMemoryUsage (FOutputDevice *Ar)

unsigned __int64	GetMaxMemoryUsage ()

bool	ForEachEntry (const TDelegate< void __cdecl(wchar_t const , wchar_t const ), FDefaultDelegateUserPolicy > Visitor, const wchar_t Section, const FString *Filename)

void	Serialize (FArchive *Ar)

void	SerializeStateForBootstrap_Impl (FArchive *Ar)

void	FKnownConfigFiles ()

int	Remove (const FString *Filename)

FConfigFile *	Add (const FString Filename, const FConfigFile File)

	FConfigCacheIni (EConfigCacheType Type)

	FConfigCacheIni ()

virtual	~FConfigCacheIni ()

virtual void	DisableFileOperations ()

virtual void	EnableFileOperations ()

virtual bool	AreFileOperationsDisabled ()

bool	IsReadyForUse ()

virtual void	Parse1ToNSectionOfStrings (const TCHAR Section, const TCHAR KeyOne, const TCHAR *KeyN, TMap< FString, TArray< FString > > &OutMap, const FString &Filename)

virtual void	Parse1ToNSectionOfNames (const TCHAR Section, const TCHAR KeyOne, const TCHAR *KeyN, TMap< FName, TArray< FName > > &OutMap, const FString &Filename)

FConfigFile *	FindConfigFile (const FString &Filename)

FConfigFile *	Find (const FString &InFilename)

bool	ContainsConfigFile (const FConfigFile *ConfigFile) const

FConfigFile *	Find (const FString &Filename, bool CreateIfNotFound)

FConfigFile *	FindConfigFileWithBaseName (FName BaseName)

FConfigFile &	Add (const FString &Filename, const FConfigFile &File)

int32	Remove (const FString &Filename)

TArray< FString >	GetFilenames ()

void	Flush (bool bRemoveFromCache, const FString &Filename=TEXT(""))

void	LoadFile (const FString &InFilename, const FConfigFile Fallback=NULL, const TCHAR PlatformString=NULL)

void	SetFile (const FString &InFilename, const FConfigFile *NewConfigFile)

void	UnloadFile (const FString &Filename)

void	Detach (const FString &Filename)

bool	GetString (const TCHAR Section, const TCHAR Key, FString &Value, const FString &Filename)

bool	GetText (const TCHAR Section, const TCHAR Key, FText &Value, const FString &Filename)

bool	GetSection (const TCHAR *Section, TArray< FString > &Result, const FString &Filename)

bool	DoesSectionExist (const TCHAR *Section, const FString &Filename)

FConfigSection *	GetSectionPrivate (const TCHAR *Section, const bool Force, const bool Const, const FString &Filename)

void	SetString (const TCHAR Section, const TCHAR Key, const TCHAR *Value, const FString &Filename)

void	SetText (const TCHAR Section, const TCHAR Key, const FText &Value, const FString &Filename)

bool	RemoveKey (const TCHAR Section, const TCHAR Key, const FString &Filename)

bool	EmptySection (const TCHAR *Section, const FString &Filename)

bool	EmptySectionsMatchingString (const TCHAR *SectionString, const FString &Filename)

FString	GetConfigFilename (const TCHAR *BaseIniName)

void	GetConfigFilenames (TArray< FString > &ConfigFilenames)

bool	GetSectionNames (const FString &Filename, TArray< FString > &out_SectionNames)

bool	GetPerObjectConfigSections (const FString &Filename, const FString &SearchClass, TArray< FString > &out_SectionNames, int32 MaxResults=1024)

void	Exit ()

void	Dump (FOutputDevice &Ar, const TCHAR *IniName=NULL)

virtual void	ShowMemoryUsage (FOutputDevice &Ar)

virtual SIZE_T	GetMaxMemoryUsage ()

virtual bool	ForEachEntry (const FKeyValueSink &Visitor, const TCHAR *Section, const FString &Filename)

FString	GetStr (const TCHAR Section, const TCHAR Key, const FString &Filename)

bool	GetInt (const TCHAR Section, const TCHAR Key, int32 &Value, const FString &Filename)

bool	GetFloat (const TCHAR Section, const TCHAR Key, float &Value, const FString &Filename)

bool	GetDouble (const TCHAR Section, const TCHAR Key, double &Value, const FString &Filename)

bool	GetBool (const TCHAR Section, const TCHAR Key, bool &Value, const FString &Filename)

int32	GetArray (const TCHAR Section, const TCHAR Key, TArray< FString > &out_Arr, const FString &Filename)

int32	GetSingleLineArray (const TCHAR Section, const TCHAR Key, TArray< FString > &out_Arr, const FString &Filename)

bool	GetColor (const TCHAR Section, const TCHAR Key, FColor &Value, const FString &Filename)

bool	GetVector2D (const TCHAR Section, const TCHAR Key, FVector2D &Value, const FString &Filename)

bool	GetVector (const TCHAR Section, const TCHAR Key, FVector &Value, const FString &Filename)

bool	GetVector4 (const TCHAR Section, const TCHAR Key, FVector4 &Value, const FString &Filename)

bool	GetRotator (const TCHAR Section, const TCHAR Key, FRotator &Value, const FString &Filename)

bool	GetValue (const TCHAR Section, const TCHAR Key, FString &Value, const FString &Filename)

bool	GetValue (const TCHAR Section, const TCHAR Key, FText &Value, const FString &Filename)

bool	GetValue (const TCHAR Section, const TCHAR Key, int32 &Value, const FString &Filename)

bool	GetValue (const TCHAR Section, const TCHAR Key, float &Value, const FString &Filename)

bool	GetValue (const TCHAR Section, const TCHAR Key, bool &Value, const FString &Filename)

int32	GetValue (const TCHAR Section, const TCHAR Key, TArray< FString > &Value, const FString &Filename)

int32	GetIntOrDefault (const TCHAR Section, const TCHAR Key, const int32 DefaultValue, const FString &Filename)

float	GetFloatOrDefault (const TCHAR Section, const TCHAR Key, const float DefaultValue, const FString &Filename)

bool	GetBoolOrDefault (const TCHAR Section, const TCHAR Key, const bool DefaultValue, const FString &Filename)

FString	GetStringOrDefault (const TCHAR Section, const TCHAR Key, const FString &DefaultValue, const FString &Filename)

FText	GetTextOrDefault (const TCHAR Section, const TCHAR Key, const FText &DefaultValue, const FString &Filename)

void	SetInt (const TCHAR Section, const TCHAR Key, int32 Value, const FString &Filename)

void	SetFloat (const TCHAR Section, const TCHAR Key, float Value, const FString &Filename)

void	SetDouble (const TCHAR Section, const TCHAR Key, double Value, const FString &Filename)

void	SetBool (const TCHAR Section, const TCHAR Key, bool Value, const FString &Filename)

void	SetArray (const TCHAR Section, const TCHAR Key, const TArray< FString > &Value, const FString &Filename)

void	SetSingleLineArray (const TCHAR Section, const TCHAR Key, const TArray< FString > &In_Arr, const FString &Filename)

void	SetColor (const TCHAR Section, const TCHAR Key, FColor Value, const FString &Filename)

void	SetVector2D (const TCHAR Section, const TCHAR Key, FVector2D Value, const FString &Filename)

void	SetVector (const TCHAR Section, const TCHAR Key, FVector Value, const FString &Filename)

void	SetVector4 (const TCHAR Section, const TCHAR Key, const FVector4 &Value, const FString &Filename)

void	SetRotator (const TCHAR Section, const TCHAR Key, FRotator Value, const FString &Filename)

void	SaveCurrentStateForBootstrap (const TCHAR *Filename)

void	Serialize (FArchive &Ar)

bool	InitializeKnownConfigFiles (const TCHAR PlatformName, bool bDefaultEngineIniRequired, const TCHAR OverrideProjectDir=nullptr)

bool	IsKnownConfigName (FName ConfigName)

Static Public Member Functions
static FString *	GetDestIniFilename (FString result, const wchar_t BaseIniName, const wchar_t PlatformName, const wchar_t GeneratedConfigDir)

static bool	CreateGConfigFromSaved (const wchar_t *Filename)

static void	InitializeConfigSystem (__int64 a1, __int64 a2, __int64 a3)

static const FString *	GetCustomConfigString ()

static bool	LoadGlobalIniFile (FString OutFinalIniFilename, const wchar_t BaseIniName, const wchar_t Platform, bool bForceReload, bool bRequireDefaultIni, bool bAllowGeneratedIniWhenCooked, bool bAllowRemoteConfig, const wchar_t GeneratedConfigDir, FConfigCacheIni *ConfigSystem)

static bool	LoadLocalIniFile (FConfigFile ConfigFile, const wchar_t IniName, bool bIsBaseIniName, const wchar_t *Platform, bool bForceReload)

static FConfigFile *	FindPlatformConfig (const wchar_t IniName, const wchar_t Platform)

static FConfigFile *	FindOrLoadPlatformConfig (FConfigFile LocalFile, const wchar_t IniName, const wchar_t *Platform)

static void	InitializeConfigSystem ()

static const FString &	GetCustomConfigString ()

static FString	GetDestIniFilename (const TCHAR BaseIniName, const TCHAR PlatformName, const TCHAR *GeneratedConfigDir)

static bool	LoadGlobalIniFile (FString &FinalIniFilename, const TCHAR BaseIniName, const TCHAR Platform=NULL, bool bForceReload=false, bool bRequireDefaultIni=false, bool bAllowGeneratedIniWhenCooked=true, bool bAllowRemoteConfig=true, const TCHAR GeneratedConfigDir= FPaths::GeneratedConfigDir(), FConfigCacheIni *ConfigSystem=GConfig)

static bool	LoadLocalIniFile (FConfigFile &ConfigFile, const TCHAR IniName, bool bIsBaseIniName, const TCHAR Platform=NULL, bool bForceReload=false)

static bool	LoadExternalIniFile (FConfigFile &ConfigFile, const TCHAR IniName, const TCHAR EngineConfigDir, const TCHAR SourceConfigDir, bool bIsBaseIniName, const TCHAR Platform=NULL, bool bForceReload=false, bool bWriteDestIni=false, bool bAllowGeneratedIniWhenCooked=true, const TCHAR GeneratedConfigDir= FPaths::GeneratedConfigDir())

static void	LoadConsoleVariablesFromINI ()

static FString	NormalizeConfigIniPath (const FString &NonNormalizedPath)

static FConfigFile *	FindOrLoadPlatformConfig (FConfigFile &LocalFile, const TCHAR IniName, const TCHAR Platform=NULL)

static FConfigFile *	FindPlatformConfig (const TCHAR IniName, const TCHAR Platform)

static bool	InitializeKnownConfigFiles (FConfigContext &Context)

static bool	CreateGConfigFromSaved (const TCHAR *Filename)

static FConfigCacheIni *	ForPlatform (FName PlatformName)

static void	ClearOtherPlatformConfigs ()

Private Member Functions
void	SerializeStateForBootstrap_Impl (FArchive &Ar)

Private Attributes
bool	bAreFileOperationsDisabled

bool	bIsReadyForUse

EConfigCacheType	Type

FKnownConfigFiles	KnownFiles

TMap< FString, FConfigFile * >	OtherFiles

friend	FConfigContext

Detailed Description

Definition at line 2331 of file Other.h.

Constructor & Destructor Documentation

◆ FConfigCacheIni() [1/2]

FConfigCacheIni::FConfigCacheIni ( EConfigCacheType Type )

◆ FConfigCacheIni() [2/2]

FConfigCacheIni::FConfigCacheIni ( )

DO NOT USE. This constructor is for internal usage only for hot-reload purposes.

◆ ~FConfigCacheIni()

virtual FConfigCacheIni::~FConfigCacheIni ( )

virtual

Member Function Documentation

◆ Add() [1/2]

FConfigFile & FConfigCacheIni::Add	(	const FString &	Filename,
		const FConfigFile &	File )

inline

Definition at line 743 of file ConfigCacheIni.h.

◆ Add() [2/2]

FConfigFile * FConfigCacheIni::Add	(	const FString *	Filename,
		const FConfigFile *	File )

inline

Definition at line 2394 of file Other.h.

◆ AreFileOperationsDisabled() [1/2]

bool FConfigCacheIni::AreFileOperationsDisabled ( )

inline

Definition at line 2345 of file Other.h.

◆ AreFileOperationsDisabled() [2/2]

virtual bool FConfigCacheIni::AreFileOperationsDisabled ( )

virtual

Returns whether or not file operations are disabled

◆ bIsReadyForUseField()

bool & FConfigCacheIni::bIsReadyForUseField ( )

inline

Definition at line 2336 of file Other.h.

◆ ClearOtherPlatformConfigs()

static void FConfigCacheIni::ClearOtherPlatformConfigs ( )

static

Wipe all cached platform configs. Next ForPlatform call will load on-demand the platform configs

◆ ContainsConfigFile()

bool FConfigCacheIni::ContainsConfigFile ( const FConfigFile * ConfigFile ) const

Reports whether an FConfigFile* is pointing to a config file inside of this Used for downstream functions to check whether a config file they were passed came from this ConfigCacheIni or from a different source such as LoadLocalIniFile

◆ CreateGConfigFromSaved() [1/2]

static bool FConfigCacheIni::CreateGConfigFromSaved ( const TCHAR * Filename )

static

Create GConfig from a saved file

◆ CreateGConfigFromSaved() [2/2]

static bool FConfigCacheIni::CreateGConfigFromSaved ( const wchar_t * Filename )

inlinestatic

Definition at line 2385 of file Other.h.

◆ Detach()

void FConfigCacheIni::Detach ( const FString & Filename )

◆ DisableFileOperations()

virtual void FConfigCacheIni::DisableFileOperations ( )

virtual

Disables any file IO by the config cache system

◆ DoesSectionExist() [1/2]

bool FConfigCacheIni::DoesSectionExist	(	const TCHAR *	Section,
		const FString &	Filename )

◆ DoesSectionExist() [2/2]

bool FConfigCacheIni::DoesSectionExist	(	const wchar_t *	Section,
		const FString *	Filename )

inline

Definition at line 2359 of file Other.h.

◆ Dump() [1/2]

void FConfigCacheIni::Dump	(	FOutputDevice &	Ar,
		const TCHAR *	IniName = NULL )

Prints out the entire config set, or just a single file if an ini is specified

Parameters

Ar	the device to write to
IniName	An optional ini name to restrict the writing to (Engine or WrangleContent) - meant to be used with "final" .ini files (not Default*)

◆ Dump() [2/2]

void FConfigCacheIni::Dump	(	FOutputDevice *	Ar,
		const wchar_t *	BaseIniName )

inline

Definition at line 2366 of file Other.h.

◆ EmptySection() [1/2]

bool FConfigCacheIni::EmptySection	(	const TCHAR *	Section,
		const FString &	Filename )

◆ EmptySection() [2/2]

bool FConfigCacheIni::EmptySection	(	const wchar_t *	Section,
		const FString *	Filename )

inline

Definition at line 2362 of file Other.h.

◆ EmptySectionsMatchingString()

bool FConfigCacheIni::EmptySectionsMatchingString	(	const TCHAR *	SectionString,
		const FString &	Filename )

◆ EnableFileOperations()

virtual void FConfigCacheIni::EnableFileOperations ( )

virtual

Re-enables file IO by the config cache system

◆ Exit()

void FConfigCacheIni::Exit ( )

◆ Find() [1/3]

FConfigFile * FConfigCacheIni::Find	(	const FString &	Filename,
		bool	CreateIfNotFound )

◆ Find() [2/3]

FConfigFile * FConfigCacheIni::Find ( const FString & InFilename )

Finds, loads, or creates the in-memory config file for a config cache filename.

Parameters

A	known key like GEngineIni, or the return value of GetConfigFilename

Returns: A new or existing config file

◆ Find() [3/3]

FConfigFile * FConfigCacheIni::Find ( const FString * Filename )

inline

Definition at line 2348 of file Other.h.

◆ FindConfigFile() [1/2]

FConfigFile * FConfigCacheIni::FindConfigFile ( const FString & Filename )

Finds the in-memory config file for a config cache filename.

Parameters

A	known key like GEngineIni, or the return value of GetConfigFilename

Returns: The existing config file or null if it does not exist in memory

◆ FindConfigFile() [2/2]

FConfigFile * FConfigCacheIni::FindConfigFile ( const FString * Filename )

inline

Definition at line 2347 of file Other.h.

◆ FindConfigFileWithBaseName() [1/2]

FConfigFile * FConfigCacheIni::FindConfigFileWithBaseName ( FName BaseName )

inline

Definition at line 2349 of file Other.h.

◆ FindConfigFileWithBaseName() [2/2]

FConfigFile * FConfigCacheIni::FindConfigFileWithBaseName ( FName BaseName )

Finds Config file that matches the base name such as "Engine"

◆ FindOrLoadPlatformConfig() [1/2]

static FConfigFile * FConfigCacheIni::FindOrLoadPlatformConfig	(	FConfigFile &	LocalFile,
		const TCHAR *	IniName,
		const TCHAR *	Platform = NULL )

static

This helper function searches the cache before trying to load the ini file using LoadLocalIniFile. Note that the returned FConfigFile pointer must have the same lifetime as the passed in LocalFile.

Parameters

LocalFile	The output object to fill. If the FConfigFile is found in the cache, this won't be used.
IniName	Either a Base ini name (Engine) or a full ini name (WrangleContent). NO PATH OR EXTENSION SHOULD BE USED!
Platform	The platform to use for Base ini names, NULL means to use the current platform

Returns: FConfigFile Found or loaded FConfigFile

◆ FindOrLoadPlatformConfig() [2/2]

static FConfigFile * FConfigCacheIni::FindOrLoadPlatformConfig	(	FConfigFile *	LocalFile,
		const wchar_t *	IniName,
		const wchar_t *	Platform )

inlinestatic

Definition at line 2391 of file Other.h.

◆ FindPlatformConfig() [1/2]

static FConfigFile * FConfigCacheIni::FindPlatformConfig	(	const TCHAR *	IniName,
		const TCHAR *	Platform )

static

Attempts to find the platform config in the cache.

Parameters

IniName	Either a Base ini name (Engine) or a full ini name (WrangleContent). NO PATH OR EXTENSION SHOULD BE USED!
Platform	The platform to use for Base ini names, NULL means to use the current platform

Returns: FConfigFile Found FConfigFile

◆ FindPlatformConfig() [2/2]

static FConfigFile * FConfigCacheIni::FindPlatformConfig	(	const wchar_t *	IniName,
		const wchar_t *	Platform )

inlinestatic

Definition at line 2390 of file Other.h.

◆ FKnownConfigFiles()

void FConfigCacheIni::FKnownConfigFiles ( )

inline

Definition at line 2384 of file Other.h.

◆ Flush() [1/2]

void FConfigCacheIni::Flush	(	bool	bRemoveFromCache,
		const FString &	Filename = TEXT("") )

◆ Flush() [2/2]

void FConfigCacheIni::Flush	(	bool	bRemoveFromCache,
		const FString *	Filename )

inline

Definition at line 2351 of file Other.h.

◆ ForEachEntry() [1/2]

virtual bool FConfigCacheIni::ForEachEntry	(	const FKeyValueSink &	Visitor,
		const TCHAR *	Section,
		const FString &	Filename )

virtual

allows to iterate through all key value pairs

Returns: false:error e.g. Section or Filename not found

◆ ForEachEntry() [2/2]

bool FConfigCacheIni::ForEachEntry	(	const TDelegate< void __cdecl(wchar_t const , wchar_t const ), FDefaultDelegateUserPolicy > *	Visitor,
		const wchar_t *	Section,
		const FString *	Filename )

inline

Definition at line 2380 of file Other.h.

◆ ForPlatform()

static FConfigCacheIni * FConfigCacheIni::ForPlatform ( FName PlatformName )

static

Retrieve the fully processed ini system for another platform. The editor will start loading these in the background on startup

◆ GetArray() [1/2]

int32 FConfigCacheIni::GetArray	(	const TCHAR *	Section,
		const TCHAR *	Key,
		TArray< FString > &	out_Arr,
		const FString &	Filename )

◆ GetArray() [2/2]

int FConfigCacheIni::GetArray	(	const wchar_t *	Section,
		const wchar_t *	Key,
		TArray< FString, TSizedDefaultAllocator< 32 > > *	out_Arr,
		const FString *	Filename )

inline

Definition at line 2371 of file Other.h.

◆ GetBool() [1/2]

bool FConfigCacheIni::GetBool	(	const TCHAR *	Section,
		const TCHAR *	Key,
		bool &	Value,
		const FString &	Filename )

Here is the caller graph for this function:

◆ GetBool() [2/2]

bool FConfigCacheIni::GetBool	(	const wchar_t *	Section,
		const wchar_t *	Key,
		bool *	Value,
		const FString *	Filename )

inline

Definition at line 2370 of file Other.h.

◆ GetBoolOrDefault()

bool FConfigCacheIni::GetBoolOrDefault	(	const TCHAR *	Section,
		const TCHAR *	Key,
		const bool	DefaultValue,
		const FString &	Filename )

inline

Definition at line 977 of file ConfigCacheIni.h.

Here is the call graph for this function:

◆ GetColor()

bool FConfigCacheIni::GetColor	(	const TCHAR *	Section,
		const TCHAR *	Key,
		FColor &	Value,
		const FString &	Filename )

◆ GetConfigFilename() [1/2]

FString FConfigCacheIni::GetConfigFilename ( const TCHAR * BaseIniName )

For a base ini name, gets the config cache filename key that is used by other functions like Find. This will be the base name for known configs like Engine and the destination filename for others.

Parameters

IniBaseName Base name of the .ini (Engine, Game, CustomSystem)

Returns: Filename key used by other cache functions

◆ GetConfigFilename() [2/2]

FString * FConfigCacheIni::GetConfigFilename	(	FString *	result,
		const wchar_t *	BaseIniName )

inline

Definition at line 2363 of file Other.h.

◆ GetConfigFilenames()

void FConfigCacheIni::GetConfigFilenames ( TArray< FString > & ConfigFilenames )

Retrieve a list of all of the config files stored in the cache

Parameters

ConfigFilenames Out array to receive the list of filenames

◆ GetCustomConfigString() [1/2]

static const FString * FConfigCacheIni::GetCustomConfigString ( )

inlinestatic

Definition at line 2387 of file Other.h.

◆ GetCustomConfigString() [2/2]

static const FString & FConfigCacheIni::GetCustomConfigString ( )

static

Returns the Custom Config string, which if set will load additional config files from Config/Custom/{CustomConfig}/DefaultX.ini to allow different types of builds. It can be set from a game Target.cs file with CustomConfig = "Name". Or in development, it can be overridden with a -CustomConfig=Name command line parameter.

◆ GetDestIniFilename() [1/2]

static FString FConfigCacheIni::GetDestIniFilename	(	const TCHAR *	BaseIniName,
		const TCHAR *	PlatformName,
		const TCHAR *	GeneratedConfigDir )

static

Calculates the name of a dest (generated) .ini file for a given base (ie Engine, Game, etc)

Parameters

IniBaseName	Base name of the .ini (Engine, Game)
PlatformName	Name of the platform to get the .ini path for (nullptr means to use the current platform)
GeneratedConfigDir	The base folder that will contain the generated config files.

Returns: Standardized .ini filename

◆ GetDestIniFilename() [2/2]

static FString * FConfigCacheIni::GetDestIniFilename	(	FString *	result,
		const wchar_t *	BaseIniName,
		const wchar_t *	PlatformName,
		const wchar_t *	GeneratedConfigDir )

inlinestatic

Definition at line 2381 of file Other.h.

◆ GetDouble()

bool FConfigCacheIni::GetDouble	(	const TCHAR *	Section,
		const TCHAR *	Key,
		double &	Value,
		const FString &	Filename )

◆ GetFilenames() [1/2]

TArray< FString > FConfigCacheIni::GetFilenames ( )

◆ GetFilenames() [2/2]

TArray< FString, TSizedDefaultAllocator< 32 > > * FConfigCacheIni::GetFilenames ( TArray< FString, TSizedDefaultAllocator< 32 > > * result )

inline

Definition at line 2350 of file Other.h.

◆ GetFloat() [1/2]

bool FConfigCacheIni::GetFloat	(	const TCHAR *	Section,
		const TCHAR *	Key,
		float &	Value,
		const FString &	Filename )

Here is the caller graph for this function:

◆ GetFloat() [2/2]

bool FConfigCacheIni::GetFloat	(	const wchar_t *	Section,
		const wchar_t *	Key,
		float *	Value,
		const FString *	Filename )

inline

Definition at line 2369 of file Other.h.

◆ GetFloatOrDefault()

float FConfigCacheIni::GetFloatOrDefault	(	const TCHAR *	Section,
		const TCHAR *	Key,
		const float	DefaultValue,
		const FString &	Filename )

inline

Definition at line 971 of file ConfigCacheIni.h.

Here is the call graph for this function:

◆ GetInt() [1/2]

bool FConfigCacheIni::GetInt	(	const TCHAR *	Section,
		const TCHAR *	Key,
		int32 &	Value,
		const FString &	Filename )

Here is the caller graph for this function:

◆ GetInt() [2/2]

bool FConfigCacheIni::GetInt	(	const wchar_t *	Section,
		const wchar_t *	Key,
		int *	Value,
		const FString *	Filename )

inline

Definition at line 2368 of file Other.h.

◆ GetIntOrDefault() [1/2]

int32 FConfigCacheIni::GetIntOrDefault	(	const TCHAR *	Section,
		const TCHAR *	Key,
		const int32	DefaultValue,
		const FString &	Filename )

inline

Definition at line 965 of file ConfigCacheIni.h.

Here is the call graph for this function:

◆ GetIntOrDefault() [2/2]

int FConfigCacheIni::GetIntOrDefault	(	const wchar_t *	Section,
		const wchar_t *	Key,
		const int	DefaultValue,
		const FString *	Filename )

inline

Definition at line 2346 of file Other.h.

◆ GetMaxMemoryUsage() [1/2]

unsigned __int64 FConfigCacheIni::GetMaxMemoryUsage ( )

inline

Definition at line 2379 of file Other.h.

◆ GetMaxMemoryUsage() [2/2]

virtual SIZE_T FConfigCacheIni::GetMaxMemoryUsage ( )

virtual

USed to get the max memory usage for the FConfigCacheIni

Returns: the amount of memory in byes

◆ GetPerObjectConfigSections() [1/2]

bool FConfigCacheIni::GetPerObjectConfigSections	(	const FString &	Filename,
		const FString &	SearchClass,
		TArray< FString > &	out_SectionNames,
		int32	MaxResults = 1024 )

Retrieve the names of sections which contain data for the specified PerObjectConfig class.

Parameters

Filename	the file to retrieve section names from
SearchClass	the name of the PerObjectConfig class to retrieve sections for.
out_SectionNames	will receive the list of section names that correspond to PerObjectConfig sections of the specified class
MaxResults	the maximum number of section names to retrieve

Returns: true if the file specified was found and it contained at least 1 section for the specified class

◆ GetPerObjectConfigSections() [2/2]

bool FConfigCacheIni::GetPerObjectConfigSections	(	const FString *	Filename,
		const FString *	SearchClass,
		TArray< FString, TSizedDefaultAllocator< 32 > > *	out_SectionNames )

inline

Definition at line 2365 of file Other.h.

◆ GetRotator()

bool FConfigCacheIni::GetRotator	(	const TCHAR *	Section,
		const TCHAR *	Key,
		FRotator &	Value,
		const FString &	Filename )

◆ GetSection() [1/2]

bool FConfigCacheIni::GetSection	(	const TCHAR *	Section,
		TArray< FString > &	Result,
		const FString &	Filename )

◆ GetSection() [2/2]

bool FConfigCacheIni::GetSection	(	const wchar_t *	Section,
		TArray< FString, TSizedDefaultAllocator< 32 > > *	Result,
		const FString *	Filename )

inline

Definition at line 2357 of file Other.h.

◆ GetSectionNames() [1/2]

bool FConfigCacheIni::GetSectionNames	(	const FString &	Filename,
		TArray< FString > &	out_SectionNames )

Retrieve the names for all sections contained in the file specified by Filename

Parameters

Filename	the file to retrieve section names from
out_SectionNames	will receive the list of section names

Returns: true if the file specified was successfully found;

◆ GetSectionNames() [2/2]

bool FConfigCacheIni::GetSectionNames	(	const FString *	Filename,
		TArray< FString, TSizedDefaultAllocator< 32 > > *	out_SectionNames )

inline

Definition at line 2364 of file Other.h.

◆ GetSectionPrivate() [1/2]

FConfigSection * FConfigCacheIni::GetSectionPrivate	(	const TCHAR *	Section,
		const bool	Force,
		const bool	Const,
		const FString &	Filename )

Parameters

Force	Whether to create the Section on Filename if it did not exist previously.
Const	If Const (and not Force), then it will not modify File->Dirty. If not Const (or Force is true), then File->Dirty will be set to true.

◆ GetSectionPrivate() [2/2]

FConfigSection * FConfigCacheIni::GetSectionPrivate	(	const wchar_t *	Section,
		const bool	Force,
		const bool	Const,
		const FString *	Filename )

inline

Definition at line 2358 of file Other.h.

◆ GetSingleLineArray() [1/2]

int32 FConfigCacheIni::GetSingleLineArray	(	const TCHAR *	Section,
		const TCHAR *	Key,
		TArray< FString > &	out_Arr,
		const FString &	Filename )

Loads a "delimited" list of strings

Parameters

Section	- Section of the ini file to load from
Key	- The key in the section of the ini file to load
out_Arr	- Array to load into
Filename	- Ini file to load from

◆ GetSingleLineArray() [2/2]

int FConfigCacheIni::GetSingleLineArray	(	const wchar_t *	Section,
		const wchar_t *	Key,
		TArray< FString, TSizedDefaultAllocator< 32 > > *	out_Arr )

inline

Definition at line 2372 of file Other.h.

◆ GetStr() [1/2]

FString FConfigCacheIni::GetStr	(	const TCHAR *	Section,
		const TCHAR *	Key,
		const FString &	Filename )

◆ GetStr() [2/2]

FString * FConfigCacheIni::GetStr	(	FString *	result,
		const wchar_t *	Section,
		const wchar_t *	Key,
		const FString *	Filename )

inline

Definition at line 2367 of file Other.h.

◆ GetString() [1/2]

bool FConfigCacheIni::GetString	(	const TCHAR *	Section,
		const TCHAR *	Key,
		FString &	Value,
		const FString &	Filename )

Here is the caller graph for this function:

◆ GetString() [2/2]

bool FConfigCacheIni::GetString	(	const wchar_t *	Section,
		const wchar_t *	Key,
		FString *	Value,
		const FString *	Filename )

inline

Definition at line 2356 of file Other.h.

◆ GetStringOrDefault()

FString FConfigCacheIni::GetStringOrDefault	(	const TCHAR *	Section,
		const TCHAR *	Key,
		const FString &	DefaultValue,
		const FString &	Filename )

inline

Definition at line 983 of file ConfigCacheIni.h.

Here is the call graph for this function:

◆ GetText()

bool FConfigCacheIni::GetText	(	const TCHAR *	Section,
		const TCHAR *	Key,
		FText &	Value,
		const FString &	Filename )

Here is the caller graph for this function:

◆ GetTextOrDefault()

FText FConfigCacheIni::GetTextOrDefault	(	const TCHAR *	Section,
		const TCHAR *	Key,
		const FText &	DefaultValue,
		const FString &	Filename )

inline

Definition at line 995 of file ConfigCacheIni.h.

Here is the call graph for this function:

◆ GetValue() [1/6]

bool FConfigCacheIni::GetValue	(	const TCHAR *	Section,
		const TCHAR *	Key,
		bool &	Value,
		const FString &	Filename )

inline

Definition at line 952 of file ConfigCacheIni.h.

Here is the call graph for this function:

◆ GetValue() [2/6]

bool FConfigCacheIni::GetValue	(	const TCHAR *	Section,
		const TCHAR *	Key,
		float &	Value,
		const FString &	Filename )

inline

Definition at line 948 of file ConfigCacheIni.h.

Here is the call graph for this function:

◆ GetValue() [3/6]

bool FConfigCacheIni::GetValue	(	const TCHAR *	Section,
		const TCHAR *	Key,
		FString &	Value,
		const FString &	Filename )

inline

Definition at line 936 of file ConfigCacheIni.h.

Here is the call graph for this function:

◆ GetValue() [4/6]

bool FConfigCacheIni::GetValue	(	const TCHAR *	Section,
		const TCHAR *	Key,
		FText &	Value,
		const FString &	Filename )

inline

Definition at line 940 of file ConfigCacheIni.h.

Here is the call graph for this function:

◆ GetValue() [5/6]

bool FConfigCacheIni::GetValue	(	const TCHAR *	Section,
		const TCHAR *	Key,
		int32 &	Value,
		const FString &	Filename )

inline

Definition at line 944 of file ConfigCacheIni.h.

Here is the call graph for this function:

◆ GetValue() [6/6]

int32 FConfigCacheIni::GetValue	(	const TCHAR *	Section,
		const TCHAR *	Key,
		TArray< FString > &	Value,
		const FString &	Filename )

inline

Definition at line 956 of file ConfigCacheIni.h.

◆ GetVector()

bool FConfigCacheIni::GetVector	(	const TCHAR *	Section,
		const TCHAR *	Key,
		FVector &	Value,
		const FString &	Filename )

◆ GetVector2D() [1/2]

bool FConfigCacheIni::GetVector2D	(	const TCHAR *	Section,
		const TCHAR *	Key,
		FVector2D &	Value,
		const FString &	Filename )

◆ GetVector2D() [2/2]

bool FConfigCacheIni::GetVector2D	(	const wchar_t *	Section,
		const wchar_t *	Key,
		UE::Math::TVector2< double > *	Value,
		const FString *	Filename )

inline

Definition at line 2373 of file Other.h.

◆ GetVector4()

bool FConfigCacheIni::GetVector4	(	const TCHAR *	Section,
		const TCHAR *	Key,
		FVector4 &	Value,
		const FString &	Filename )

◆ InitializeConfigSystem() [1/2]

static void FConfigCacheIni::InitializeConfigSystem ( )

static

Creates GConfig, loads the standard global ini files (Engine, Editor, etc), fills out GEngineIni, etc. and marks GConfig as ready for use

◆ InitializeConfigSystem() [2/2]

static void FConfigCacheIni::InitializeConfigSystem	(	__int64	a1,
		__int64	a2,
		__int64	a3 )

inlinestatic

Definition at line 2386 of file Other.h.

◆ InitializeKnownConfigFiles() [1/2]

bool FConfigCacheIni::InitializeKnownConfigFiles	(	const TCHAR *	PlatformName,
		bool	bDefaultEngineIniRequired,
		const TCHAR *	OverrideProjectDir = nullptr )

Load the standard (used on all platforms) ini files, like Engine, Input, etc

Parameters

PlatformName	Ini name of the platform this is loadenig for (or nullptr for current platform)
bDefaultEngineIniRequired	True if the engine ini is required
OverrideProjectDir	Used to generate configs for another project (like from a program making binary configs)

return True if the engine ini was loaded

◆ InitializeKnownConfigFiles() [2/2]

static bool FConfigCacheIni::InitializeKnownConfigFiles ( FConfigContext & Context )

static

◆ IsKnownConfigName()

bool FConfigCacheIni::IsKnownConfigName ( FName ConfigName )

Returns true if the given name is one of the known configs, where the matching G****Ini property is going to match the base name ("Engine" returns true, which means GEngineIni's value is just "Engine")

◆ IsReadyForUse()

bool FConfigCacheIni::IsReadyForUse ( )

inline

Returns: true after after the basic .ini files have been loaded

Definition at line 667 of file ConfigCacheIni.h.

Here is the caller graph for this function:

◆ LoadConsoleVariablesFromINI()

static void FConfigCacheIni::LoadConsoleVariablesFromINI ( )

static

Needs to be called after GConfig is set and LoadCoalescedFile was called. Loads the state of console variables. Works even if the variable is registered after the ini file was loaded.

◆ LoadExternalIniFile()

static bool FConfigCacheIni::LoadExternalIniFile	(	FConfigFile &	ConfigFile,
		const TCHAR *	IniName,
		const TCHAR *	EngineConfigDir,
		const TCHAR *	SourceConfigDir,
		bool	bIsBaseIniName,
		const TCHAR *	Platform = NULL,
		bool	bForceReload = false,
		bool	bWriteDestIni = false,
		bool	bAllowGeneratedIniWhenCooked = true,
		const TCHAR *	GeneratedConfigDir = *FPaths::GeneratedConfigDir() )

static

Load an ini file directly into an FConfigFile from the specified config folders, optionally writing to disk. The passed in .ini name can be a "base" (Engine, Game) which will be modified by platform and/or commandline override, or it can be a full ini filename (ie WrangleContent) loaded from the Source config directory

Parameters

ConfigFile	The output object to fill
IniName	Either a Base ini name (Engine) or a full ini name (WrangleContent). NO PATH OR EXTENSION SHOULD BE USED!
EngineConfigDir	Engine config directory.
SourceConfigDir	Game config directory.
bIsBaseIniName	true if IniName is a Base name, which can be overridden on commandline, etc.
Platform	The platform to use for Base ini names
bForceReload	force reload the ini file from disk this is required if you make changes to the ini file not using the config system as the hierarchy cache will not be updated in this case
bWriteDestIni	write out a destination ini file to the Saved folder, only valid if bIsBaseIniName is true
bAllowGeneratedIniWhenCooked	If true, the engine will attempt to load the generated/user INI file when loading cooked games
GeneratedConfigDir	The location where generated config files are made.

Returns: true if the ini file was loaded successfully

◆ LoadFile() [1/2]

void FConfigCacheIni::LoadFile	(	const FString &	InFilename,
		const FConfigFile *	Fallback = NULL,
		const TCHAR *	PlatformString = NULL )

◆ LoadFile() [2/2]

void FConfigCacheIni::LoadFile	(	const FString *	Filename,
		const FConfigFile *	Fallback,
		const wchar_t *	PlatformString )

inline

Definition at line 2354 of file Other.h.

◆ LoadGlobalIniFile() [1/2]

static bool FConfigCacheIni::LoadGlobalIniFile	(	FString &	FinalIniFilename,
		const TCHAR *	BaseIniName,
		const TCHAR *	Platform = NULL,
		bool	bForceReload = false,
		bool	bRequireDefaultIni = false,
		bool	bAllowGeneratedIniWhenCooked = true,
		bool	bAllowRemoteConfig = true,
		const TCHAR *	GeneratedConfigDir = *FPaths::GeneratedConfigDir(),
		FConfigCacheIni *	ConfigSystem = GConfig )

static

Loads and generates a destination ini file and adds it to GConfig:

Looking on commandline for override source/dest .ini filenames
Generating the name for the engine to refer to the ini
Loading a source .ini file hierarchy
Filling out an FConfigFile
Save the generated ini
Adds the FConfigFile to GConfig

Parameters

FinalIniFilename	The output name of the generated .ini file (in Game\Saved\Config)
BaseIniName	The "base" ini name, with no extension (ie, Engine, Game, etc)
Platform	The platform to load the .ini for (if NULL, uses current)
bForceReload	If true, the destination .in will be regenerated from the source, otherwise this will only process if the dest isn't in GConfig
bRequireDefaultIni	If true, the Default*.ini file is required to exist when generating the final ini file.
bAllowGeneratedIniWhenCooked	If true, the engine will attempt to load the generated/user INI file when loading cooked games
GeneratedConfigDir	The location where generated config files are made.

Returns: true if the final ini was created successfully.

◆ LoadGlobalIniFile() [2/2]

static bool FConfigCacheIni::LoadGlobalIniFile	(	FString *	OutFinalIniFilename,
		const wchar_t *	BaseIniName,
		const wchar_t *	Platform,
		bool	bForceReload,
		bool	bRequireDefaultIni,
		bool	bAllowGeneratedIniWhenCooked,
		bool	bAllowRemoteConfig,
		const wchar_t *	GeneratedConfigDir,
		FConfigCacheIni *	ConfigSystem )

inlinestatic

Definition at line 2388 of file Other.h.

◆ LoadLocalIniFile() [1/2]

static bool FConfigCacheIni::LoadLocalIniFile	(	FConfigFile &	ConfigFile,
		const TCHAR *	IniName,
		bool	bIsBaseIniName,
		const TCHAR *	Platform = NULL,
		bool	bForceReload = false )

static

Load an ini file directly into an FConfigFile, and nothing is written to GConfig or disk. The passed in .ini name can be a "base" (Engine, Game) which will be modified by platform and/or commandline override, or it can be a full ini filename (ie WrangleContent) loaded from the Source config directory

Parameters

ConfigFile	The output object to fill
IniName	Either a Base ini name (Engine) or a full ini name (WrangleContent). NO PATH OR EXTENSION SHOULD BE USED!
bIsBaseIniName	true if IniName is a Base name, which can be overridden on commandline, etc.
Platform	The platform to use for Base ini names, NULL means to use the current platform
bForceReload	force reload the ini file from disk this is required if you make changes to the ini file not using the config system as the hierarchy cache will not be updated in this case

Returns: true if the ini file was loaded successfully

◆ LoadLocalIniFile() [2/2]

static bool FConfigCacheIni::LoadLocalIniFile	(	FConfigFile *	ConfigFile,
		const wchar_t *	IniName,
		bool	bIsBaseIniName,
		const wchar_t *	Platform,
		bool	bForceReload )

inlinestatic

Definition at line 2389 of file Other.h.

◆ NormalizeConfigIniPath()

static FString FConfigCacheIni::NormalizeConfigIniPath ( const FString & NonNormalizedPath )

static

Normalizes file paths to INI files.

If an INI file is accessed with multiple paths, then we can run into issues where we cache multiple versions of the file. Specifically, any updates to the file may only be applied to one cached version, and could cause changes to be lost.

E.G.

// Standard path.
C:\ProjectDir\Engine\Config\DefaultEngine.ini

// Lowercase drive, and an extra slash between ProjectDir and Engine.
c:\ProjectDir\\Engine\Confg\DefaultEngine.ini

// Relative to a project binary.
..\..\..\ConfigDefaultEngine.ini

The paths above could all be used to reference the same ini file (namely, DefaultEngine.ini).
However, they would end up generating unique entries in the GConfigCache.
That means any modifications to *one* of the entries would not propagate to the others, and if
any / all of the ini files are saved, they will stomp changes to the other entries.

We can prevent these types of issues by enforcing normalized paths when accessing configs.

Parameters

NonNormalizedPath The path to the INI file we want to access.

Returns: A normalized version of the path (may be the same as the input).

◆ OtherFilesField()

TMap< FString, FConfigFile *, FDefaultSetAllocator, TDefaultMapHashableKeyFuncs< FString, FConfigFile *, 0 > > & FConfigCacheIni::OtherFilesField ( )

inline

Definition at line 2338 of file Other.h.

◆ Parse1ToNSectionOfNames() [1/2]

virtual void FConfigCacheIni::Parse1ToNSectionOfNames	(	const TCHAR *	Section,
		const TCHAR *	KeyOne,
		const TCHAR *	KeyN,
		TMap< FName, TArray< FName > > &	OutMap,
		const FString &	Filename )

virtual

Parses apart an ini section that contains a list of 1-to-N mappings of names in the following format [PerMapPackages] MapName=Map1 Package=PackageA Package=PackageB MapName=Map2 Package=PackageC Package=PackageD

Parameters

Section	Name of section to look in
KeyOne	Key to use for the 1 in the 1-to-N (MapName in the above example)
KeyN	Key to use for the N in the 1-to-N (Package in the above example)
OutMap	Map containing parsed results
Filename	Filename to use to find the section

NOTE: The function naming is weird because you can't apparently have an overridden function differnt only by template type params

◆ Parse1ToNSectionOfNames() [2/2]

void FConfigCacheIni::Parse1ToNSectionOfNames	(	const wchar_t *	Section,
		const wchar_t *	KeyOne,
		const wchar_t *	KeyN,
		TMap< FName, TArray< FName, TSizedDefaultAllocator< 32 > >, FDefaultSetAllocator, TDefaultMapHashableKeyFuncs< FName, TArray< FName, TSizedDefaultAllocator< 32 > >, 0 > > *	OutMap,
		const FString *	Filename )

inline

Definition at line 2352 of file Other.h.

◆ Parse1ToNSectionOfStrings() [1/2]

virtual void FConfigCacheIni::Parse1ToNSectionOfStrings	(	const TCHAR *	Section,
		const TCHAR *	KeyOne,
		const TCHAR *	KeyN,
		TMap< FString, TArray< FString > > &	OutMap,
		const FString &	Filename )

virtual

Prases apart an ini section that contains a list of 1-to-N mappings of strings in the following format [PerMapPackages] MapName=Map1 Package=PackageA Package=PackageB MapName=Map2 Package=PackageC Package=PackageD

Parameters

Section	Name of section to look in
KeyOne	Key to use for the 1 in the 1-to-N (MapName in the above example)
KeyN	Key to use for the N in the 1-to-N (Package in the above example)
OutMap	Map containing parsed results
Filename	Filename to use to find the section

NOTE: The function naming is weird because you can't apparently have an overridden function differnt only by template type params

◆ Parse1ToNSectionOfStrings() [2/2]

void FConfigCacheIni::Parse1ToNSectionOfStrings	(	const wchar_t *	Section,
		const wchar_t *	KeyOne,
		const wchar_t *	KeyN,
		TMap< FString, TArray< FString, TSizedDefaultAllocator< 32 > >, FDefaultSetAllocator, TDefaultMapHashableKeyFuncs< FString, TArray< FString, TSizedDefaultAllocator< 32 > >, 0 > > *	OutMap,
		const FString *	Filename )

inline

Definition at line 2353 of file Other.h.

◆ Remove() [1/2]

int32 FConfigCacheIni::Remove ( const FString & Filename )

inline

Definition at line 747 of file ConfigCacheIni.h.

◆ Remove() [2/2]

int FConfigCacheIni::Remove ( const FString * Filename )

inline

Definition at line 2393 of file Other.h.

◆ RemoveKey() [1/2]

bool FConfigCacheIni::RemoveKey	(	const TCHAR *	Section,
		const TCHAR *	Key,
		const FString &	Filename )

◆ RemoveKey() [2/2]

bool FConfigCacheIni::RemoveKey	(	const wchar_t *	Section,
		const wchar_t *	Key,
		const FString *	Filename )

inline

Definition at line 2361 of file Other.h.

◆ SaveCurrentStateForBootstrap()

void FConfigCacheIni::SaveCurrentStateForBootstrap ( const TCHAR * Filename )

Save the current config cache state into a file for bootstrapping other processes.

◆ Serialize() [1/2]

void FConfigCacheIni::Serialize ( FArchive & Ar )

◆ Serialize() [2/2]

void FConfigCacheIni::Serialize ( FArchive * Ar )

inline

Definition at line 2382 of file Other.h.

◆ SerializeStateForBootstrap_Impl() [1/2]

void FConfigCacheIni::SerializeStateForBootstrap_Impl ( FArchive & Ar )

private

Serialize a bootstrapping state into or from an archive

◆ SerializeStateForBootstrap_Impl() [2/2]

void FConfigCacheIni::SerializeStateForBootstrap_Impl ( FArchive * Ar )

inline

Definition at line 2383 of file Other.h.

◆ SetArray()

void FConfigCacheIni::SetArray	(	const TCHAR *	Section,
		const TCHAR *	Key,
		const TArray< FString > &	Value,
		const FString &	Filename )

◆ SetBool() [1/2]

void FConfigCacheIni::SetBool	(	const TCHAR *	Section,
		const TCHAR *	Key,
		bool	Value,
		const FString &	Filename )

◆ SetBool() [2/2]

void FConfigCacheIni::SetBool	(	const wchar_t *	Section,
		const wchar_t *	Key,
		bool	Value,
		const FString *	Filename )

inline

Definition at line 2376 of file Other.h.

◆ SetColor()

void FConfigCacheIni::SetColor	(	const TCHAR *	Section,
		const TCHAR *	Key,
		FColor	Value,
		const FString &	Filename )

◆ SetDouble()

void FConfigCacheIni::SetDouble	(	const TCHAR *	Section,
		const TCHAR *	Key,
		double	Value,
		const FString &	Filename )

◆ SetFile()

void FConfigCacheIni::SetFile	(	const FString &	InFilename,
		const FConfigFile *	NewConfigFile )

◆ SetFloat() [1/2]

void FConfigCacheIni::SetFloat	(	const TCHAR *	Section,
		const TCHAR *	Key,
		float	Value,
		const FString &	Filename )

◆ SetFloat() [2/2]

void FConfigCacheIni::SetFloat	(	const wchar_t *	Section,
		const wchar_t *	Key,
		float	Value,
		const FString *	Filename )

inline

Definition at line 2375 of file Other.h.

◆ SetInt() [1/2]

void FConfigCacheIni::SetInt	(	const TCHAR *	Section,
		const TCHAR *	Key,
		int32	Value,
		const FString &	Filename )

◆ SetInt() [2/2]

void FConfigCacheIni::SetInt	(	const wchar_t *	Section,
		const wchar_t *	Key,
		int	Value,
		const FString *	Filename )

inline

Definition at line 2374 of file Other.h.

◆ SetRotator()

void FConfigCacheIni::SetRotator	(	const TCHAR *	Section,
		const TCHAR *	Key,
		FRotator	Value,
		const FString &	Filename )

◆ SetSingleLineArray()

void FConfigCacheIni::SetSingleLineArray	(	const TCHAR *	Section,
		const TCHAR *	Key,
		const TArray< FString > &	In_Arr,
		const FString &	Filename )

Saves a "delimited" list of strings

Parameters

Section	- Section of the ini file to save to
Key	- The key in the section of the ini file to save
out_Arr	- Array to save from
Filename	- Ini file to save to

◆ SetString() [1/2]

void FConfigCacheIni::SetString	(	const TCHAR *	Section,
		const TCHAR *	Key,
		const TCHAR *	Value,
		const FString &	Filename )

◆ SetString() [2/2]

void FConfigCacheIni::SetString	(	const wchar_t *	Section,
		const wchar_t *	Key,
		const wchar_t *	Value,
		const FString *	Filename )

inline

Definition at line 2360 of file Other.h.

◆ SetText()

void FConfigCacheIni::SetText	(	const TCHAR *	Section,
		const TCHAR *	Key,
		const FText &	Value,
		const FString &	Filename )

◆ SetVector() [1/2]

void FConfigCacheIni::SetVector	(	const TCHAR *	Section,
		const TCHAR *	Key,
		FVector	Value,
		const FString &	Filename )

◆ SetVector() [2/2]

void FConfigCacheIni::SetVector	(	const wchar_t *	Section,
		const wchar_t *	Key,
		UE::Math::TVector< double > *	Value,
		const FString *	Filename )

inline

Definition at line 2377 of file Other.h.

◆ SetVector2D()

void FConfigCacheIni::SetVector2D	(	const TCHAR *	Section,
		const TCHAR *	Key,
		FVector2D	Value,
		const FString &	Filename )

◆ SetVector4()

void FConfigCacheIni::SetVector4	(	const TCHAR *	Section,
		const TCHAR *	Key,
		const FVector4 &	Value,
		const FString &	Filename )

◆ ShowMemoryUsage() [1/2]

virtual void FConfigCacheIni::ShowMemoryUsage ( FOutputDevice & Ar )

virtual

Dumps memory stats for each file in the config cache to the specified archive.

Parameters

Ar	the output device to dump the results to

◆ ShowMemoryUsage() [2/2]

void FConfigCacheIni::ShowMemoryUsage ( FOutputDevice * Ar )

inline

Definition at line 2378 of file Other.h.

◆ UnloadFile() [1/2]

void FConfigCacheIni::UnloadFile ( const FString & Filename )

◆ UnloadFile() [2/2]

void FConfigCacheIni::UnloadFile ( const FString * Filename )

inline

Definition at line 2355 of file Other.h.

Member Data Documentation

◆ bAreFileOperationsDisabled

bool FConfigCacheIni::bAreFileOperationsDisabled

private

true if file operations should not be performed

Definition at line 1309 of file ConfigCacheIni.h.

◆ bIsReadyForUse

bool FConfigCacheIni::bIsReadyForUse

private

true after the base .ini files have been loaded, and GConfig is generally "ready for use"

Definition at line 1312 of file ConfigCacheIni.h.

◆ FConfigContext

friend FConfigCacheIni::FConfigContext

private

Definition at line 1322 of file ConfigCacheIni.h.

◆ KnownFiles

FKnownConfigFiles FConfigCacheIni::KnownFiles

private

The filenames for the known files in this config

Definition at line 1318 of file ConfigCacheIni.h.

◆ OtherFiles

TMap<FString, FConfigFile*> FConfigCacheIni::OtherFiles

private

Definition at line 1320 of file ConfigCacheIni.h.

◆ Type

EConfigCacheType FConfigCacheIni::Type

private

The type of the cache (basically, do we call Flush in the destructor)

Definition at line 1315 of file ConfigCacheIni.h.

The documentation for this class was generated from the following files:

C:/Users/lachl/Downloads/ArkServerAPI_NEW/ASA/AsaApi/AsaApi/Core/Public/API/ARK/Other.h
C:/Users/lachl/Downloads/ArkServerAPI_NEW/ASA/AsaApi/AsaApi/Core/Public/API/UE/Misc/ConfigCacheIni.h

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FConfigCacheIni() [1/2]

◆ FConfigCacheIni() [2/2]

◆ ~FConfigCacheIni()

Member Function Documentation

◆ Add() [1/2]

◆ Add() [2/2]

◆ AreFileOperationsDisabled() [1/2]

◆ AreFileOperationsDisabled() [2/2]

◆ bIsReadyForUseField()

◆ ClearOtherPlatformConfigs()

◆ ContainsConfigFile()

◆ CreateGConfigFromSaved() [1/2]

◆ CreateGConfigFromSaved() [2/2]

◆ Detach()

◆ DisableFileOperations()

◆ DoesSectionExist() [1/2]

◆ DoesSectionExist() [2/2]

◆ Dump() [1/2]

◆ Dump() [2/2]

◆ EmptySection() [1/2]

◆ EmptySection() [2/2]

◆ EmptySectionsMatchingString()

◆ EnableFileOperations()

◆ Exit()

◆ Find() [1/3]

◆ Find() [2/3]

◆ Find() [3/3]

◆ FindConfigFile() [1/2]

◆ FindConfigFile() [2/2]

◆ FindConfigFileWithBaseName() [1/2]

◆ FindConfigFileWithBaseName() [2/2]

◆ FindOrLoadPlatformConfig() [1/2]

◆ FindOrLoadPlatformConfig() [2/2]

◆ FindPlatformConfig() [1/2]

◆ FindPlatformConfig() [2/2]

◆ FKnownConfigFiles()

◆ Flush() [1/2]

◆ Flush() [2/2]

◆ ForEachEntry() [1/2]

◆ ForEachEntry() [2/2]

◆ ForPlatform()

◆ GetArray() [1/2]

◆ GetArray() [2/2]

◆ GetBool() [1/2]

◆ GetBool() [2/2]

◆ GetBoolOrDefault()

◆ GetColor()

◆ GetConfigFilename() [1/2]

◆ GetConfigFilename() [2/2]

◆ GetConfigFilenames()

◆ GetCustomConfigString() [1/2]

◆ GetCustomConfigString() [2/2]

◆ GetDestIniFilename() [1/2]

◆ GetDestIniFilename() [2/2]

◆ GetDouble()

◆ GetFilenames() [1/2]

◆ GetFilenames() [2/2]

◆ GetFloat() [1/2]

◆ GetFloat() [2/2]

◆ GetFloatOrDefault()

◆ GetInt() [1/2]

◆ GetInt() [2/2]

◆ GetIntOrDefault() [1/2]

◆ GetIntOrDefault() [2/2]

◆ GetMaxMemoryUsage() [1/2]

◆ GetMaxMemoryUsage() [2/2]

◆ GetPerObjectConfigSections() [1/2]

◆ GetPerObjectConfigSections() [2/2]

◆ GetRotator()

◆ GetSection() [1/2]

◆ GetSection() [2/2]

◆ GetSectionNames() [1/2]

◆ GetSectionNames() [2/2]