UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
TAutoConsoleVariable< T > Class Template Reference

#include <IConsoleManager.h>

+ Inheritance diagram for TAutoConsoleVariable< T >:

Public Member Functions

 TAutoConsoleVariable (IConsoleVariable *ExistingObject)
 
FORCENOINLINE TAutoConsoleVariable (const TCHAR *Name, const T &DefaultValue, const TCHAR *Help, uint32 Flags=ECVF_Default)
 
FORCENOINLINE TAutoConsoleVariable (const TCHAR *Name, const T &DefaultValue, const TCHAR *Help, const FConsoleVariableDelegate &Callback, uint32 Flags=ECVF_Default)
 
GetValueOnGameThread () const
 
GetValueOnRenderThread () const
 
GetValueOnAnyThread (bool bForceGameThread=false) const
 
UE_FORCEINLINE_HINT IConsoleVariableoperator* ()
 
UE_FORCEINLINE_HINT const IConsoleVariableoperator* () const
 
UE_FORCEINLINE_HINT IConsoleVariableoperator-> ()
 
UE_FORCEINLINE_HINT const IConsoleVariableoperator-> () const
 
- Public Member Functions inherited from FAutoConsoleObject
virtual CORE_API ~FAutoConsoleObject ()
 
IConsoleVariableAsVariable ()
 
const IConsoleVariableAsVariable () const
 

Additional Inherited Members

- Static Public Member Functions inherited from FAutoConsoleObject
static CORE_API TArray< const FAutoConsoleObject * > & AccessGeneralShaderChangeCvars ()
 
static CORE_API TArray< const FAutoConsoleObject * > & AccessMobileShaderChangeCvars ()
 
static CORE_API TArray< const FAutoConsoleObject * > & AccessDesktopShaderChangeCvars ()
 
- Protected Member Functions inherited from FAutoConsoleObject
 FAutoConsoleObject (IConsoleObject *InTarget)
 

Detailed Description

template<class T>
class TAutoConsoleVariable< T >

Autoregistering float, int variable class...this changes that value when the console variable is changed.

Constructor & Destructor Documentation

◆ TAutoConsoleVariable() [1/3]

template<class T >
TAutoConsoleVariable< T >::TAutoConsoleVariable ( IConsoleVariable ExistingObject)
inline

◆ TAutoConsoleVariable() [2/3]

template<class T >
FORCENOINLINE TAutoConsoleVariable< T >::TAutoConsoleVariable ( const TCHAR Name,
const T &  DefaultValue,
const TCHAR Help,
uint32  Flags = ECVF_Default 
)
inline

Create a float, int or string console variable

Parameters
Namemust not be 0
Helpmust not be 0
Flagsbitmask combined from EConsoleVariableFlags

◆ TAutoConsoleVariable() [3/3]

template<class T >
FORCENOINLINE TAutoConsoleVariable< T >::TAutoConsoleVariable ( const TCHAR Name,
const T &  DefaultValue,
const TCHAR Help,
const FConsoleVariableDelegate Callback,
uint32  Flags = ECVF_Default 
)
inline

Create a float, int or string console variable

Parameters
Namemust not be 0
Helpmust not be 0
CallbackDelegate called when the variable changes.
See also
IConsoleVariable::SetOnChangedCallback
Parameters
Flagsbitmask combined from EConsoleVariableFlags

Member Function Documentation

◆ GetValueOnAnyThread()

template<class T >
T TAutoConsoleVariable< T >::GetValueOnAnyThread ( bool  bForceGameThread = false) const
inline

◆ GetValueOnGameThread()

template<class T >
T TAutoConsoleVariable< T >::GetValueOnGameThread ( ) const
inline

◆ GetValueOnRenderThread()

template<class T >
T TAutoConsoleVariable< T >::GetValueOnRenderThread ( ) const
inline

◆ operator*() [1/2]

template<class T >
UE_FORCEINLINE_HINT IConsoleVariable & TAutoConsoleVariable< T >::operator* ( )
inline

Dereference back to a variable

◆ operator*() [2/2]

template<class T >
UE_FORCEINLINE_HINT const IConsoleVariable & TAutoConsoleVariable< T >::operator* ( ) const
inline

◆ operator->() [1/2]

template<class T >
UE_FORCEINLINE_HINT IConsoleVariable * TAutoConsoleVariable< T >::operator-> ( )
inline

Dereference back to a variable

◆ operator->() [2/2]

template<class T >
UE_FORCEINLINE_HINT const IConsoleVariable * TAutoConsoleVariable< T >::operator-> ( ) const
inline

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