1. Epic GamesDeveloper
  3. IConsoleVariable

IConsoleVariable

Interface for console variables

Unreal Engine C++ API Reference > Runtime > Core > HAL

Inheritance Hierarchy

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/HAL/IConsoleManager.h
Include #include "HAL/IConsoleManager.h"

Syntax

class IConsoleVariable : public IConsoleObject

Remarks

Interface for console variables

Functions

  Type Name Description
Public function Const bool

GetBool ()

 Get the internal value as a bool, works on bools, ints and floats.
Public function FString Get the value this CVar was constructed with
Public function Virtual IConsoleVariable * Get the saved off default value, in a cvar variable, if one was created
Public function Const float Get the internal value as float (works on all types).
Public function SIZE_T Track memory used by history data
Public function Const int32

GetInt ()

 Get the internal value as int (should not be used on strings).
Public function Const FString Get the internal value as string (works on all types).
Public function void

GetValue ( FString& OutStringValue
)

  
Public function void

GetValue ( float& OutFloatValue
)

  
Public function void

GetValue ( bool& OutBoolValue
)

  
Public function void

GetValue ( int32& OutIntValue
)

 Generic versions for templated code
Public function void Print the history to a log
Public function FConsoleVariableMulticastDelegate &  
Public function void

Set ( const TCHAR* InValue,
EConsoleVariableFlags SetBy,
FName Tag
)

 Set the internal value from the specified string.
Public function void

Set ( bool InValue,
EConsoleVariableFlags SetBy,
FName Tag
)

 Set the internal value from the specified bool.
Public function void

Set ( int32 InValue,
EConsoleVariableFlags SetBy,
FName Tag
)

 Set the internal value from the specified int.
Public function void

Set ( float InValue,
EConsoleVariableFlags SetBy,
FName Tag
)

 Set the internal value from the specified float.
Public function void Allows to specify a callback function that is called when the console variable value changes.
Public function void

SetWithCurrentPriority ( float InValue,
FName Tag
)

  
Public function void

SetWithCurrentPriority ( bool InValue,
FName Tag
)

  
Public function void  
Public function void

SetWithCurrentPriority ( const TCHAR* InValue,
FName Tag
)

  
Public function void Unsets the value at a certain SetBy priority (this is only useful when UE_ALLOW_CVAR_HISTORY is set).

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page