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

#include <IConsoleManager.h>

Public Member Functions

 TGuardConsoleVariable (const TCHAR *ConsoleVariableName, const T &NewValue)
 
 TGuardConsoleVariable (IConsoleVariable *ConsoleVariable, const T &NewValue)
 
 TGuardConsoleVariable (const TGuardConsoleVariable &)=delete
 
 TGuardConsoleVariable (TGuardConsoleVariable &&Right)
 
TGuardConsoleVariableoperator= (const TGuardConsoleVariable &)=delete
 
TGuardConsoleVariableoperator= (TGuardConsoleVariable &&)=delete
 
 ~TGuardConsoleVariable ()
 

Public Attributes

PreviousValue
 
IConsoleVariableConsoleVariable
 

Detailed Description

template<typename T>
struct TGuardConsoleVariable< T >

Utility class to modify a console variable's value for a certain scope and restore it to its previous value afterwards. Type parameter may be any supported by IConsoleVariable::GetValue, i.e. bool, int32, float, FString.

Constructor & Destructor Documentation

◆ TGuardConsoleVariable() [1/4]

template<typename T >
TGuardConsoleVariable< T >::TGuardConsoleVariable ( const TCHAR ConsoleVariableName,
const T &  NewValue 
)
inline

◆ TGuardConsoleVariable() [2/4]

template<typename T >
TGuardConsoleVariable< T >::TGuardConsoleVariable ( IConsoleVariable ConsoleVariable,
const T &  NewValue 
)
inline

◆ TGuardConsoleVariable() [3/4]

◆ TGuardConsoleVariable() [4/4]

◆ ~TGuardConsoleVariable()

template<typename T >
TGuardConsoleVariable< T >::~TGuardConsoleVariable ( )
inline

Member Function Documentation

◆ operator=() [1/2]

template<typename T >
TGuardConsoleVariable & TGuardConsoleVariable< T >::operator= ( const TGuardConsoleVariable< T > &  )
delete

◆ operator=() [2/2]

template<typename T >
TGuardConsoleVariable & TGuardConsoleVariable< T >::operator= ( TGuardConsoleVariable< T > &&  )
delete

Member Data Documentation

◆ ConsoleVariable

template<typename T >
IConsoleVariable* TGuardConsoleVariable< T >::ConsoleVariable

◆ PreviousValue

template<typename T >
T TGuardConsoleVariable< T >::PreviousValue

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