FConsoleVariableBase Class Reference

Inheritance diagram for FConsoleVariableBase:

Public Member Functions
	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	LogHistory (FOutputDevice &Ar)
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 FResolvedContext	ResolveContext (const FSetContext &Context)=0
virtual void	Set (const TCHAR *InValue, const FResolvedContext &Context)=0
virtual void	Unset (EConsoleVariableFlags SetBy, FName Tag=NAME_None)=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 ()
virtual FString	GetDefaultValue ()=0
virtual SIZE_T	GetHistorySize ()=0
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
uint32	GetShadowIndex () const

Protected Attributes
FString	Help
EConsoleVariableFlags	Flags
FConsoleVariableMulticastDelegate	OnChangedCallback
FDelegateHandle	LegacyDelegateHandle
bool	bWarnedAboutThreadSafety

Constructor & Destructor Documentation

FConsoleVariableBase()

FConsoleVariableBase::FConsoleVariableBase ( const TCHAR *  InHelp, EConsoleVariableFlags  InFlags  )

inline

Constructor

Parameters

InHelp

must not be 0, must not be empty

Member Function Documentation

ApplyPreviewIfScalability()

void FConsoleVariableBase::ApplyPreviewIfScalability ( )

inline

AsVariable()

virtual class IConsoleVariable * FConsoleVariableBase::AsVariable ( )

inlinevirtual

Casts this object to an IConsoleVariable, returns 0 if it's not

Reimplemented from IConsoleObject.

CanChange()

bool FConsoleVariableBase::CanChange ( EConsoleVariableFlags  SetBy ) const

inline

GetDetailedHelp()

virtual FText FConsoleVariableBase::GetDetailedHelp ( ) const

inlineoverridevirtual

Returns

a (potentially) more detailed help than GetHelp (e.g. current value for console variables)

Reimplemented from IConsoleObject.

GetFlags()

virtual EConsoleVariableFlags FConsoleVariableBase::GetFlags ( ) const

inlinevirtual

Get the internal state of the flags.

Implements IConsoleObject.

GetHelp()

virtual const TCHAR * FConsoleVariableBase::GetHelp ( ) const

inlinevirtual

Returns

never 0, can be multi line ('
')

Implements IConsoleObject.

GetShadowIndex()

uint32 FConsoleVariableBase::GetShadowIndex ( ) const

inlineprotected

LogHistory()

virtual void FConsoleVariableBase::LogHistory ( FOutputDevice &  Ar )

inlinevirtual

Print the history to a log

Implements IConsoleVariable.

Reimplemented in FConsoleVariableExtendedData< T >, FConsoleVariableExtendedData< FString >, and FConsoleVariableExtendedData< int >.

OnChanged()

virtual void FConsoleVariableBase::OnChanged ( EConsoleVariableFlags  SetBy, bool  bForce  )

inlinevirtual

OnChangedDelegate()

virtual FConsoleVariableMulticastDelegate & FConsoleVariableBase::OnChangedDelegate ( )

inlinevirtual

Returns a multicast delegate with which to register. Called when this CVar changes.

Implements IConsoleVariable.

SetFlags()

virtual void FConsoleVariableBase::SetFlags ( const EConsoleVariableFlags  Value )

inlinevirtual

Sets the internal flag state to the specified value.

Implements IConsoleObject.

SetHelp()

virtual void FConsoleVariableBase::SetHelp ( const TCHAR *  Value )

inlinefinaloverridevirtual

Returns

never 0, can be multi line ('
')

Implements IConsoleObject.

SetOnChangedCallback()

virtual void FConsoleVariableBase::SetOnChangedCallback ( const FConsoleVariableDelegate &  Callback )

inlinevirtual

Legacy function to add old single delegates to the new multicast delegate.

Implements IConsoleVariable.

Member Data Documentation

bWarnedAboutThreadSafety

bool FConsoleVariableBase::bWarnedAboutThreadSafety

mutableprotected

True if this console variable has been used on the wrong thread and we have warned about it.

Flags

EConsoleVariableFlags FConsoleVariableBase::Flags

protected

Help

FString FConsoleVariableBase::Help

protected

LegacyDelegateHandle

FDelegateHandle FConsoleVariableBase::LegacyDelegateHandle

protected

Store the handle to the delegate assigned via the legacy SetOnChangedCallback() so that the previous can be removed if called again.

OnChangedCallback

FConsoleVariableMulticastDelegate FConsoleVariableBase::OnChangedCallback

protected

User function to call when the console variable is changed

---

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

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