Inheritance diagram for FConsoleVariableExtendedData< T >:

Public Member Functions
	FConsoleVariableExtendedData (const T &DefaultValue, const TCHAR *Help, EConsoleVariableFlags Flags)

virtual	~FConsoleVariableExtendedData ()

virtual FResolvedContext	ResolveContext (const FSetContext &Context) override

virtual void	SetInternal (const T &TypedValue, EConsoleVariableFlags SetBy)=0

void	SetInternalAndUpdateState (const T &TypedValue, EConsoleVariableFlags SetBy)

virtual FString	GetDefaultValue () override

T	GetDefaultTypedValue ()

Public Member Functions inherited from FConsoleVariableBase
	FConsoleVariableBase (const TCHAR *InHelp, EConsoleVariableFlags InFlags)

void	ApplyPreviewIfScalability ()

virtual const TCHAR *	GetHelp () const

virtual void	SetHelp (const TCHAR *Value) override final

virtual FText	GetDetailedHelp () const override

virtual EConsoleVariableFlags	GetFlags () const

virtual void	SetFlags (const EConsoleVariableFlags Value)

virtual class IConsoleVariable *	AsVariable ()

virtual void	SetOnChangedCallback (const FConsoleVariableDelegate &Callback)

virtual FConsoleVariableMulticastDelegate &	OnChangedDelegate ()

bool	CanChange (EConsoleVariableFlags SetBy) const

virtual void	OnChanged (EConsoleVariableFlags SetBy, bool bForce)

Public Member Functions inherited from IConsoleVariable
virtual void	Set (const TCHAR *InValue, const FResolvedContext &Context)=0

virtual bool	GetBool () const =0

virtual int32	GetInt () const =0

virtual float	GetFloat () const =0

virtual FString	GetString () const =0

void	GetValue (int32 &OutIntValue) const

void	GetValue (bool &OutBoolValue) const

void	GetValue (float &OutFloatValue) const

void	GetValue (FString &OutStringValue) const

virtual IConsoleVariable *	GetDefaultValueVariable ()

void	Set (const TCHAR *InValue, const FSetContext &Context)

void	Set (bool InValue, const FSetContext &Context)

void	Set (int32 InValue, const FSetContext &Context)

void	Set (float InValue, const FSetContext &Context)

template<typename T >
void	Set (T Value, EConsoleVariableFlags Flags=ECVF_SetByCode, FName Tag=NAME_None)

template<typename T >
void	SetWithCurrentPriority (T Value, FName Tag=NAME_None, EConsoleVariableFlags MaxPriority=ECVF_SetByConsole, EConsoleVariableFlags MinPriority=SETBY_ERROR)

template<typename T >
void	ReplaceCurrentPriorityAndTag (T InValue, EConsoleVariableFlags MaxPriority=ECVF_SetByConsole, EConsoleVariableFlags MinPriority=SETBY_ERROR)

Public Member Functions inherited from IConsoleObject
	IConsoleObject ()

virtual	~IConsoleObject ()

void	ClearFlags (const EConsoleVariableFlags Value)

bool	TestFlags (const EConsoleVariableFlags Value) const

bool	IsEnabled () const

virtual IConsoleObject *	GetParentObject () const

virtual bool	IsVariableBool () const

virtual bool	IsVariableInt () const

virtual bool	IsVariableFloat () const

virtual bool	IsVariableString () const

virtual class TConsoleVariableData< bool > *	AsVariableBool ()

virtual class TConsoleVariableData< int32 > *	AsVariableInt ()

virtual class TConsoleVariableData< float > *	AsVariableFloat ()

virtual class TConsoleVariableData< FString > *	AsVariableString ()

virtual struct IConsoleCommand *	AsCommand ()

virtual bool	IsShadowObject () const

virtual IConsoleObject *	GetShadowedObject () const

virtual bool	IsDeprecated () const

Protected Member Functions
bool	TrackHistory (const TCHAR *InValue, EConsoleVariableFlags SetBy, FName Tag)

virtual SIZE_T	GetHistorySize () override

void	LogHistory (FOutputDevice &Ar)

bool	PreprocessSet (const TCHAR *InValue, EConsoleVariableFlags SetBy, FName Tag)

virtual void	Unset (EConsoleVariableFlags SetBy, FName Tag) override

Protected Member Functions inherited from FConsoleVariableBase
uint32	GetShadowIndex () const

Protected Attributes
FConsoleVariableHistory< T > *	PriorityHistory = nullptr

Protected Attributes inherited from FConsoleVariableBase
FString	Help

EConsoleVariableFlags	Flags

FConsoleVariableMulticastDelegate	OnChangedCallback

FDelegateHandle	LegacyDelegateHandle

bool	bWarnedAboutThreadSafety

Friends
class	FConsoleManager

Constructor & Destructor Documentation

◆ FConsoleVariableExtendedData()

template<class T >

FConsoleVariableExtendedData< T >::FConsoleVariableExtendedData	(	const T &	DefaultValue,
		const TCHAR *	Help,
		EConsoleVariableFlags	Flags
	)

◆ ~FConsoleVariableExtendedData()

template<class T >

virtual FConsoleVariableExtendedData< T >::~FConsoleVariableExtendedData ( )

inlinevirtual

Member Function Documentation

◆ GetDefaultTypedValue()

template<class T >

T FConsoleVariableExtendedData< T >::GetDefaultTypedValue ( )

inline

◆ GetDefaultValue()

template<class T >

virtual FString FConsoleVariableExtendedData< T >::GetDefaultValue ( )

inlineoverridevirtual

Get the value this CVar was constructed with

Implements IConsoleVariable.

◆ GetHistorySize()

template<class T >

virtual SIZE_T FConsoleVariableExtendedData< T >::GetHistorySize ( )

inlineoverrideprotectedvirtual

Track memory used by history data

Implements IConsoleVariable.

◆ LogHistory()

template<class T >

void FConsoleVariableExtendedData< T >::LogHistory ( FOutputDevice & Ar )

inlineprotectedvirtual

Print the history to a log

Reimplemented from FConsoleVariableBase.

◆ PreprocessSet()

template<class T >

bool FConsoleVariableExtendedData< T >::PreprocessSet	(	const TCHAR *	InValue,
		EConsoleVariableFlags	SetBy,
		FName	Tag
	)

inlineprotected

◆ ResolveContext()

template<class T >

virtual FResolvedContext FConsoleVariableExtendedData< T >::ResolveContext ( const FSetContext & Context )

inlineoverridevirtual

Implements IConsoleVariable.

◆ SetInternal()

template<class T >

virtual void FConsoleVariableExtendedData< T >::SetInternal	(	const T &	TypedValue,
		EConsoleVariableFlags	SetBy
	)

pure virtual

Subclasses implement this to simply set TypedValue as the current value for the CVar. It must not call any callbacks

◆ SetInternalAndUpdateState()

template<class T >

void FConsoleVariableExtendedData< T >::SetInternalAndUpdateState	(	const T &	TypedValue,
		EConsoleVariableFlags	SetBy
	)

inline

Similar to the Set function, except that it must always work, independent of priority. This is used by the History system to set the value wth a lower priority, and then update the priority.

◆ TrackHistory()

template<class T >

bool FConsoleVariableExtendedData< T >::TrackHistory	(	const TCHAR *	InValue,
		EConsoleVariableFlags	SetBy,
		FName	Tag
	)

inlineprotected

This is the key function that subclasses need to call in their Set() implementation. This will track the values of cvars at different priorities, so priorities/plugins/etc can be unset later, and the CVar will updatae state correctly (in Unset())

◆ Unset()

template<class T >

virtual void FConsoleVariableExtendedData< T >::Unset	(	EConsoleVariableFlags	SetBy,
		FName	Tag
	)

inlineoverrideprotectedvirtual

Removes the value at the given SetBy (and potentially Tag for the Array type SetBy priorities). This will update the current value of the CVar as needed (if the Unset is at the current prio)

Implements IConsoleVariable.

Friends And Related Symbol Documentation

◆ FConsoleManager

template<class T >

friend class FConsoleManager

friend

Member Data Documentation

◆ PriorityHistory

template<class T >

FConsoleVariableHistory<T>* FConsoleVariableExtendedData< T >::PriorityHistory = nullptr

protected

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Constructor & Destructor Documentation

◆ FConsoleVariableExtendedData()

◆ ~FConsoleVariableExtendedData()

Member Function Documentation

◆ GetDefaultTypedValue()

◆ GetDefaultValue()

◆ GetHistorySize()

◆ LogHistory()

◆ PreprocessSet()

◆ ResolveContext()

◆ SetInternal()

◆ SetInternalAndUpdateState()

◆ TrackHistory()

◆ Unset()

Friends And Related Symbol Documentation

◆ FConsoleManager

Member Data Documentation

◆ PriorityHistory