Navigation
API > API/Runtime > API/Runtime/Core > API/Runtime/Core/HAL
Inheritance Hierarchy
- IConsoleObject
- IConsoleCommand
- IConsoleVariable
References
| Module | Core |
| Header | /Engine/Source/Runtime/Core/Public/HAL/IConsoleManager.h |
| Include | #include "HAL/IConsoleManager.h" |
Syntax
class IConsoleObject
Remarks
Interface for console objects (variables and commands)
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
IConsoleCommand * | AsCommand () |
Casts this object to an IConsoleCommand, verifying first that it is safe to do so |
  |
IConsoleVariable * | AsVariable () |
Casts this object to an IConsoleVariable, returns 0 if it's not |
  |
TConsoleVariableData< bool > * | ||
  |
TConsoleVariableData< float > * | ||
  |
TConsoleVariableData< int32 > * | ||
  |
TConsoleVariableData< FString > * | ||
 |
void | ClearFlags
(
const EConsoleVariableFlags Value |
Removes the specified flags in the internal state. |
   |
FText | ||
  |
EConsoleVariableFlags | GetFlags () |
Get the internal state of the flags. |
  |
const TCHAR * | GetHelp () |
|
   |
IConsoleObject * | If the object has a parent (for instance the main cvar that owns an other-platform cvar), return it | |
  |
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) |
   |
bool | 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 | |
   |
bool | ||
   |
bool | ||
   |
bool | ||
   |
bool | ||
 |
void | SetFlags
(
const EConsoleVariableFlags Value |
Sets the internal flag state to the specified value. |
 |
void | ||
  |
bool | TestFlags
(
const EConsoleVariableFlags Value |
Test is any of the specified flags is set in the internal state. |