Navigation
API > API/Runtime > API/Runtime/Core
Interface for console variables
| Name | IConsoleVariable |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/HAL/IConsoleManager.h |
| Include Path | #include "HAL/IConsoleManager.h" |
Syntax
class IConsoleVariable : public IConsoleObject
Implements Interfaces
Structs
| Name | Remarks |
|---|---|
| FResolvedContext | |
| FSetContext |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool GetBool() |
Get the internal value as a bool, works on bools, ints and floats. | HAL/IConsoleManager.h | |
FString GetDefaultValue() |
Get the value this CVar was constructed with | HAL/IConsoleManager.h | |
virtual IConsoleVariable * GetDefaultValueVariable() |
Get the saved off default value, in a cvar variable, if one was created | HAL/IConsoleManager.h | |
float GetFloat() |
Get the internal value as float (works on all types). | HAL/IConsoleManager.h | |
SIZE_T GetHistorySize() |
Track memory used by history data | HAL/IConsoleManager.h | |
int32 GetInt() |
Get the internal value as int (should not be used on strings). | HAL/IConsoleManager.h | |
FString GetString() |
Get the internal value as string (works on all types). | HAL/IConsoleManager.h | |
void GetValue
(
bool& OutBoolValue |
HAL/IConsoleManager.h | ||
void GetValue
(
int32& OutIntValue |
Generic versions for templated code | HAL/IConsoleManager.h | |
| HAL/IConsoleManager.h | |||
void GetValue
(
float& OutFloatValue |
HAL/IConsoleManager.h | ||
void LogHistory
(
FOutputDevice& Ar |
Print the history to a log | HAL/IConsoleManager.h | |
FConsoleVariableMulticastDelegate & OnChangedDelegate() |
HAL/IConsoleManager.h | ||
void ReplaceCurrentPriorityAndTag
(
T InValue, |
HAL/IConsoleManager.h | ||
FResolvedContext ResolveContext
(
const FSetContext& Context |
HAL/IConsoleManager.h | ||
void Set
(
int32 InValue, |
Set the internal value from the specified int. | HAL/IConsoleManager.h | |
void Set
(
bool InValue, |
Set the internal value from the specified bool. | HAL/IConsoleManager.h | |
void Set
(
const TCHAR* InValue, |
Set the internal value from the SetContext. | HAL/IConsoleManager.h | |
void Set
(
T Value, |
HAL/IConsoleManager.h | ||
void Set
(
float InValue, |
Set the internal value from the specified float. | HAL/IConsoleManager.h | |
void Set
(
const TCHAR* InValue, |
Set the internal value from the specified string. | HAL/IConsoleManager.h | |
void SetOnChangedCallback
(
const FConsoleVariableDelegate& Callback |
Allows to specify a callback function that is called when the console variable value changes. | HAL/IConsoleManager.h | |
void SetWithCurrentPriority
(
T Value, |
HAL/IConsoleManager.h | ||
void Unset
(
EConsoleVariableFlags SetBy, |
Unsets the value at a certain SetBy priority (this is only useful when UE_ALLOW_CVAR_HISTORY is set). | HAL/IConsoleManager.h |