Navigation
API > API/Runtime > API/Runtime/Core
Interface for console objects (variables and commands)
| Name | IConsoleObject |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/HAL/IConsoleManager.h |
| Include Path | #include "HAL/IConsoleManager.h" |
Syntax
class IConsoleObject
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
IConsoleObject() |
HAL/IConsoleManager.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IConsoleObject() |
HAL/IConsoleManager.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| FindCallCount | uint32 | To track down FindConsoleObject/FindConsoleVariable calls without static | HAL/IConsoleManager.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual IConsoleCommand * AsCommand() |
Casts this object to an IConsoleCommand, verifying first that it is safe to do so | HAL/IConsoleManager.h | |
virtual IConsoleVariable * AsVariable() |
Casts this object to an IConsoleVariable, returns 0 if it's not | HAL/IConsoleManager.h | |
virtual TConsoleVariableData< bool > * AsVariableBool() |
HAL/IConsoleManager.h | ||
virtual TConsoleVariableData< float > * AsVariableFloat() |
HAL/IConsoleManager.h | ||
virtual TConsoleVariableData< int32 > * AsVariableInt() |
HAL/IConsoleManager.h | ||
virtual TConsoleVariableData< FString > * AsVariableString() |
HAL/IConsoleManager.h | ||
void ClearFlags
(
const EConsoleVariableFlags Value |
Removes the specified flags in the internal state. | HAL/IConsoleManager.h | |
virtual FText GetDetailedHelp() |
HAL/IConsoleManager.h | ||
EConsoleVariableFlags GetFlags() |
Get the internal state of the flags. | HAL/IConsoleManager.h | |
const TCHAR * GetHelp() |
HAL/IConsoleManager.h | ||
virtual IConsoleObject * GetParentObject() |
If the object has a parent (for instance the main cvar that owns an other-platform cvar), return it | HAL/IConsoleManager.h | |
virtual IConsoleObject * GetShadowedObject () |
If IsShadowObject() returns true, this function will return the "real" variable the shadow cvar is shadowing. | HAL/IConsoleManager.h | |
virtual bool IsDeprecated() |
HAL/IConsoleManager.h | ||
bool IsEnabled() |
Test the validity of the variable wrt its flags and current build type (e.g. ECVF_Cheat variables are disabled on some targets) | HAL/IConsoleManager.h | |
virtual bool IsShadowObject() |
A shadow ConsoleObject is one that exists and can be used, but shouldn't be iterated over in anything that walks over every object and acts on it | HAL/IConsoleManager.h | |
virtual bool IsVariableBool() |
HAL/IConsoleManager.h | ||
virtual bool IsVariableFloat() |
HAL/IConsoleManager.h | ||
virtual bool IsVariableInt() |
HAL/IConsoleManager.h | ||
virtual bool IsVariableString() |
HAL/IConsoleManager.h | ||
void SetFlags
(
const EConsoleVariableFlags Value |
Sets the internal flag state to the specified value. | HAL/IConsoleManager.h | |
void SetHelp
(
const TCHAR* Value |
HAL/IConsoleManager.h | ||
bool TestFlags
(
const EConsoleVariableFlags Value |
Test is any of the specified flags is set in the internal state. | HAL/IConsoleManager.h |