Navigation
API > API/Runtime > API/Runtime/Core > API/Runtime/Core/FConfigCacheIni
Description
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
| Name | LoadGlobalIniFile |
| Type | function |
| Header File | /Engine/Source/Runtime/Core/Public/Misc/ConfigCacheIni.h |
| Include Path | #include "Misc/ConfigCacheIni.h" |
| Source | /Engine/Source/Runtime/Core/Private/Misc/ConfigCacheIni.cpp |
static bool LoadGlobalIniFile
(
FString & FinalIniFilename,
const TCHAR * BaseIniName,
const TCHAR * Platform,
bool bForceReload,
bool bRequireDefaultIni,
bool bAllowGeneratedIniWhenCooked,
bool bAllowRemoteConfig,
const TCHAR * GeneratedConfigDir,
FConfigCacheIni * ConfigSystem
)
true if the final ini was created successfully.
Parameters
| Name | Remarks |
|---|---|
| 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. |