Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
Classes | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
FConfigContext Class Reference

#include <ConfigContext.h>

+ Collaboration diagram for FConfigContext:

Classes

struct  FPerPlatformDirs
 

Public Member Functions

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

Static Public Member Functions

static FConfigContext ReadIntoLocalFile (FConfigFile &DestConfigFile, const FString &Platform=FString())
 
static FConfigContext ReadSingleIntoLocalFile (FConfigFile &DestConfigFile, const FString &Platform=FString())
 
static FConfigContext ReadIntoGConfig ()
 
static FConfigContext ForceReloadIntoGConfig ()
 
static FConfigContext ReadSingleIntoGConfig ()
 
static FConfigContext ReadIntoConfigSystem (FConfigCacheIni *ConfigSystem, const FString &Platform)
 
static FConfigContext ReadSingleIntoConfigSystem (FConfigCacheIni *ConfigSystem, const FString &Platform)
 
static FConfigContext ReadIntoPluginFile (FConfigFile &DestConfigFile, const FString &PluginRootDir)
 
static FConfigContext ReadUpToBeforeFile (FConfigFile &DestConfigFile, const FString &Platform, const FString &StartSkippingAtFilename)
 
static void EnsureRequiredGlobalPathsHaveBeenInitialized ()
 

Public Attributes

FConfigCacheIni * ConfigSystem
 
FConfigFile * ConfigFile = nullptr
 
FString DestIniFilename
 
FString Platform
 
FString SavePlatform
 
FString GeneratedConfigDir
 
FString BaseIniName
 
FString StartSkippingAtFilename
 
FString EngineConfigDir
 
FString EngineRootDir
 
FString ProjectConfigDir
 
FString ProjectRootDir
 
FString PluginRootDir
 
FString ProjectNotForLicenseesDir
 
FString ProjectNoRedistDir
 
TMap< FString, FPerPlatformDirs > PerPlatformDirs
 
bool bUseHierarchyCache = false
 
bool bAllowGeneratedIniWhenCooked = false
 
bool bForceReload = false
 
bool bAllowRemoteConfig = false
 
bool bIsHierarchicalConfig
 
bool bWriteDestIni = false
 
bool bDefaultEngineRequired = false
 
bool bIsForPlugin = false
 
const TSet< FString > * IniCacheSet = nullptr
 

Protected Member Functions

 FConfigContext (FConfigCacheIni *InConfigSystem, bool InIsHierarchicalConfig, const FString &InPlatform, FConfigFile *DestConfigFile=nullptr)
 
FConfigContext & ResetBaseIni (const TCHAR *InBaseIniName)
 
void CachePaths ()
 
bool PrepareForLoad (bool &bPerformLoad)
 
bool PerformLoad ()
 
void AddStaticLayersToHierarchy ()
 
bool GenerateDestIniFile ()
 
FString PerformFinalExpansions (const FString &InString, const FString &Platform)
 

Protected Attributes

bool bDoNotResetConfigFile = false
 
bool bCacheOnNextLoad = true
 

Detailed Description

Definition at line 29 of file ConfigContext.h.

Constructor & Destructor Documentation

◆ FConfigContext()

FConfigContext::FConfigContext ( FConfigCacheIni * InConfigSystem,
bool InIsHierarchicalConfig,
const FString & InPlatform,
FConfigFile * DestConfigFile = nullptr )
protected
+ Here is the caller graph for this function:

Member Function Documentation

◆ AddStaticLayersToHierarchy()

void FConfigContext::AddStaticLayersToHierarchy ( )
protected

◆ CachePaths()

void FConfigContext::CachePaths ( )
protected

◆ EnsureRequiredGlobalPathsHaveBeenInitialized()

static void FConfigContext::EnsureRequiredGlobalPathsHaveBeenInitialized ( )
static

Call to make before attempting parallel config init

◆ ForceReloadIntoGConfig()

static FConfigContext FConfigContext::ForceReloadIntoGConfig ( )
inlinestatic

Create a context to read a hierarchical config into GConfig. Only for current platform.

Definition at line 61 of file ConfigContext.h.

+ Here is the call graph for this function:

◆ GenerateDestIniFile()

bool FConfigContext::GenerateDestIniFile ( )
protected

◆ GetPerPlatformDirs()

const FPerPlatformDirs & FConfigContext::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)

◆ Load() [1/2]

bool FConfigContext::Load ( const TCHAR * IniName)

Use the context to perform the actual load operation. Note that this is where you specify the Ini name (for instance "Engine"), meaning you can use the same context for multiple configs (Engine, Game, Input, etc)

◆ Load() [2/2]

bool FConfigContext::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)

◆ PerformFinalExpansions()

FString FConfigContext::PerformFinalExpansions ( const FString & InString,
const FString & Platform )
protected

◆ PerformLoad()

bool FConfigContext::PerformLoad ( )
protected

◆ PrepareForLoad()

bool FConfigContext::PrepareForLoad ( bool & bPerformLoad)
protected

◆ ReadIntoConfigSystem()

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

Create a context to read a hierarchical config into the given ConfigSystem structure - usually will be for other platforms

Definition at line 79 of file ConfigContext.h.

+ Here is the call graph for this function:

◆ ReadIntoGConfig()

static FConfigContext FConfigContext::ReadIntoGConfig ( )
inlinestatic

Create a context to read a hierarchical config into GConfig. Only for current platform.

Definition at line 53 of file ConfigContext.h.

+ Here is the call graph for this function:

◆ ReadIntoLocalFile()

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

Create a context to read a hierarchical config into the given local FConfigFile, optionally for another platform

Definition at line 37 of file ConfigContext.h.

+ Here is the call graph for this function:

◆ ReadIntoPluginFile()

static FConfigContext FConfigContext::ReadIntoPluginFile ( FConfigFile & DestConfigFile,
const FString & PluginRootDir )
inlinestatic

Create a context to read a plugin's ini file named for the plugin. This is not used for inserting, say, Engine.ini into GConfig

Definition at line 95 of file ConfigContext.h.

+ Here is the call graph for this function:

◆ ReadSingleIntoConfigSystem()

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

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

Definition at line 87 of file ConfigContext.h.

+ Here is the call graph for this function:

◆ ReadSingleIntoGConfig()

static FConfigContext FConfigContext::ReadSingleIntoGConfig ( )
inlinestatic

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

Definition at line 71 of file ConfigContext.h.

+ Here is the call graph for this function:

◆ ReadSingleIntoLocalFile()

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

Create a context to read a non-hierarchical config into the given local FConfigFile, optionally for another platform

Definition at line 45 of file ConfigContext.h.

+ Here is the call graph for this function:

◆ ReadUpToBeforeFile()

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

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

Definition at line 113 of file ConfigContext.h.

+ Here is the call graph for this function:

◆ ResetBaseIni()

FConfigContext & FConfigContext::ResetBaseIni ( const TCHAR * InBaseIniName)
protected

Member Data Documentation

◆ bAllowGeneratedIniWhenCooked

bool FConfigContext::bAllowGeneratedIniWhenCooked = false

Definition at line 173 of file ConfigContext.h.

◆ bAllowRemoteConfig

bool FConfigContext::bAllowRemoteConfig = false

Definition at line 175 of file ConfigContext.h.

◆ BaseIniName

FString FConfigContext::BaseIniName

Definition at line 158 of file ConfigContext.h.

◆ bCacheOnNextLoad

bool FConfigContext::bCacheOnNextLoad = true
protected

Definition at line 187 of file ConfigContext.h.

◆ bDefaultEngineRequired

bool FConfigContext::bDefaultEngineRequired = false

Definition at line 178 of file ConfigContext.h.

◆ bDoNotResetConfigFile

bool FConfigContext::bDoNotResetConfigFile = false
protected

Definition at line 186 of file ConfigContext.h.

◆ bForceReload

bool FConfigContext::bForceReload = false

Definition at line 174 of file ConfigContext.h.

◆ bIsForPlugin

bool FConfigContext::bIsForPlugin = false

Definition at line 179 of file ConfigContext.h.

◆ bIsHierarchicalConfig

bool FConfigContext::bIsHierarchicalConfig

Definition at line 176 of file ConfigContext.h.

◆ bUseHierarchyCache

bool FConfigContext::bUseHierarchyCache = false

Definition at line 172 of file ConfigContext.h.

◆ bWriteDestIni

bool FConfigContext::bWriteDestIni = false

Definition at line 177 of file ConfigContext.h.

◆ ConfigFile

FConfigFile* FConfigContext::ConfigFile = nullptr

Definition at line 153 of file ConfigContext.h.

◆ ConfigSystem

FConfigCacheIni* FConfigContext::ConfigSystem

Definition at line 151 of file ConfigContext.h.

◆ DestIniFilename

FString FConfigContext::DestIniFilename

Definition at line 154 of file ConfigContext.h.

◆ EngineConfigDir

FString FConfigContext::EngineConfigDir

Definition at line 161 of file ConfigContext.h.

◆ EngineRootDir

FString FConfigContext::EngineRootDir

Definition at line 162 of file ConfigContext.h.

◆ GeneratedConfigDir

FString FConfigContext::GeneratedConfigDir

Definition at line 157 of file ConfigContext.h.

◆ IniCacheSet

const TSet<FString>* FConfigContext::IniCacheSet = nullptr

Definition at line 182 of file ConfigContext.h.

◆ PerPlatformDirs

TMap<FString, FPerPlatformDirs> FConfigContext::PerPlatformDirs

Definition at line 170 of file ConfigContext.h.

◆ Platform

FString FConfigContext::Platform

Definition at line 155 of file ConfigContext.h.

◆ PluginRootDir

FString FConfigContext::PluginRootDir

Definition at line 165 of file ConfigContext.h.

◆ ProjectConfigDir

FString FConfigContext::ProjectConfigDir

Definition at line 163 of file ConfigContext.h.

◆ ProjectNoRedistDir

FString FConfigContext::ProjectNoRedistDir

Definition at line 169 of file ConfigContext.h.

◆ ProjectNotForLicenseesDir

FString FConfigContext::ProjectNotForLicenseesDir

Definition at line 168 of file ConfigContext.h.

◆ ProjectRootDir

FString FConfigContext::ProjectRootDir

Definition at line 164 of file ConfigContext.h.

◆ SavePlatform

FString FConfigContext::SavePlatform

Definition at line 156 of file ConfigContext.h.

◆ StartSkippingAtFilename

FString FConfigContext::StartSkippingAtFilename

Definition at line 159 of file ConfigContext.h.

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