1. Epic GamesDeveloper
  3. IConsoleManager

IConsoleManager

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

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/HAL

References

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

Syntax

struct IConsoleManager

Remarks

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

Destructors

  Type Name Description
Protected function Virtual    

Functions

  Type Name Description
Public function void

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

  
Public function void The sinks are only called if a change has been done since the last time Should be called in very few points:
Public function Const IConsoleObject *

FindConsoleObject ( const TCHAR* Name,
bool bTrackFrequentCalls
)

 Find a console variable or command
Public function Const FString Lookup the name of a console object by its pointer
Public function Const IConsoleVariable *

FindConsoleVariable ( const TCHAR* Name,
bool bTrackFrequentCalls
)

 Find a console variable
Public function Const TConsoleVariableData< bool > * Find a typed console variable (faster access to the value, no virtual function call)
Public function Const TConsoleVariableData< float > * Find a typed console variable (faster access to the value, no virtual function call)
Public function Const TConsoleVariableData< int32 > * Find a typed console variable (faster access to the value, no virtual function call)
Public function Const void

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

 Not case sensitive, does not guarantee that UnregisterConsoleObject() will work in the loop
Public function Const void

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

 Iterate in O(n), not case sensitive, does not guarantee that UnregisterConsoleObject() will work in the loop
Public function Static IConsoleManager &

Get ()

 Returns the singleton for the console manager
Public function void

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

  
Public function Const bool

IsNameRegistered ( const TCHAR* Name
)

 Check if a name (command or variable) has been registered with the console manager
Public function FConsoleObjectWithNameMulticastDelegate &  
Public function FConsoleVariableMulticastDelegate &  
Public function 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
Public function IConsoleCommand *

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

 Register a console command that is handles by an Exec functions (for auto completion)
Public function IConsoleCommand *

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

 Register a console command that takes no arguments
Public function IConsoleCommand *

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

 Register a console command that takes arguments
Public function IConsoleCommand *

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

 Register a console command that takes arguments
Public function IConsoleCommand *

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

 Register a console command that takes arguments
Public function IConsoleCommand *

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

 Register a console command that takes arguments
Public function IConsoleCommand * Register a console command that takes arguments
Public function IConsoleCommand *

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

 Register a console command that takes arguments
Public function IConsoleVariable *

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

 Create a string console variable
Public function IConsoleVariable *

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

 Create a string console variable
Public function IConsoleVariable *

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

 Create a float console variable
Public function IConsoleVariable *

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

 Create a int console variable
Public function IConsoleVariable *

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

 Create a bool console variable
Public function 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
Public function IConsoleVariable *

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

 Create a reference to a int console variable
Public function IConsoleVariable *

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

 Create a reference to a string console variable
Public function IConsoleVariable *

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

 Create a reference to a bool console variable
Public function IConsoleVariable *

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

 Create a reference to a float console variable
Public function FConsoleVariableSinkHandle The registered command is executed at few defined points (see CallAllConsoleVariableSinks)
Public function void Currently only for render thread
Public function void

UnregisterConsoleObject ( const TCHAR* Name,
bool bKeepState
)

 Unregisters a console variable or command by name, if an object of that name was registered.
Public function void

UnregisterConsoleObject ( IConsoleObject* ConsoleObject,
bool bKeepState
)

 Unregisters a console object, if that object was registered. O(n), n is the console object count
Public function void The registered command is executed at few defined points (see CallAllConsoleVariableSinks)
Public function void When a plugin is unmounted, it needs to unset cvars that it had set when it was mounted.

Constants

Name Description
Singleton Singleton for the console manager

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page