Navigation
API > API/Runtime > API/Runtime/Core
Set of all cached config files.
| Name | FConfigCacheIni |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/Misc/ConfigCacheIni.h |
| Include Path | #include "Misc/ConfigCacheIni.h" |
Syntax
class FConfigCacheIni
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FConfigCacheIni
(
EConfigCacheType Type, |
Basic functions. | Misc/ConfigCacheIni.h | |
| DO NOT USE. This constructor is for internal usage only for hot-reload purposes. | Misc/ConfigCacheIni.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FConfigCacheIni() |
Misc/ConfigCacheIni.h |
Structs
| Name | Remarks |
|---|---|
| FKnownConfigFiles | |
| FPluginInfo |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| RegisteredPlugins | TMap< FName, FPluginInfo * > | Misc/ConfigCacheIni.h | |
| RegisteredPluginsLock | FTransactionallySafeCriticalSection | Misc/ConfigCacheIni.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bAreFileOperationsDisabled | bool | True if file operations should not be performed | Misc/ConfigCacheIni.h | |
| bGloballyRegistered | bool | Misc/ConfigCacheIni.h | ||
| bIsReadyForUse | bool | True after the base .ini files have been loaded, and GConfig is generally "ready for use" | Misc/ConfigCacheIni.h | |
| ConfigBranchNamesToNeverUnload | TArray< FString > | List of ConfigBranch names that should never be unloaded. | Misc/ConfigCacheIni.h | |
| FConfigContext | friend | Misc/ConfigCacheIni.h | ||
| KnownFiles | FKnownConfigFiles | The filenames for the known files in this config | Misc/ConfigCacheIni.h | |
| OtherFileNames | TArray< FString > | Parallel array to OtherFiles | Misc/ConfigCacheIni.h | |
| OtherFiles | TMap< FString, FConfigBranch * > | Misc/ConfigCacheIni.h | ||
| OtherFilesLock | FTransactionallySafeCriticalSection | Misc/ConfigCacheIni.h | ||
| PendingModificationPlugins | TArray< FName > | Misc/ConfigCacheIni.h | ||
| PlatformName | FName | The platform this config system is for - if empty, then it can't be used with dynamic plugin layering | Misc/ConfigCacheIni.h | |
| StagedGlobalConfigCache | TSet< FString > * | A cache discovered at staging time and loaded from BinaryConfig.ini | Misc/ConfigCacheIni.h | |
| StagedPluginConfigCache | TMap< FName, TSet< FString > > | Misc/ConfigCacheIni.h | ||
| Type | EConfigCacheType | The type of the cache (basically, do we call Flush in the destructor) | Misc/ConfigCacheIni.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FConfigFile & Add
(
const FString& Filename, |
Misc/ConfigCacheIni.h | ||
FConfigBranch & AddNewBranch
(
const FString& Filename |
Create a new branch for FIlename, and return it | Misc/ConfigCacheIni.h | |
bool AddToSection
(
const TCHAR* Section, |
Adds the given key/value pair to the Section in the given File. | Misc/ConfigCacheIni.h | |
| Misc/ConfigCacheIni.h | |||
| Adds the given key/value pair to the Section in the given File, if the pair didn't already exist This is equivalent to the + operator in .ini files | Misc/ConfigCacheIni.h | ||
| Misc/ConfigCacheIni.h | |||
bool AreFileOperationsDisabled() |
Returns whether or not file operations are disabled | Misc/ConfigCacheIni.h | |
bool ContainsConfigFile
(
const FConfigFile* ConfigFile |
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 | Misc/ConfigCacheIni.h | |
void Detach
(
const FString& Filename |
Misc/ConfigCacheIni.h | ||
void DisableFileOperations() |
Disables any file IO by the config cache system | Misc/ConfigCacheIni.h | |
bool DoesSectionExist
(
const TCHAR* Section, |
Misc/ConfigCacheIni.h | ||
void Dump
(
FOutputDevice& Ar, |
Prints out the entire config set, or just a single file if an ini is specified | Misc/ConfigCacheIni.h | |
bool EmptySection
(
const TCHAR* Section, |
Misc/ConfigCacheIni.h | ||
bool EmptySectionsMatchingString
(
const TCHAR* SectionString, |
Misc/ConfigCacheIni.h | ||
void EnableFileOperations() |
Re-enables file IO by the config cache system | Misc/ConfigCacheIni.h | |
void Exit() |
Misc/ConfigCacheIni.h | ||
FConfigFile * Find
(
const FString& InFilename |
Finds, loads, or creates the in-memory config file for a config cache filename. | Misc/ConfigCacheIni.h | |
FConfigBranch * FindBranch
(
FName BaseIniName, |
Finds an FConfigBranch, using base name or a filename (can pass in NAME_None or empty string as needed) | Misc/ConfigCacheIni.h | |
FConfigBranch * FindBranchWithNoReload
(
FName BaseIniName, |
Same as FindBranch, but this will not reload a formerly SafeUnload'd branch | Misc/ConfigCacheIni.h | |
FConfigFile * FindConfigFile
(
const FString& Filename |
Finds the in-memory config file for a config cache filename. | Misc/ConfigCacheIni.h | |
FConfigFile * FindConfigFileWithBaseName
(
FName BaseName |
Finds Config file that matches the base name such as "Engine" | Misc/ConfigCacheIni.h | |
void Flush
(
bool bRemoveFromCache, |
Misc/ConfigCacheIni.h | ||
bool ForEachEntry
(
const FKeyValueSink& Visitor, |
Allows to iterate through all key value pairs | Misc/ConfigCacheIni.h | |
| Misc/ConfigCacheIni.h | |||
bool GetBool
(
const TCHAR* Section, |
Misc/ConfigCacheIni.h | ||
bool GetBoolOrDefault
(
const TCHAR* Section, |
Misc/ConfigCacheIni.h | ||
| Misc/ConfigCacheIni.h | |||
FString GetConfigFilename
(
const TCHAR* BaseIniName |
For a base ini name, gets the config cache filename key that is used by other functions like Find. | Misc/ConfigCacheIni.h | |
| Retrieve a list of all of the config files stored in the cache | Misc/ConfigCacheIni.h | ||
bool GetDouble
(
const TCHAR* Section, |
Misc/ConfigCacheIni.h | ||
| Misc/ConfigCacheIni.h | |||
bool GetFloat
(
const TCHAR* Section, |
Misc/ConfigCacheIni.h | ||
float GetFloatOrDefault
(
const TCHAR* Section, |
Misc/ConfigCacheIni.h | ||
bool GetInt
(
const TCHAR* Section, |
Misc/ConfigCacheIni.h | ||
bool GetInt64
(
const TCHAR* Section, |
Misc/ConfigCacheIni.h | ||
int32 GetIntOrDefault
(
const TCHAR* Section, |
Return a config value if found, if not found return default value does not indicate if return value came from config or the default value useful for one-time init of static variables in code locations where config may be queried too often, like : static int32 bMyConfigValue = GConfig->GetIntOrDefault(Section,Key,DefaultValue,ConfigFilename); | Misc/ConfigCacheIni.h | |
SIZE_T GetMaxMemoryUsage() |
USed to get the max memory usage for the FConfigCacheIni | Misc/ConfigCacheIni.h | |
| Retrieve the names of sections which contain data for the specified PerObjectConfig class. | Misc/ConfigCacheIni.h | ||
bool GetRotator
(
const TCHAR* Section, |
Misc/ConfigCacheIni.h | ||
bool GetSection
(
const TCHAR* Section, |
Misc/ConfigCacheIni.h | ||
const FConfigSection * GetSection
(
const TCHAR* Section, |
Misc/ConfigCacheIni.h | ||
| Retrieve the names for all sections contained in the file specified by Filename | Misc/ConfigCacheIni.h | ||
| Loads a "delimited" list of strings Loads a "delimited" list of string | Misc/ConfigCacheIni.h | ||
const TSet< FString > * GetStagedGlobalConfigCache() |
Returns the staged global config cache | Misc/ConfigCacheIni.h | |
| Finds the Staged Plugin ConfigCache if it exists from a PluginName Returns a pointer to the cache if it exists, a nullptr if not | Misc/ConfigCacheIni.h | ||
| Derived functions. | Misc/ConfigCacheIni.h | ||
| Misc/ConfigCacheIni.h | |||
| Misc/ConfigCacheIni.h | |||
| Misc/ConfigCacheIni.h | |||
| Misc/ConfigCacheIni.h | |||
| Misc/ConfigCacheIni.h | |||
| Misc/ConfigCacheIni.h | |||
| Misc/ConfigCacheIni.h | |||
| Generic versions for use with templates | Misc/ConfigCacheIni.h | ||
| Misc/ConfigCacheIni.h | |||
| Misc/ConfigCacheIni.h | |||
bool GetVector
(
const TCHAR* Section, |
Misc/ConfigCacheIni.h | ||
bool GetVector2D
(
const TCHAR* Section, |
Misc/ConfigCacheIni.h | ||
bool GetVector4
(
const TCHAR* Section, |
Misc/ConfigCacheIni.h | ||
bool IsGloballyRegistered() |
Return whether this is one of the global ConfigSystems: GConfig or FConfigCacheIni::ForPlatform. | Misc/ConfigCacheIni.h | |
bool 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") | Misc/ConfigCacheIni.h | |
bool IsReadyForUse() |
Misc/ConfigCacheIni.h | ||
void LoadFile
(
const FString& InFilename, |
Misc/ConfigCacheIni.h | ||
| 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 | Misc/ConfigCacheIni.h | ||
| 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 | Misc/ConfigCacheIni.h | ||
int32 Remove
(
const FString& Filename |
Misc/ConfigCacheIni.h | ||
| Removes every entry in the Section in the given File that has the Key/Value pair This is equivalent to the - operator in .ini files (although it will remove all instances of the pair, not just a single one) | Misc/ConfigCacheIni.h | ||
| Misc/ConfigCacheIni.h | |||
bool RemoveKey
(
const TCHAR* Section, |
Misc/ConfigCacheIni.h | ||
| Removes every entry in the Section in the given File that has Key, no matter what the Value is This is equivalent to the ! operator in .ini files | Misc/ConfigCacheIni.h | ||
| Misc/ConfigCacheIni.h | |||
bool RemoveSectionFromBranch
(
const TCHAR* Section, |
Removes the section completely from all layers of a branch. | Misc/ConfigCacheIni.h | |
bool ResetKeyInSection
(
const TCHAR* Section, |
Similar to RemvoeKeyFromSection, but if this File's changes are being tracked, then we remove all changes to the the key that have been tracked. | Misc/ConfigCacheIni.h | |
| Misc/ConfigCacheIni.h | |||
bool SafeUnloadBranch
(
const TCHAR* Filename |
Clears out the memory of a branch, but can reload it on demand if needed | Misc/ConfigCacheIni.h | |
void SaveCurrentStateForBootstrap
(
const TCHAR* Filename |
Save the current config cache state into a file for bootstrapping other processes. | Misc/ConfigCacheIni.h | |
void Serialize
(
FArchive& Ar |
Misc/ConfigCacheIni.h | ||
| Misc/ConfigCacheIni.h | |||
| Misc/ConfigCacheIni.h | |||
void SetBool
(
const TCHAR* Section, |
Misc/ConfigCacheIni.h | ||
| Misc/ConfigCacheIni.h | |||
void SetDouble
(
const TCHAR* Section, |
Misc/ConfigCacheIni.h | ||
void SetFile
(
const FString& InFilename, |
Misc/ConfigCacheIni.h | ||
void SetFloat
(
const TCHAR* Section, |
Misc/ConfigCacheIni.h | ||
bool SetInSection
(
const TCHAR* Section, |
Sets the given key/value pair to the Section in the given File. | Misc/ConfigCacheIni.h | |
| Misc/ConfigCacheIni.h | |||
void SetInt
(
const TCHAR* Section, |
Misc/ConfigCacheIni.h | ||
void SetRotator
(
const TCHAR* Section, |
Misc/ConfigCacheIni.h | ||
| Saves a "delimited" list of strings Saves a "delimited" list of strings | Misc/ConfigCacheIni.h | ||
void SetString
(
const TCHAR* Section, |
Misc/ConfigCacheIni.h | ||
| Misc/ConfigCacheIni.h | |||
void SetVector
(
const TCHAR* Section, |
Misc/ConfigCacheIni.h | ||
void SetVector2D
(
const TCHAR* Section, |
Misc/ConfigCacheIni.h | ||
void SetVector4
(
const TCHAR* Section, |
Misc/ConfigCacheIni.h | ||
void ShowMemoryUsage
(
FOutputDevice& Ar |
Dumps memory stats for each file in the config cache to the specified archive. | Misc/ConfigCacheIni.h | |
void Tick
(
float DeltaSeconds |
Allow for periodic cleanup or other tasks | Misc/ConfigCacheIni.h | |
void UnloadFile
(
const FString& Filename |
Misc/ConfigCacheIni.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void AddMultiplePluginsToAllBranches
(
const TArray< FName >& PluginName, |
Misc/ConfigCacheIni.h | ||
static void AddPluginToAllBranches
(
FName PluginName, |
Misc/ConfigCacheIni.h | ||
static void AsyncInitializeConfigForPlatforms() |
We only auto-initialize other platform configs in the editor to not slow down programs like ShaderCOmpileWorker | Misc/ConfigCacheIni.h | |
static void ClearOtherPlatformConfigs() |
Wipe all cached platform configs. Next ForPlatform call will load on-demand the platform configs | Misc/ConfigCacheIni.h | |
static bool CreateGConfigFromSaved
(
const TCHAR* Filename |
Create GConfig from a saved file | Misc/ConfigCacheIni.h | |
static FConfigFile * FindOrLoadPlatformConfig
(
FConfigFile& LocalFile, |
This helper function searches the cache before trying to load the ini file using LoadLocalIniFile. | Misc/ConfigCacheIni.h | |
static FConfigFile * FindPlatformConfig
(
const TCHAR* IniName, |
Attempts to find the platform config in the cache. | Misc/ConfigCacheIni.h | |
static FConfigCacheIni * ForPlatform
(
FName PlatformName |
Retrieve the fully processed ini system for another platform. | Misc/ConfigCacheIni.h | |
static const FString & GetCustomConfigString () |
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. | Misc/ConfigCacheIni.h | |
static FString GetDestIniFilename
(
const TCHAR* BaseIniName, |
Calculates the name of a dest (generated) .ini file for a given base (ie Engine, Game, etc) | Misc/ConfigCacheIni.h | |
static void InitializeConfigSystem () |
Creates GConfig, loads the standard global ini files (Engine, Editor, etc), fills out GEngineIni, etc. | Misc/ConfigCacheIni.h | |
static bool InitializeKnownConfigFiles
(
FConfigContext& Context |
Load the standard (used on all platforms) ini files, like Engine, Input, etc | Misc/ConfigCacheIni.h | |
static void LoadConsoleVariablesFromINI () |
Needs to be called after GConfig is set and LoadCoalescedFile was called. | Misc/ConfigCacheIni.h | |
static bool LoadExternalIniFile
(
FConfigFile& ConfigFile, |
Load an ini file directly into an FConfigFile from the specified config folders, optionally writing to disk. | Misc/ConfigCacheIni.h | |
static bool LoadGlobalIniFile
(
FString& FinalIniFilename, |
Loads and generates a destination ini file and adds it to GConfig: | Misc/ConfigCacheIni.h | |
static bool LoadLocalIniFile
(
FConfigFile& ConfigFile, |
Load an ini file directly into an FConfigFile, and nothing is written to GConfig or disk. | Misc/ConfigCacheIni.h | |
static FString NormalizeConfigIniPath
(
const FString& NonNormalizedPath |
Normalizes file paths to INI files. | Misc/ConfigCacheIni.h | |
static void PreInitializePlatformPlugins () |
Initializes configs and plugins for every supported platform on worker threads. | Misc/ConfigCacheIni.h | |
static void RegisterPlugin
(
FName PluginName, |
Tell GConfig and the ForPlatform config systems about a plugin location | Misc/ConfigCacheIni.h | |
static void RemoveMultipleTagsFromAllBranches
(
const TArray< FName >& Tags, |
Misc/ConfigCacheIni.h | ||
static void RemoveTagFromAllBranches
(
FName Tag, |
Misc/ConfigCacheIni.h |