FConsoleVariableHistory< T > Class Template Reference

Public Types
using	FHistoryData = TConsoleVariableData< T >
using	FTaggedHistoryData = TPair< FName, FHistoryData >

Public Member Functions
void	FindHighestPriorityAndTag (EConsoleVariableFlags MinPriority, EConsoleVariableFlags MaxPriority, EConsoleVariableFlags &OutFlags, FName &OutTag)
bool	Track (const TCHAR *InValue, EConsoleVariableFlags Flags, FName Tag)
bool	Unset (EConsoleVariableFlags Flags, FName Tag)
const FHistoryData &	GetMaxValue (EConsoleVariableFlags &MaxSetBy)
void	Log (FOutputDevice &Ar)

Public Attributes
TSortedMap< int, TArray< FTaggedHistoryData > >	History
bool	bHasTaggedArrayData = false

Member Typedef Documentation

FHistoryData

template<class T >

using FConsoleVariableHistory< T >::FHistoryData = TConsoleVariableData<T>

FTaggedHistoryData

template<class T >

using FConsoleVariableHistory< T >::FTaggedHistoryData = TPair<FName, FHistoryData>

Member Function Documentation

FindHighestPriorityAndTag()

template<class T >

void FConsoleVariableHistory< T >::FindHighestPriorityAndTag ( EConsoleVariableFlags  MinPriority, EConsoleVariableFlags  MaxPriority, EConsoleVariableFlags &  OutFlags, FName &  OutTag  )

inline

GetMaxValue()

template<class T >

const FHistoryData & FConsoleVariableHistory< T >::GetMaxValue ( EConsoleVariableFlags &  MaxSetBy )

inline

Log()

template<class T >

void FConsoleVariableHistory< T >::Log ( FOutputDevice &  Ar )

inline

Track()

template<class T >

bool FConsoleVariableHistory< T >::Track ( const TCHAR *  InValue, EConsoleVariableFlags  Flags, FName  Tag  )

inline

When we change a vlaue, we track the change at each priority level, so we can unset them later.

Returns

false if this changed a value in place and it is not the final level (in array type priorities). This is used to not fire unnecessary callbacks in this case: PluginHighPriority -> Tag1=Foo, Tag2=Bar, and we are setting Tag1 to Baz the value of the cvar cannot change, and when we update in place we are trying to minimize callbacks

Unset()

template<class T >

bool FConsoleVariableHistory< T >::Unset ( EConsoleVariableFlags  Flags, FName  Tag  )

inline

Unset the value at the SetBy, and optionally Tag. Return true if it had been set, or false if nothing happened

Member Data Documentation

bHasTaggedArrayData

template<class T >

bool FConsoleVariableHistory< T >::bHasTaggedArrayData = false

History

template<class T >

TSortedMap<int, TArray<FTaggedHistoryData> > FConsoleVariableHistory< T >::History

---

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

• Engine/Source/Runtime/Core/Private/HAL/ConsoleManager.cpp