Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
FAutoConsoleVariableRef Class Reference

#include <IConsoleManager.h>

+ Inheritance diagram for FAutoConsoleVariableRef:
+ Collaboration diagram for FAutoConsoleVariableRef:

Public Member Functions

 FAutoConsoleVariableRef (const TCHAR *Name, int32 &RefValue, const TCHAR *Help, uint32 Flags=ECVF_Default)
 
 FAutoConsoleVariableRef (const TCHAR *Name, float &RefValue, const TCHAR *Help, uint32 Flags=ECVF_Default)
 
 FAutoConsoleVariableRef (const TCHAR *Name, bool &RefValue, const TCHAR *Help, uint32 Flags=ECVF_Default)
 
 FAutoConsoleVariableRef (const TCHAR *Name, FString &RefValue, const TCHAR *Help, uint32 Flags=ECVF_Default)
 
 FAutoConsoleVariableRef (const TCHAR *Name, int32 &RefValue, const TCHAR *Help, const FConsoleVariableDelegate &Callback, uint32 Flags=ECVF_Default)
 
 FAutoConsoleVariableRef (const TCHAR *Name, float &RefValue, const TCHAR *Help, const FConsoleVariableDelegate &Callback, uint32 Flags=ECVF_Default)
 
 FAutoConsoleVariableRef (const TCHAR *Name, bool &RefValue, const TCHAR *Help, const FConsoleVariableDelegate &Callback, uint32 Flags=ECVF_Default)
 
 FAutoConsoleVariableRef (const TCHAR *Name, FString &RefValue, const TCHAR *Help, const FConsoleVariableDelegate &Callback, uint32 Flags=ECVF_Default)
 
virtual ~FAutoConsoleVariableRef ()
 
FORCEINLINE IConsoleVariableoperator* ()
 
FORCEINLINE const IConsoleVariableoperator* () const
 
FORCEINLINE IConsoleVariableoperator-> ()
 
FORCEINLINE const IConsoleVariableoperator-> () const
 

Additional Inherited Members

- Private Member Functions inherited from FAutoConsoleObject
virtual ~FAutoConsoleObject ()
 
FORCEINLINE IConsoleVariableAsVariable ()
 
FORCEINLINE const IConsoleVariableAsVariable () const
 
 FAutoConsoleObject (IConsoleObject *InTarget)
 
- Static Private Member Functions inherited from FAutoConsoleObject
static TArray< const FAutoConsoleObject * > & AccessGeneralShaderChangeCvars ()
 
static TArray< const FAutoConsoleObject * > & AccessMobileShaderChangeCvars ()
 
static TArray< const FAutoConsoleObject * > & AccessDesktopShaderChangeCvars ()
 

Detailed Description

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

Definition at line 1259 of file IConsoleManager.h.

Constructor & Destructor Documentation

◆ FAutoConsoleVariableRef() [1/8]

FAutoConsoleVariableRef::FAutoConsoleVariableRef ( const TCHAR * Name,
int32 & RefValue,
const TCHAR * Help,
uint32 Flags = ECVF_Default )
inline

Create a reference to a int console variable

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

Definition at line 1268 of file IConsoleManager.h.

+ Here is the call graph for this function:

◆ FAutoConsoleVariableRef() [2/8]

FAutoConsoleVariableRef::FAutoConsoleVariableRef ( const TCHAR * Name,
float & RefValue,
const TCHAR * Help,
uint32 Flags = ECVF_Default )
inline

Create a reference to a float console variable

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

Definition at line 1278 of file IConsoleManager.h.

+ Here is the call graph for this function:

◆ FAutoConsoleVariableRef() [3/8]

FAutoConsoleVariableRef::FAutoConsoleVariableRef ( const TCHAR * Name,
bool & RefValue,
const TCHAR * Help,
uint32 Flags = ECVF_Default )
inline

Create a reference to a bool console variable

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

Definition at line 1288 of file IConsoleManager.h.

+ Here is the call graph for this function:

◆ FAutoConsoleVariableRef() [4/8]

FAutoConsoleVariableRef::FAutoConsoleVariableRef ( const TCHAR * Name,
FString & RefValue,
const TCHAR * Help,
uint32 Flags = ECVF_Default )
inline

Create a reference to a FString console variable

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

Definition at line 1298 of file IConsoleManager.h.

+ Here is the call graph for this function:

◆ FAutoConsoleVariableRef() [5/8]

FAutoConsoleVariableRef::FAutoConsoleVariableRef ( const TCHAR * Name,
int32 & RefValue,
const TCHAR * Help,
const FConsoleVariableDelegate & Callback,
uint32 Flags = ECVF_Default )
inline

Create a reference to a int 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 1310 of file IConsoleManager.h.

+ Here is the call graph for this function:

◆ FAutoConsoleVariableRef() [6/8]

FAutoConsoleVariableRef::FAutoConsoleVariableRef ( const TCHAR * Name,
float & RefValue,
const TCHAR * Help,
const FConsoleVariableDelegate & Callback,
uint32 Flags = ECVF_Default )
inline

Create a reference to a float 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 1323 of file IConsoleManager.h.

+ Here is the call graph for this function:

◆ FAutoConsoleVariableRef() [7/8]

FAutoConsoleVariableRef::FAutoConsoleVariableRef ( const TCHAR * Name,
bool & RefValue,
const TCHAR * Help,
const FConsoleVariableDelegate & Callback,
uint32 Flags = ECVF_Default )
inline

Create a reference to a bool 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 1336 of file IConsoleManager.h.

+ Here is the call graph for this function:

◆ FAutoConsoleVariableRef() [8/8]

FAutoConsoleVariableRef::FAutoConsoleVariableRef ( const TCHAR * Name,
FString & RefValue,
const TCHAR * Help,
const FConsoleVariableDelegate & Callback,
uint32 Flags = ECVF_Default )
inline

Create a reference to a FString 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 1349 of file IConsoleManager.h.

+ Here is the call graph for this function:

◆ ~FAutoConsoleVariableRef()

virtual FAutoConsoleVariableRef::~FAutoConsoleVariableRef ( )
inlinevirtual

Definition at line 1355 of file IConsoleManager.h.

Member Function Documentation

◆ operator*() [1/2]

FORCEINLINE IConsoleVariable & FAutoConsoleVariableRef::operator* ( )
inline

Dereference back to a variable

Definition at line 1359 of file IConsoleManager.h.

+ Here is the call graph for this function:

◆ operator*() [2/2]

FORCEINLINE const IConsoleVariable & FAutoConsoleVariableRef::operator* ( ) const
inline

Definition at line 1363 of file IConsoleManager.h.

+ Here is the call graph for this function:

◆ operator->() [1/2]

FORCEINLINE IConsoleVariable * FAutoConsoleVariableRef::operator-> ( )
inline

Dereference back to a variable

Definition at line 1368 of file IConsoleManager.h.

+ Here is the call graph for this function:

◆ operator->() [2/2]

FORCEINLINE const IConsoleVariable * FAutoConsoleVariableRef::operator-> ( ) const
inline

Definition at line 1372 of file IConsoleManager.h.

+ Here is the call graph for this function:

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