1. Epic GamesDeveloper
  3. FConsoleManager

FConsoleManager

Unreal Engine C++ API Reference > Runtime > Core > HAL

Inheritance Hierarchy

References

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

Syntax

class FConsoleManager : public IConsoleManager

Constructors

  Type Name Description
Public function   Constructor

Destructors

  Type Name Description
Public function   Destructor

Functions

  Type Name Description
Public function IConsoleThreadPropagation * Internally needed or ECVF_RenderThreadSafe
Public function bool Internally needed or ECVF_RenderThreadSafe
Public function void  
Public function void

Test ()

 Can be moved out into some automated testing system

Overridden from IConsoleManager

  Type Name Description
Public function Virtual void

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

  
Public function Virtual 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 Virtual Const IConsoleObject *

FindConsoleObject ( const TCHAR* Name,
bool bTrackFrequentCalls
)

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

FindConsoleVariable ( const TCHAR* Name,
bool bTrackFrequentCalls
)

 Find a console variable
Public function Virtual Const void

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

 Not case sensitive, does not guarantee that UnregisterConsoleObject() will work in the loop
Public function Virtual 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 Virtual void

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

  
Public function Virtual Const bool

IsNameRegistered ( const TCHAR* Name
)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

 Register a console command that takes arguments
Public function Virtual IConsoleVariable *

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

 Create a string console variable
Public function Virtual IConsoleVariable *

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

 Create a string console variable
Public function Virtual IConsoleVariable *

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

 Create a float console variable
Public function Virtual IConsoleVariable *

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

 Create a int console variable
Public function Virtual IConsoleVariable *

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

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

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

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

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

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

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

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

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

 Create a reference to a float console variable
Public function Virtual FConsoleVariableSinkHandle

RegisterConsoleVariableSink_Handle ( const FConsoleCommandDelegate& Command
)

 The registered command is executed at few defined points (see CallAllConsoleVariableSinks)
Public function Virtual void

RegisterThreadPropagation ( uint32 ThreadId,
IConsoleThreadPropagation* InCallback
)

 Currently only for render thread
Public function Virtual 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 Virtual void The registered command is executed at few defined points (see CallAllConsoleVariableSinks)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page