Inheritance diagram for FConsoleVariableShadow:

Public Member Functions
	FConsoleVariableShadow (const TCHAR CVarToShadow, EShadowCVarBehavior InLookupBehavior, EShadowCVarBehavior InUsageBehavior, bool bInIsDeprecated, const TCHAR InDeprecatedVersion, const TCHAR *InDeprecationMessage)

virtual class IConsoleVariable *	AsVariable () override

virtual bool	IsShadowObject () const override

virtual IConsoleObject *	GetShadowedObject () const override

virtual bool	IsDeprecated () const override

virtual bool	IsVariableBool () const override

virtual bool	IsVariableInt () const override

virtual bool	IsVariableFloat () const override

virtual bool	IsVariableString () const override

virtual class TConsoleVariableData< bool > *	AsVariableBool () override

virtual class TConsoleVariableData< int32 > *	AsVariableInt () override

virtual class TConsoleVariableData< float > *	AsVariableFloat () override

virtual class TConsoleVariableData< FString > *	AsVariableString () override

virtual const TCHAR *	GetHelp () const override

virtual FText	GetDetailedHelp () const override

virtual void	SetHelp (const TCHAR *Value) override

virtual EConsoleVariableFlags	GetFlags () const override

virtual void	SetFlags (const EConsoleVariableFlags Value) override

virtual FConsoleVariableBase::FResolvedContext	ResolveContext (const FConsoleVariableBase::FSetContext &Context) override

virtual void	Set (const TCHAR *Value, const FConsoleVariableBase::FResolvedContext &Context) override

virtual void	Unset (EConsoleVariableFlags SetBy, FName Tag) override

virtual bool	GetBool () const override

virtual int32	GetInt () const override

virtual float	GetFloat () const override

virtual FString	GetString () const override

virtual void	SetOnChangedCallback (const FConsoleVariableDelegate &Callback) override

virtual FConsoleVariableMulticastDelegate &	OnChangedDelegate () override

virtual FString	GetDefaultValue () override

virtual void	LogHistory (FOutputDevice &Ar) override

virtual SIZE_T	GetHistorySize () override

virtual void	Release () override

Public Member Functions inherited from IConsoleVariable
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 struct IConsoleCommand *	AsCommand ()

Protected Member Functions
virtual IConsoleObject *	GetRealObject () const override

virtual void	SetRealObject (IConsoleObject *Object) const override

virtual FString	GetThisName () const override

Protected Member Functions inherited from FConsoleObjectShadowData
	FConsoleObjectShadowData (const TCHAR CVarToShadow, EShadowCVarBehavior InLookupBehavior, EShadowCVarBehavior InUsageBehavior, bool bInIsDeprecated, const TCHAR InDeprecatedVersion, const TCHAR *InDeprecationMessage=nullptr)

virtual	~FConsoleObjectShadowData ()

void	LogOrEditorMessage (const FText &Msg, bool bIsError) const

bool	Bind () const

bool	BindForUsage () const

Additional Inherited Members
Protected Attributes inherited from FConsoleObjectShadowData
FString	ShadowName

FString	DeprecatedVersion

FString	DeprecationMessage

EShadowCVarBehavior	LookupBehavior

EShadowCVarBehavior	UsageBehavior

uint8	bHasLooked: 1

uint8	bHasMessagedForUsage: 1

uint8	bHasMessagedEditorForUsage: 1

uint8	bIsDeprecated: 1

Constructor & Destructor Documentation

◆ FConsoleVariableShadow()

FConsoleVariableShadow::FConsoleVariableShadow	(	const TCHAR *	CVarToShadow,
		EShadowCVarBehavior	InLookupBehavior,
		EShadowCVarBehavior	InUsageBehavior,
		bool	bInIsDeprecated,
		const TCHAR *	InDeprecatedVersion,
		const TCHAR *	InDeprecationMessage
	)

inline

Member Function Documentation

◆ AsVariable()

virtual class IConsoleVariable * FConsoleVariableShadow::AsVariable ( )

inlineoverridevirtual

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

Reimplemented from IConsoleObject.

◆ AsVariableBool()

virtual class TConsoleVariableData< bool > * FConsoleVariableShadow::AsVariableBool ( )

inlineoverridevirtual

Reimplemented from IConsoleObject.

◆ AsVariableFloat()

virtual class TConsoleVariableData< float > * FConsoleVariableShadow::AsVariableFloat ( )

inlineoverridevirtual

Reimplemented from IConsoleObject.

◆ AsVariableInt()

virtual class TConsoleVariableData< int32 > * FConsoleVariableShadow::AsVariableInt ( )

inlineoverridevirtual

Reimplemented from IConsoleObject.

◆ AsVariableString()

virtual class TConsoleVariableData< FString > * FConsoleVariableShadow::AsVariableString ( )

inlineoverridevirtual

Reimplemented from IConsoleObject.

◆ GetBool()

virtual bool FConsoleVariableShadow::GetBool ( ) const

inlineoverridevirtual

Get the internal value as a bool, works on bools, ints and floats.

Implements IConsoleVariable.

◆ GetDefaultValue()

virtual FString FConsoleVariableShadow::GetDefaultValue ( )

inlineoverridevirtual

Get the value this CVar was constructed with

Implements IConsoleVariable.

◆ GetDetailedHelp()

virtual FText FConsoleVariableShadow::GetDetailedHelp ( ) const

inlineoverridevirtual

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

Reimplemented from IConsoleObject.

◆ GetFlags()

virtual EConsoleVariableFlags FConsoleVariableShadow::GetFlags ( ) const

inlineoverridevirtual

Get the internal state of the flags.

Implements IConsoleObject.

◆ GetFloat()

virtual float FConsoleVariableShadow::GetFloat ( ) const

inlineoverridevirtual

Get the internal value as float (works on all types).

Implements IConsoleVariable.

◆ GetHelp()

virtual const TCHAR * FConsoleVariableShadow::GetHelp ( ) const

inlineoverridevirtual

Returns: never 0, can be multi line ('
')

Implements IConsoleObject.

◆ GetHistorySize()

virtual SIZE_T FConsoleVariableShadow::GetHistorySize ( )

inlineoverridevirtual

Track memory used by history data

Implements IConsoleVariable.

◆ GetInt()

virtual int32 FConsoleVariableShadow::GetInt ( ) const

inlineoverridevirtual

Get the internal value as int (should not be used on strings).

Returns: value is not rounded (simple cast)

Implements IConsoleVariable.

◆ GetRealObject()

virtual IConsoleObject * FConsoleVariableShadow::GetRealObject ( ) const

inlineoverrideprotectedvirtual

Implements FConsoleObjectShadowData.

◆ GetShadowedObject()

virtual IConsoleObject * FConsoleVariableShadow::GetShadowedObject ( ) const

inlineoverridevirtual

If IsShadowObject() returns true, this function will return the "real" variable the shadow cvar is shadowing. Generally not needed, as most functions (like GetInt, Set, etc) will operate on the real variable already

Reimplemented from IConsoleObject.

◆ GetString()

virtual FString FConsoleVariableShadow::GetString ( ) const

inlineoverridevirtual

Get the internal value as string (works on all types).

Implements IConsoleVariable.

◆ GetThisName()

virtual FString FConsoleVariableShadow::GetThisName ( ) const

inlineoverrideprotectedvirtual

Implements FConsoleObjectShadowData.

◆ IsDeprecated()

virtual bool FConsoleVariableShadow::IsDeprecated ( ) const

inlineoverridevirtual

Reimplemented from IConsoleObject.

◆ IsShadowObject()

virtual bool FConsoleVariableShadow::IsShadowObject ( ) const

inlineoverridevirtual

A shadow ConsoleObject is one that exists and can be used, but shouldn't be iterated over in anything that walks over every object and acts on it

Reimplemented from IConsoleObject.

◆ IsVariableBool()

virtual bool FConsoleVariableShadow::IsVariableBool ( ) const

inlineoverridevirtual

Reimplemented from IConsoleObject.

◆ IsVariableFloat()

virtual bool FConsoleVariableShadow::IsVariableFloat ( ) const

inlineoverridevirtual

Reimplemented from IConsoleObject.

◆ IsVariableInt()

virtual bool FConsoleVariableShadow::IsVariableInt ( ) const

inlineoverridevirtual

Reimplemented from IConsoleObject.

◆ IsVariableString()

virtual bool FConsoleVariableShadow::IsVariableString ( ) const

inlineoverridevirtual

Reimplemented from IConsoleObject.

◆ LogHistory()

virtual void FConsoleVariableShadow::LogHistory ( FOutputDevice & Ar )

inlineoverridevirtual

Print the history to a log

Implements IConsoleVariable.

◆ OnChangedDelegate()

virtual FConsoleVariableMulticastDelegate & FConsoleVariableShadow::OnChangedDelegate ( )

inlineoverridevirtual

Implements IConsoleVariable.

◆ Release()

virtual void FConsoleVariableShadow::Release ( )

inlineoverridevirtual

should only be called by the manager, needs to be implemented for each instance

Implements IConsoleObject.

◆ ResolveContext()

virtual FConsoleVariableBase::FResolvedContext FConsoleVariableShadow::ResolveContext ( const FConsoleVariableBase::FSetContext & Context )

inlineoverridevirtual

Implements IConsoleVariable.

◆ Set()

virtual void FConsoleVariableShadow::Set	(	const TCHAR *	InValue,
		const FConsoleVariableBase::FResolvedContext &	Context
	)

inlineoverridevirtual

Set the internal value from the specified string.

Parameters

InValue	Internal Value to Set
Context	The ResolvedContext of the FSetContext

Implements IConsoleVariable.

◆ SetFlags()

virtual void FConsoleVariableShadow::SetFlags ( const EConsoleVariableFlags Value )

inlineoverridevirtual

Sets the internal flag state to the specified value.

Implements IConsoleObject.

◆ SetHelp()

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

inlineoverridevirtual

Returns: never 0, can be multi line ('
')

Implements IConsoleObject.

◆ SetOnChangedCallback()

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

inlineoverridevirtual

Allows to specify a callback function that is called when the console variable value changes. Is even called if the value is the same as the value before. Will always be on the game thread. This can be dangerous (instead try to use RegisterConsoleVariableSink())

Setting other console variables in the delegate can cause infinite loops
Setting many console variables could result in wasteful cycles (e.g. if multiple console variables require to reattach all objects it would happen for each one)
The call can be at any time during initialization. As this cannot be specified during constructions you are not called on creation. We also don't call for the SetOnChangedCallback() call as this is up to the caller.

Implements IConsoleVariable.

◆ SetRealObject()

virtual void FConsoleVariableShadow::SetRealObject ( IConsoleObject * Object ) const

inlineoverrideprotectedvirtual

Implements FConsoleObjectShadowData.

◆ Unset()

virtual void FConsoleVariableShadow::Unset	(	EConsoleVariableFlags	SetBy,
		FName	Tag
	)

inlineoverridevirtual

Unsets the value at a certain SetBy priority (this is only useful when UE_ALLOW_CVAR_HISTORY is set). The value of the CVar will be recalculated based on remaining History levels

Parameters

SetBy	anything in ECVF_LastSetMask e.g. ECVF_SetByScalability
Tag	tag used to remove a setting from an ARRAY type SetBy

Implements IConsoleVariable.

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

Additional Inherited Members

Constructor & Destructor Documentation

◆ FConsoleVariableShadow()

Member Function Documentation

◆ AsVariable()

◆ AsVariableBool()

◆ AsVariableFloat()

◆ AsVariableInt()

◆ AsVariableString()

◆ GetBool()

◆ GetDefaultValue()

◆ GetDetailedHelp()

◆ GetFlags()

◆ GetFloat()

◆ GetHelp()

◆ GetHistorySize()

◆ GetInt()

◆ GetRealObject()

◆ GetShadowedObject()

◆ GetString()

◆ GetThisName()

◆ IsDeprecated()

◆ IsShadowObject()

◆ IsVariableBool()

◆ IsVariableFloat()

◆ IsVariableInt()

◆ IsVariableString()

◆ LogHistory()

◆ OnChangedDelegate()

◆ Release()

◆ ResolveContext()

◆ Set()

◆ SetFlags()

◆ SetHelp()

◆ SetOnChangedCallback()

◆ SetRealObject()

◆ Unset()