1. Epic GamesDeveloper
  3. FConfigContext

FConfigContext

API > API/Runtime > API/Runtime/Core

   
Name FConfigContext
Type class
Header File /Engine/Source/Runtime/Core/Public/Misc/ConfigContext.h
Include Path #include "Misc/ConfigContext.h"

Syntax

class FConfigContext

Constructors

Name Remarks Include Path Unreal Specifiers

FConfigContext ( FConfigCacheIni* InConfigSystem,
bool InIsHierarchicalConfig,
const FString& InPlatform,
FConfigFile* DestConfigFile
)

   Misc/ConfigContext.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FConfigContext()

   Misc/ConfigContext.h  

Structs

Name Remarks
FPerPlatformDirs Because the hierarchy can jump between platforms, we cache off some directories per chained-platform

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAllowGeneratedIniWhenCooked bool   Misc/ConfigContext.h  
bAllowRemoteConfig bool   Misc/ConfigContext.h  
BaseIniName FString   Misc/ConfigContext.h  
bDefaultEngineRequired bool   Misc/ConfigContext.h  
bForceReload bool   Misc/ConfigContext.h  
bIncludeTagNameInBranchName bool GameFeaturePlugins have WindowsFooGame.ini, not WindowsGame.ini. Misc/ConfigContext.h  
bIsFixingUpAfterBinaryConfig bool   Misc/ConfigContext.h  
bIsForPlugin bool   Misc/ConfigContext.h  
bIsForPluginModification bool   Misc/ConfigContext.h  
bIsHierarchicalConfig bool   Misc/ConfigContext.h  
bIsMakingBinaryConfig bool   Misc/ConfigContext.h  
Branch FConfigBranch *   Misc/ConfigContext.h  
bUseHierarchyCache bool   Misc/ConfigContext.h  
bWriteDestIni bool   Misc/ConfigContext.h  
ChangeTracker FConfigModificationTracker *   Misc/ConfigContext.h  
ChildPluginBaseDirs TArray< FString >   Misc/ConfigContext.h  
ConfigFileTag FName   Misc/ConfigContext.h  
ConfigSystem FConfigCacheIni *   Misc/ConfigContext.h  
DestIniFilename FString   Misc/ConfigContext.h  
EngineConfigDir FString   Misc/ConfigContext.h  
EngineRootDir FString   Misc/ConfigContext.h  
ExistingFile FConfigFile *   Misc/ConfigContext.h  
GeneratedConfigDir FString   Misc/ConfigContext.h  
HandleLayersFunction TFunction< void(const TArray< FDynamicLayerInfo > &)>   Misc/ConfigContext.h  
IniCacheSet const TSet< FString > * If this is non-null, it contains a set of pre-scanned ini files to use to find files, instead of looking on disk Misc/ConfigContext.h  
OverrideLayers TArray< FConfigLayer > Allow a custom set of layers Misc/ConfigContext.h  
PerPlatformDirs TMap< FString, FPerPlatformDirs >   Misc/ConfigContext.h  
Platform FString   Misc/ConfigContext.h  
PluginModificationPriority DynamicLayerPriority   Misc/ConfigContext.h  
PluginRootDir FString   Misc/ConfigContext.h  
ProjectConfigDir FString   Misc/ConfigContext.h  
ProjectLimitedAccessDir FString Useful strings that are used alot when walking the hierarchy Misc/ConfigContext.h  
ProjectNoRedistDir FString   Misc/ConfigContext.h  
ProjectNotForLicenseesDir FString   Misc/ConfigContext.h  
ProjectRootDir FString   Misc/ConfigContext.h  
SavePlatform FString   Misc/ConfigContext.h  
StagedGlobalConfigCache const TSet< FString > *   Misc/ConfigContext.h  
StagedPluginConfigCache const TSet< FString > *   Misc/ConfigContext.h  
StartSkippingAtFilename FString   Misc/ConfigContext.h  
TemporaryBranch FConfigBranch *   Misc/ConfigContext.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

const FPerPlatformDirs & GetPerPlatformDirs ( const FString& PlatformName
)

 Return the paths to use to find hierarchical config files for the given platform (note that these are independent of the ini name) Misc/ConfigContext.h  

bool Load ( const TCHAR* IniName,
FString& OutFilename
)

 Use the context to perform the actual load operation as above, but will return the generated final ini filename (in the case of GConfig, this would be the key used to look up into GConfig, for example) Misc/ConfigContext.h  

bool Load ( const TCHAR* IniName
)

 Use the context to perform the actual load operation. Misc/ConfigContext.h  

void VisualizeHierarchy ( FOutputDevice& Ar,
const TCHAR* IniName
)

 Visualize an existing hierarchy Misc/ConfigContext.h  

Protected

Static

Name Remarks Include Path Unreal Specifiers

static void EnsureRequiredGlobalPathsHaveBeenInitialized()

 Call to make before attempting parallel config init Misc/ConfigContext.h  

static FConfigContext FixupBranchAfterBinaryConfig()

 Create a context to read only the saved/generated file (eg. /Saved/Windows/Input.ini) and commandline options after loading a binary config, that was of course made without saved files and commandline options Misc/ConfigContext.h  

static FConfigContext ForceReloadIntoGConfig()

 Create a context to read a hierarchical config into GConfig. Only for current platform. Misc/ConfigContext.h  

static FConfigContext ReadIntoConfigSystem ( FConfigCacheIni* ConfigSystem,
const FString& Platform
)

 Create a context to read a hierarchical config into the given ConfigSystem structure - usually will be for other platforms Misc/ConfigContext.h  

static FConfigContext ReadIntoGConfig()

 Create a context to read a hierarchical config into GConfig. Only for current platform. Misc/ConfigContext.h  

static FConfigContext ReadIntoLocalFile ( FConfigFile& DestConfigFile,
const FString& Platform
)

 Create a context to read a hierarchical config into the given local FConfigFile, optionally for another platform Misc/ConfigContext.h  

static FConfigContext ReadIntoPluginFile ( FConfigFile& DestConfigFile,
const FString& PluginRootDir,
const TArray< FString >& ChildPluginsBaseDirs,
const FString& Platform
)

 Create a context to read a plugin's ini file named for the plugin. Misc/ConfigContext.h  

static FConfigContext ReadPluginIntoConfigSystem ( FConfigCacheIni* ConfigSystem,
FName PluginName,
const FString& PluginRootDir,
const TArray< FString >& ChildPluginsBaseDirs
)

 Inserts plugin ini files into an existing Branch Misc/ConfigContext.h  

static FConfigContext ReadPluginToModifyConfigSystem ( FConfigCacheIni* ConfigSystem,
DynamicLayerPriority Priority,
FName PluginName,
const FString& PluginRootDir,
const TArray< FString >& ChildPluginsBaseDirs,
FConfigModificationTracker* ChangeTracker
)

 Inserts plugin ini files into an existing Branch Misc/ConfigContext.h  

static FConfigContext ReadSingleIntoConfigSystem ( FConfigCacheIni* ConfigSystem,
const FString& Platform
)

 Create a context to read a non-hierarchical config into the given ConfigSystem structure - usually will be for other platforms Misc/ConfigContext.h  

static FConfigContext ReadSingleIntoGConfig()

 Create a context to read a non-hierarchical config into GConfig. Only for current platform. Misc/ConfigContext.h  

static FConfigContext ReadSingleIntoLocalFile ( FConfigFile& DestConfigFile,
const FString& Platform
)

 Create a context to read a non-hierarchical config into the given local FConfigFile, optionally for another platform Misc/ConfigContext.h  

static FConfigContext ReadUpToBeforeFile ( FConfigFile& DestConfigFile,
const FString& Platform,
const FString& StartSkippingAtFilename
)

 Create a context to read a hierarchy, but once it reaches the given filename (StartDeletingFilename), it will not read in anymore files at that point Misc/ConfigContext.h  

static void VisualizeHierarchy ( FOutputDevice& Ar,
const TCHAR* IniName,
const TCHAR* OverridePlatform,
const TCHAR* OverrideProjectOrProgramDataDir,
const TCHAR* OverridePluginDir,
const TArray< FString >* ChildPluginBaseDirs
)

 Log out the config full hierarchy of a file, with various overrides to see other projects/platforms/etc hierarchies Misc/ConfigContext.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page