Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
UE::ConfigUtilities Namespace Reference

Functions

void OnSetCVarFromIniEntry (const TCHAR *IniFile, const TCHAR *Key, const TCHAR *Value, uint32 SetBy, bool bAllowCheating=false, bool bNoLogging=false)
 
void ApplyCVarSettingsFromIni (const TCHAR *InSectionBaseName, const TCHAR *InIniFilename, uint32 SetBy, bool bAllowCheating=false)
 
void ForEachCVarInSectionFromIni (const TCHAR *InSectionName, const TCHAR *InIniFilename, TFunction< void(IConsoleVariable *CVar, const FString &KeyString, const FString &ValueString)> InEvaluationFunction)
 
void RecordApplyCVarSettingsFromIni ()
 
void ReapplyRecordedCVarSettingsFromIni ()
 
void DeleteRecordedCVarSettingsFromIni ()
 
void RecordConfigReadsFromIni ()
 
void DumpRecordedConfigReadsFromIni ()
 
void DeleteRecordedConfigReadsFromIni ()
 
const TCHARConvertValueFromHumanFriendlyValue (const TCHAR *Value)
 

Function Documentation

◆ ApplyCVarSettingsFromIni()

void UE::ConfigUtilities::ApplyCVarSettingsFromIni ( const TCHAR * InSectionBaseName,
const TCHAR * InIniFilename,
uint32 SetBy,
bool bAllowCheating = false )

Helper function to read the contents of an ini file and a specified group of cvar parameters, where sections in the ini file are marked [InName]

Parameters
InSectionBaseName- The base name of the section to apply cvars from
InIniFilename- The ini filename
SetByanything in ECVF_LastSetMask e.g. ECVF_SetByScalability

◆ ConvertValueFromHumanFriendlyValue()

const TCHAR * UE::ConfigUtilities::ConvertValueFromHumanFriendlyValue ( const TCHAR * Value)

Helper function to deal with "True","False","Yes","No","On","Off"

◆ DeleteRecordedConfigReadsFromIni()

void UE::ConfigUtilities::DeleteRecordedConfigReadsFromIni ( )

Helper function to clean up config read history

◆ DeleteRecordedCVarSettingsFromIni()

void UE::ConfigUtilities::DeleteRecordedCVarSettingsFromIni ( )

Helper function to clean up ini history

◆ DumpRecordedConfigReadsFromIni()

void UE::ConfigUtilities::DumpRecordedConfigReadsFromIni ( )

Helper function to dump config reads to csv after RecordConfigReadsFromIni was called

◆ ForEachCVarInSectionFromIni()

void UE::ConfigUtilities::ForEachCVarInSectionFromIni ( const TCHAR * InSectionName,
const TCHAR * InIniFilename,
TFunction< void(IConsoleVariable *CVar, const FString &KeyString, const FString &ValueString)> InEvaluationFunction )

Helper function to operate a user defined function for each CVar key/value pair in the specified section in an ini file

Parameters
InSectionName- The name of the section to apply cvars from
InIniFilename- The ini filename
InEvaluationFunction- The evaluation function to be called for each key/value pair

◆ OnSetCVarFromIniEntry()

void UE::ConfigUtilities::OnSetCVarFromIniEntry ( const TCHAR * IniFile,
const TCHAR * Key,
const TCHAR * Value,
uint32 SetBy,
bool bAllowCheating = false,
bool bNoLogging = false )

Single function to set a cvar from ini (handing friendly names, cheats for shipping and message about cheats in non shipping)

◆ ReapplyRecordedCVarSettingsFromIni()

void UE::ConfigUtilities::ReapplyRecordedCVarSettingsFromIni ( )

Helper function to reapply inis which have been applied after RecordCVarIniHistory was called

◆ RecordApplyCVarSettingsFromIni()

void UE::ConfigUtilities::RecordApplyCVarSettingsFromIni ( )

CVAR Ini history records all calls to ApplyCVarSettingsFromIni and can re run them Helper function to start recording ApplyCVarSettings function calls uses these to generate a history of applied ini settings sections

◆ RecordConfigReadsFromIni()

void UE::ConfigUtilities::RecordConfigReadsFromIni ( )

Helper function to start recording config reads