1. Epic GamesDeveloper
  3. FConfigBranch

FConfigBranch

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

References

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

Syntax

class FConfigBranch

Variables

  Type Name Description
Public variable bool bIsHierarchical  
Public variable bool bIsSafeUnloaded  
Public variable FConfigFile CombinedStaticLayers Cache the static layers so when remaking dynamic layers after removing a dynamic layer it's faster
Public variable FConfigCommandStream CommandLineOverrides  
Public variable DynamicLayerList DynamicLayers  
Public variable FConfigFile FinalCombinedLayers This contains everything read from disk - when saving the diff between this and InMemoryFile is written out
Public variable FConfigFileHierarchy Hierarchy  
Public variable FName IniName Base name of the branch, like "Engine"
Public variable FString IniPath "final" path for the branch like "Saved/Config/WIndows/Engine.ini"
Public variable FConfigFile InMemoryFile This is the file that maps to the old FConfigFiles stored in the FConfigCacheIni
Public variable FName Platform  
Public variable EBranchReplayMethod ReplayMethod  
Public variable FConfigCommandStream RuntimeChanges Tracks runtime changes for optimal saving
Public variable FConfigCommandStream SavedLayer TMap DynamicLayers;.
Public variable FString SourceEngineConfigDir Locations where this file may have come from - used to merge with non-standard ini locations.
Public variable FString SourceProjectConfigDir  
Public variable TMap< FString, FConfigCommandStream > StaticLayers  

Constructors

  Type Name Description
Public function   Standard branch that will be used by, say, GConfig to hold the inis for Engine, Game, etc.
Public function  

FConfigBranch ( const FConfigFile& ExistingFile
)

 A "dummy" branch used to manage a single external FConfigFile.

Functions

  Type Name Description
Public function bool

AddDynamicLayersToHierarchy ( const TArray< FString >& Filenames,
FName Tag,
DynamicLayerPriority Priority,
FConfigModificationTracker* ModificationTracker
)

  
Public function bool

AddDynamicLayerStringToHierarchy ( const FString& Filename,
const FString& Contents,
FName Tag,
DynamicLayerPriority Priority,
FConfigModificationTracker* ModificationTracker
)

 Add a preloaded string as a dynamic layer (useful for hotfixing)
Public function bool

AddDynamicLayerToHierarchy ( const FString& Filename,
FConfigModificationTracker* ModificationTracker
)

 Appends a new INI file to the SourceIniHierarchy and combines it with the current contents Additonally, returns the FConfigFIle object that contains just the loaded sections Can return the modified sections if the callers wants to reloadconfig on classes
Public function void  
Public function void

Flush ()

  
Public function bool

RemoveDynamicLayerFromHierarchy ( const FString& Filename,
FConfigModificationTracker* ModificationTracker
)

 Removes a dyanmic file from the hierarchy and recalculates the branch's IniMemoryFile Can return the modified sections if the callers wants to reloadconfig on classes
Public function bool

RemoveDynamicLayersFromHierarchy ( const TArray< FString >& Filenames,
FConfigModificationTracker* ModificationTracker
)

  
Public function bool

RemoveSection ( const TCHAR* Section
)

 Removes the section completely from all layers of this branch This is destructive! It will not reload on demand (like SafeUnload does).
Public function void  
Public function void

RunOnEachFile ( TFunction< void(FConfigFile&File, const FString&Name)> Func
)

 Run a function on every file in the branch
Public function void  
Public function void Frees up the static layer memory, which can be useful if a branch is loaded from, cached, and never used again.
Public function void

Shrink ()

  

Typedefs

Name Description
DynamicLayerList  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page