1. Epic GamesDeveloper
  3. FConfigContext

FConfigContext

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Misc

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/Misc/ConfigContext.h
Include #include "Misc/ConfigContext.h"

Syntax

class FConfigContext

Variables

  Type Name Description
Public variable bool bAllowGeneratedIniWhenCooked  
Public variable bool bAllowRemoteConfig  
Public variable FString BaseIniName  
Protected variable bool bCacheOnNextLoad  
Public variable bool bDefaultEngineRequired  
Protected variable bool bDoNotResetConfigFile  
Public variable bool bForceReload  
Public variable bool bIncludeTagNameInBranchName GameFeaturePlugins have WindowsFooGame.ini, not WindowsGame.ini.
Public variable bool bIsForPlugin  
Public variable bool bIsForPluginModification  
Public variable bool bIsHierarchicalConfig  
Public variable FConfigBranch * Branch  
Public variable bool bUseHierarchyCache  
Public variable bool bWriteDestIni  
Public variable FConfigModificationTracker * ChangeTracker  
Public variable TArray< FString > ChildPluginBaseDirs  
Public variable FName ConfigFileTag  
Public variable FConfigCacheIni * ConfigSystem  
Public variable FString DestIniFilename  
Public variable FString EngineConfigDir  
Public variable FString EngineRootDir  
Public variable FConfigFile * ExistingFile  
Public variable FString GeneratedConfigDir  
Public variable const TSet< FString > * IniCacheSet If this is non-null, it contains a set of pre-scanned ini files to use to find files, instead of looking on disk
Public variable TArray< FConfigLayer > OverrideLayers Allow a custom set of layers
Public variable TMap< FString, FPerPlatformDirs > PerPlatformDirs  
Public variable FString Platform  
Public variable DynamicLayerPriority PluginModificationPriority  
Public variable FString PluginRootDir  
Public variable FString ProjectConfigDir  
Public variable FString ProjectLimitedAccessDir Useful strings that are used alot when walking the hierarchy
Public variable FString ProjectNoRedistDir  
Public variable FString ProjectNotForLicenseesDir  
Public variable FString ProjectRootDir  
Public variable FString SavePlatform  
Public variable FString StartSkippingAtFilename  
Public variable FConfigBranch * TemporaryBranch  

Constructors

  Type Name Description
Protected function  

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

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Static void Call to make before attempting parallel config init
Public function Static FConfigContext Create a context to read a hierarchical config into GConfig. Only for current platform.
Public function 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)
Public function 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)
Public function bool

Load ( const TCHAR* IniName
)

 Use the context to perform the actual load operation.
Public function 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
Public function Static FConfigContext Create a context to read a hierarchical config into GConfig. Only for current platform.
Public function 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
Public function 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.
Public function Static FConfigContext

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

 Inserts plugin ini files into an existing Branch
Public function 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
Public function 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
Public function Static FConfigContext Create a context to read a non-hierarchical config into GConfig. Only for current platform.
Public function 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
Public function 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
Public function void

VisualizeHierarchy ( FOutputDevice& Ar,
const TCHAR* IniName
)

 Visualize an existing hierarchy
Public function 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

Classes

  Type Name Description
Public struct FPerPlatformDirs Because the hierarchy can jump between platforms, we cache off some directories per chained-platform  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page