1. Epic GamesDeveloper
  3. IConsoleManager

IConsoleManager

Handles console commands and variables, registered console variables are released on destruction

API > API/Runtime > API/Runtime/Core

Handles console commands and variables, registered console variables are released on destruction

   
Name IConsoleManager
Type struct
Header File /Engine/Source/Runtime/Core/Public/HAL/IConsoleManager.h
Include Path #include "HAL/IConsoleManager.h"

Syntax

struct IConsoleManager

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IConsoleManager()

   HAL/IConsoleManager.h  

Constants

Name Type Remarks Include Path
Singleton IConsoleManager * Singleton for the console manager HAL/IConsoleManager.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddConsoleHistoryEntry ( const TCHAR* Key,
const TCHAR* Input
)

   HAL/IConsoleManager.h  

void BatchUpdateTag ( FName Tag,
const TMap< FName, FString >& CVarsAndValues
)

 Add, replace, or remove cvars to match the passed in cvars HAL/IConsoleManager.h  
The sinks are only called if a change has been done since the last time Should be called in very few points: HAL/IConsoleManager.h  

IConsoleObject * FindConsoleObject ( const TCHAR* Name,
bool bTrackFrequentCalls
) const

 Find a console variable or command HAL/IConsoleManager.h  

FString FindConsoleObjectName ( const IConsoleObject* Obj
) const

 Lookup the name of a console object by its pointer HAL/IConsoleManager.h  

IConsoleVariable * FindConsoleVariable ( const TCHAR* Name,
bool bTrackFrequentCalls
) const

 Find a console variable HAL/IConsoleManager.h  

TConsoleVariableData< bool > * FindTConsoleVariableDataBool ( const TCHAR* Name
) const

 Find a typed console variable (faster access to the value, no virtual function call) HAL/IConsoleManager.h  

TConsoleVariableData< float > * FindTConsoleVariableDataFloat ( const TCHAR* Name
) const

 Find a typed console variable (faster access to the value, no virtual function call) HAL/IConsoleManager.h  

TConsoleVariableData< int32 > * FindTConsoleVariableDataInt ( const TCHAR* Name
) const

 Find a typed console variable (faster access to the value, no virtual function call) HAL/IConsoleManager.h  

void ForEachConsoleObjectThatContains ( const FConsoleObjectVisitor& Visitor,
const TCHAR* ThatContains
) const

 Not case sensitive, does not guarantee that UnregisterConsoleObject() will work in the loop HAL/IConsoleManager.h  

void ForEachConsoleObjectThatStartsWith ( const FConsoleObjectVisitor& Visitor,
const TCHAR* ThatStartsWith
) const

 Iterate in O(n), not case sensitive, does not guarantee that UnregisterConsoleObject() will work in the loop HAL/IConsoleManager.h  

void GetConsoleHistory ( const TCHAR* Key,
TArray< FString >& Out
)

   HAL/IConsoleManager.h  

bool IsNameRegistered ( const TCHAR* Name
) const

 Check if a name (command or variable) has been registered with the console manager HAL/IConsoleManager.h  

FConsoleObjectWithNameMulticastDelegate & OnConsoleObjectUnregistered()

   HAL/IConsoleManager.h  

FConsoleVariableMulticastDelegate & OnCVarUnregistered()

   HAL/IConsoleManager.h  

bool ProcessUserConsoleInput ( const TCHAR* Input,
FOutputDevice& Ar,
UWorld* InWorld
)

 Process user input e.g. "MyCVar" to get the current value of the console variable "MyCVar -5.2" to set the value to -5.2 "MyCVar ?" to get the help text HAL/IConsoleManager.h  

IConsoleCommand * RegisterConsoleCommand ( const TCHAR* Name,
const TCHAR* Help,
uint32 Flags
)

 Register a console command that is handles by an Exec functions (for auto completion) HAL/IConsoleManager.h  

IConsoleCommand * RegisterConsoleCommand ( const TCHAR* Name,
const TCHAR* Help,
const FConsoleCommandDelegate& Command,
uint32 Flags
)

 Register a console command that takes no arguments HAL/IConsoleManager.h  

IConsoleCommand * RegisterConsoleCommand ( const TCHAR* Name,
const TCHAR* Help,
const FConsoleCommandWithArgsDelegate& Command,
uint32 Flags
)

 Register a console command that takes arguments HAL/IConsoleManager.h  

IConsoleCommand * RegisterConsoleCommand ( const TCHAR* Name,
const TCHAR* Help,
const FConsoleCommandWithWorldDelegate& Command,
uint32 Flags
)

 Register a console command that takes arguments HAL/IConsoleManager.h  

IConsoleCommand * RegisterConsoleCommand ( const TCHAR* Name,
const TCHAR* Help,
const FConsoleCommandWithWorldAndArgsDelegate& Command,
uint32 Flags
)

 Register a console command that takes arguments HAL/IConsoleManager.h  

IConsoleCommand * RegisterConsoleCommand ( const TCHAR* Name,
const TCHAR* Help,
const FConsoleCommandWithArgsAndOutputDeviceDelegate& Command,
uint32 Flags
)

 Register a console command that takes arguments HAL/IConsoleManager.h  

IConsoleCommand * RegisterConsoleCommand ( const TCHAR* Name,
const TCHAR* Help,
const FConsoleCommandWithWorldArgsAndOutputDeviceDelegate& Command,
uint32 Flags
)

 Register a console command that takes arguments HAL/IConsoleManager.h  

IConsoleCommand * RegisterConsoleCommand ( const TCHAR* Name,
const TCHAR* Help,
const FConsoleCommandWithOutputDeviceDelegate& Command,
uint32 Flags
)

 Register a console command that takes arguments HAL/IConsoleManager.h  

IConsoleVariable * RegisterConsoleVariable ( const TCHAR* Name,
const FString& DefaultValue,
const TCHAR* Help,
uint32 Flags
)

 Create a string console variable HAL/IConsoleManager.h  

IConsoleVariable * RegisterConsoleVariable ( const TCHAR* Name,
const TCHAR* DefaultValue,
const TCHAR* Help,
uint32 Flags
)

 Create a string console variable HAL/IConsoleManager.h  

IConsoleVariable * RegisterConsoleVariable ( const TCHAR* Name,
float DefaultValue,
const TCHAR* Help,
uint32 Flags
)

 Create a float console variable HAL/IConsoleManager.h  

IConsoleVariable * RegisterConsoleVariable ( const TCHAR* Name,
int32 DefaultValue,
const TCHAR* Help,
uint32 Flags
)

 Create a int console variable HAL/IConsoleManager.h  

IConsoleVariable * RegisterConsoleVariable ( const TCHAR* Name,
bool DefaultValue,
const TCHAR* Help,
uint32 Flags
)

 Create a bool console variable HAL/IConsoleManager.h  

IConsoleVariable * RegisterConsoleVariableBitRef ( const TCHAR* CVarName,
const TCHAR* FlagName,
uint32 BitNumber,
uint8* Force0MaskPtr,
uint8* Force1MaskPtr,
const TCHAR* Help,
uint32 Flags
)

 Create a reference to a show flag variable HAL/IConsoleManager.h  

IConsoleVariable * RegisterConsoleVariableRef ( const TCHAR* Name,
int32& RefValue,
const TCHAR* Help,
uint32 Flags
)

 Create a reference to a int console variable HAL/IConsoleManager.h  

IConsoleVariable * RegisterConsoleVariableRef ( const TCHAR* Name,
FString& RefValue,
const TCHAR* Help,
uint32 Flags
)

 Create a reference to a string console variable HAL/IConsoleManager.h  

IConsoleVariable * RegisterConsoleVariableRef ( const TCHAR* Name,
FName& RefValue,
const TCHAR* Help,
uint32 Flags
)

 Create a reference to a name console variable HAL/IConsoleManager.h  

IConsoleVariable * RegisterConsoleVariableRef ( const TCHAR* Name,
bool& RefValue,
const TCHAR* Help,
uint32 Flags
)

 Create a reference to a bool console variable HAL/IConsoleManager.h  

IConsoleVariable * RegisterConsoleVariableRef ( const TCHAR* Name,
float& RefValue,
const TCHAR* Help,
uint32 Flags
)

 Create a reference to a float console variable HAL/IConsoleManager.h  

FConsoleVariableSinkHandle RegisterConsoleVariableSink_Handle ( const FConsoleCommandDelegate& Command
)

 The registered command is executed at few defined points (see CallAllConsoleVariableSinks) HAL/IConsoleManager.h  

void RegisterThreadPropagation ( uint32 ThreadId,
IConsoleThreadPropagation* InCallback
)

 Currently only for render thread HAL/IConsoleManager.h  

void UnregisterConsoleObject ( IConsoleObject* ConsoleObject,
bool bKeepState
)

 Unregisters a console object, if that object was registered. O(n), n is the console object count HAL/IConsoleManager.h  

void UnregisterConsoleObject ( const TCHAR* Name,
bool bKeepState
)

 Unregisters a console variable or command by name, if an object of that name was registered. HAL/IConsoleManager.h  

void UnregisterConsoleVariableSink_Handle ( FConsoleVariableSinkHandle Handle
)

 The registered command is executed at few defined points (see CallAllConsoleVariableSinks) HAL/IConsoleManager.h  
When a plugin is unmounted, it needs to unset cvars that it had set when it was mounted. HAL/IConsoleManager.h  

Protected

Static

Name Remarks Include Path Unreal Specifiers

static IConsoleManager & Get()

 Returns the singleton for the console manager HAL/IConsoleManager.h  

static void SetupSingleton()

 Function to create the singleton HAL/IConsoleManager.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page