ConfigUtilities.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*-----------------------------------------------------------------------------
    Config cache.
-----------------------------------------------------------------------------*/
 
#pragma once
 
#include "Containers/Map.h"
#include "Containers/UnrealString.h"
#include "CoreTypes.h"
#include "Delegates/Delegate.h"
#include "Templates/Function.h"
 
class FString;
class IConsoleVariable;
class FConfigModificationTracker;
 
 
namespace UE::DynamicConfig
{
    extern CORE_API void PerformDynamicConfig(FName Tag, TFunction<void(class FConfigModificationTracker*)> PerformModification, TFunction<void(FConfigModificationTracker*)> PostModification=nullptr);
 
    // this isn't directly used in this module, but the OnlineHotfixManager and GameFeatures plugin use it to talk to each other
    extern CORE_API TMulticastDelegate<void(const FName& Tag, const FName& Branch, class FConfigModificationTracker* ModificationTracker)> HotfixPluginForBranch;
 
    // this calls the UObjectBaseUtility from code where object system is not linked (it also calls TSOnConfigSectionsChanged()!)
    extern CORE_API TMulticastDelegate<void(const FConfigModificationTracker* ChangeTracker)> ReloadObjects;
 
    extern CORE_API TMulticastDelegate<void(const FConfigModificationTracker* ChangeTracker)> UpdateCVarsAndDeviceProfiles;
    
    UE_DEPRECATED(5.6, "Use UpdateCVarsAndDeviceProfiles");
    extern CORE_API TMulticastDelegate<void(const TSet<FString>& ModifiedSections)> UpdateDeviceProfiles;
}
 
 
namespace UE::ConfigUtilities
{
    CORE_API void OnSetCVarFromIniEntry(const TCHAR* IniFile, const TCHAR* Key, const TCHAR* Value, uint32 SetBy, bool bAllowCheating=false, bool bNoLogging=false, FName Tag=NAME_None);
 
    CORE_API void ApplyCVarsFromBootHotfix();
    
    CORE_API void ApplyCVarSettingsFromIni(const TCHAR* InSectionBaseName, const TCHAR* InIniFilename, uint32 SetBy, bool bAllowCheating=false, FName Tag=NAME_None);
 
 
    CORE_API void SaveCVarForNextBoot(const TCHAR* Key, const TCHAR* Value);
 
#if UE_EDITOR
    CORE_API void ApplyCVarOfDllFromBootHotfix(const TCHAR* Key, IConsoleObject* Obj);
#endif
 
    CORE_API void ForEachCVarInSectionFromIni(const TCHAR* InSectionName, const TCHAR* InIniFilename, TFunction<void(IConsoleVariable* CVar, const FString& KeyString, const FString& ValueString)> InEvaluationFunction);
 
    CORE_API void RecordApplyCVarSettingsFromIni();
 
    CORE_API void ReapplyRecordedCVarSettingsFromIni();
 
    CORE_API void DeleteRecordedCVarSettingsFromIni();
 
    CORE_API void RecordConfigReadsFromIni();
 
    CORE_API void DumpRecordedConfigReadsFromIni();
 
    CORE_API void DeleteRecordedConfigReadsFromIni();
 
    CORE_API const TCHAR* ConvertValueFromHumanFriendlyValue(const TCHAR* Value);
}