Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
TAutoConsoleVariable< T > Class Template Reference

#include <IConsoleManager.h>

+ Inheritance diagram for TAutoConsoleVariable< T >:
+ Collaboration diagram for TAutoConsoleVariable< T >:

Public Member Functions

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

Private Attributes

TConsoleVariableData< T > * Ref
 

Additional Inherited Members

- Static Public Member Functions inherited from FAutoConsoleObject
static TArray< const FAutoConsoleObject * > & AccessGeneralShaderChangeCvars ()
 
static TArray< const FAutoConsoleObject * > & AccessMobileShaderChangeCvars ()
 
static 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.

Definition at line 1491 of file IConsoleManager.h.

Constructor & Destructor Documentation

◆ TAutoConsoleVariable() [1/6]

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

Create a float, int or string console variable

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

◆ TAutoConsoleVariable() [2/6]

template<class T >
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

Definition at line 1509 of file IConsoleManager.h.

◆ TAutoConsoleVariable() [3/6]

TAutoConsoleVariable< bool >::TAutoConsoleVariable ( const TCHAR * Name,
const bool & DefaultValue,
const TCHAR * Help,
uint32 Flags )
inline

Definition at line 1553 of file IConsoleManager.h.

◆ TAutoConsoleVariable() [4/6]

TAutoConsoleVariable< int32 >::TAutoConsoleVariable ( const TCHAR * Name,
const int32 & DefaultValue,
const TCHAR * Help,
uint32 Flags )
inline

Definition at line 1560 of file IConsoleManager.h.

◆ TAutoConsoleVariable() [5/6]

TAutoConsoleVariable< float >::TAutoConsoleVariable ( const TCHAR * Name,
const float & DefaultValue,
const TCHAR * Help,
uint32 Flags )
inline

Definition at line 1567 of file IConsoleManager.h.

◆ TAutoConsoleVariable() [6/6]

TAutoConsoleVariable< FString >::TAutoConsoleVariable ( const TCHAR * Name,
const FString & DefaultValue,
const TCHAR * Help,
uint32 Flags )
inline

Definition at line 1574 of file IConsoleManager.h.

Member Function Documentation

◆ GetValueOnAnyThread()

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

Definition at line 1525 of file IConsoleManager.h.

◆ GetValueOnGameThread()

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

Definition at line 1515 of file IConsoleManager.h.

◆ GetValueOnRenderThread()

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

Definition at line 1520 of file IConsoleManager.h.

◆ operator*() [1/2]

Dereference back to a variable

Definition at line 1531 of file IConsoleManager.h.

◆ operator*() [2/2]

Definition at line 1535 of file IConsoleManager.h.

◆ operator->() [1/2]

Dereference back to a variable

Definition at line 1540 of file IConsoleManager.h.

◆ operator->() [2/2]

Definition at line 1544 of file IConsoleManager.h.

Member Data Documentation

◆ Ref

template<class T >
TConsoleVariableData<T>* TAutoConsoleVariable< T >::Ref
private

Definition at line 1549 of file IConsoleManager.h.


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