FConsoleManager Class Reference

#include <ConsoleManager.h>

Inheritance diagram for FConsoleManager:

Public Member Functions
	FConsoleManager ()
	~FConsoleManager ()
virtual IConsoleVariable *	RegisterConsoleVariable (const TCHAR *Name, bool DefaultValue, const TCHAR *Help, uint32 Flags) override
virtual IConsoleVariable *	RegisterConsoleVariable (const TCHAR *Name, int32 DefaultValue, const TCHAR *Help, uint32 Flags) override
virtual IConsoleVariable *	RegisterConsoleVariable (const TCHAR *Name, float DefaultValue, const TCHAR *Help, uint32 Flags) override
virtual IConsoleVariable *	RegisterConsoleVariable (const TCHAR *Name, const TCHAR *DefaultValue, const TCHAR *Help, uint32 Flags) override
virtual IConsoleVariable *	RegisterConsoleVariable (const TCHAR *Name, const FString &DefaultValue, const TCHAR *Help, uint32 Flags) override
virtual IConsoleVariable *	RegisterConsoleVariableRef (const TCHAR *Name, bool &RefValue, const TCHAR *Help, uint32 Flags) override
virtual IConsoleVariable *	RegisterConsoleVariableRef (const TCHAR *Name, int32 &RefValue, const TCHAR *Help, uint32 Flags) override
virtual IConsoleVariable *	RegisterConsoleVariableRef (const TCHAR *Name, float &RefValue, const TCHAR *Help, uint32 Flags) override
virtual IConsoleVariable *	RegisterConsoleVariableRef (const TCHAR *Name, FString &RefValue, const TCHAR *Help, uint32 Flags) override
virtual IConsoleVariable *	RegisterConsoleVariableRef (const TCHAR *Name, FName &RefValue, const TCHAR *Help, uint32 Flags) override
virtual IConsoleVariable *	RegisterConsoleVariableBitRef (const TCHAR *CVarName, const TCHAR *FlagName, uint32 BitNumber, uint8 *Force0MaskPtr, uint8 *Force1MaskPtr, const TCHAR *Help, uint32 Flags) override
virtual IConsoleCommand *	RegisterConsoleCommand (const TCHAR *Name, const TCHAR *Help, const FConsoleCommandDelegate &Command, uint32 Flags) override
virtual IConsoleCommand *	RegisterConsoleCommand (const TCHAR *Name, const TCHAR *Help, const FConsoleCommandWithArgsDelegate &Command, uint32 Flags) override
virtual IConsoleCommand *	RegisterConsoleCommand (const TCHAR *Name, const TCHAR *Help, const FConsoleCommandWithWorldDelegate &Command, uint32 Flags) override
virtual IConsoleCommand *	RegisterConsoleCommand (const TCHAR *Name, const TCHAR *Help, const FConsoleCommandWithWorldAndArgsDelegate &Command, uint32 Flags) override
virtual IConsoleCommand *	RegisterConsoleCommand (const TCHAR *Name, const TCHAR *Help, const FConsoleCommandWithArgsAndOutputDeviceDelegate &Command, uint32 Flags) override
virtual IConsoleCommand *	RegisterConsoleCommand (const TCHAR *Name, const TCHAR *Help, const FConsoleCommandWithWorldArgsAndOutputDeviceDelegate &Command, uint32 Flags) override
virtual IConsoleCommand *	RegisterConsoleCommand (const TCHAR *Name, const TCHAR *Help, const FConsoleCommandWithOutputDeviceDelegate &Command, uint32 Flags) override
virtual IConsoleCommand *	RegisterConsoleCommand (const TCHAR *Name, const TCHAR *Help, uint32 Flags) override
virtual FConsoleVariableMulticastDelegate &	OnCVarUnregistered () override
virtual FConsoleObjectWithNameMulticastDelegate &	OnConsoleObjectUnregistered () override
virtual FString	FindConsoleObjectName (const IConsoleObject *Obj) const override
virtual IConsoleObject *	FindConsoleObject (const TCHAR *Name, bool bTrackFrequentCalls=true) const override
virtual IConsoleVariable *	FindConsoleVariable (const TCHAR *Name, bool bTrackFrequentCalls=true) const override
virtual FConsoleVariableSinkHandle	RegisterConsoleVariableSink_Handle (const FConsoleCommandDelegate &Command) override
virtual void	UnregisterConsoleVariableSink_Handle (FConsoleVariableSinkHandle Handle) override
virtual void	CallAllConsoleVariableSinks () override
virtual void	ForEachConsoleObjectThatStartsWith (const FConsoleObjectVisitor &Visitor, const TCHAR *ThatStartsWith) const override
virtual void	ForEachConsoleObjectThatContains (const FConsoleObjectVisitor &Visitor, const TCHAR *ThatContains) const override
virtual bool	ProcessUserConsoleInput (const TCHAR *InInput, FOutputDevice &Ar, UWorld *InWorld) override
virtual void	AddConsoleHistoryEntry (const TCHAR *Key, const TCHAR *Input) override
virtual void	GetConsoleHistory (const TCHAR *Key, TArray< FString > &Out) override
virtual bool	IsNameRegistered (const TCHAR *Name) const override
virtual void	RegisterThreadPropagation (uint32 ThreadId, IConsoleThreadPropagation *InCallback) override
virtual void	UnregisterConsoleObject (IConsoleObject *Object, bool bKeepState) override
virtual void	UnsetAllConsoleVariablesWithTag (FName Tag, EConsoleVariableFlags Priority) override
virtual void	BatchUpdateTag (FName Tag, const TMap< FName, FString > &CVarsAndValues) override
IConsoleObject *	AddConsoleObject (const TCHAR *Name, IConsoleObject *Obj)
void	AddShadowConsoleObject (const TCHAR *Name, IConsoleObject *Obj)
IConsoleThreadPropagation *	GetThreadPropagationCallback ()
bool	IsThreadPropagationThread ()
void	OnCVarChanged ()
void	DumpObjects (const TCHAR *Params, FOutputDevice &InAr, bool bDisplayCommands) const
Public Member Functions inherited from IConsoleManager
TConsoleVariableData< bool > *	FindTConsoleVariableDataBool (const TCHAR *Name) const
TConsoleVariableData< int32 > *	FindTConsoleVariableDataInt (const TCHAR *Name) const
TConsoleVariableData< float > *	FindTConsoleVariableDataFloat (const TCHAR *Name) const

Additional Inherited Members
Static Public Member Functions inherited from IConsoleManager
static IConsoleManager &	Get ()
Protected Member Functions inherited from IConsoleManager
virtual	~IConsoleManager ()

Constructor & Destructor Documentation

FConsoleManager()

FConsoleManager::FConsoleManager

(

)

~FConsoleManager()

FConsoleManager::~FConsoleManager

(

)

Member Function Documentation

AddConsoleHistoryEntry()

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

overridevirtual

Parameters

Input

- must not be 0

Implements IConsoleManager.

AddConsoleObject()

IConsoleObject * FConsoleManager::AddConsoleObject	(	const TCHAR *	Name,
		IConsoleObject *	Obj
	)

Parameters

Name	must not be 0, must not be empty
Obj	must not be 0

Returns

0 if the name was already in use

AddShadowConsoleObject()

void FConsoleManager::AddShadowConsoleObject	(	const TCHAR *	Name,
		IConsoleObject *	Obj
	)

Similar to AddConsoleObject, but it just adds it without any flag checking or preexisting var checking

BatchUpdateTag()

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

overridevirtual

Add, replace, or remove cvars to match the passed in cvars

Implements IConsoleManager.

CallAllConsoleVariableSinks()

void FConsoleManager::CallAllConsoleVariableSinks ( )

overridevirtual

The sinks are only called if a change has been done since the last time Should be called in very few points:

• after ini file loading
• after user console input
• user initiated a console variable change (it needs to be clear to user that a cvar can change e.g. game options menu)
• beginning of Tick (to catch stray Set() calls, which are usually bad)

Implements IConsoleManager.

DumpObjects()

void FConsoleManager::DumpObjects	(	const TCHAR *	Params,
		FOutputDevice &	InAr,
		bool	bDisplayCommands
	)		const

FindConsoleObject()

IConsoleObject * FConsoleManager::FindConsoleObject ( const TCHAR *  Name, bool  bTrackFrequentCalls = true  ) const

overridevirtual

Find a console variable or command

Parameters

Name	must not be 0

Returns

0 if the object wasn't found

Implements IConsoleManager.

FindConsoleObjectName()

FString FConsoleManager::FindConsoleObjectName ( const IConsoleObject *  Obj ) const

overridevirtual

Lookup the name of a console object by its pointer

Parameters

Object

to lookup. Must not be null.

Returns

Name of the object, or an empty string if the object can't be found

Implements IConsoleManager.

FindConsoleVariable()

IConsoleVariable * FConsoleManager::FindConsoleVariable ( const TCHAR *  Name, bool  bTrackFrequentCalls = true  ) const

overridevirtual

Find a console variable

Parameters

Name	must not be 0

Returns

0 if the object wasn't found

Implements IConsoleManager.

ForEachConsoleObjectThatContains()

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

overridevirtual

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

Parameters

Visitor	must not be 0
ThatContains	must not be 0

Implements IConsoleManager.

ForEachConsoleObjectThatStartsWith()

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

overridevirtual

Iterate in O(n), not case sensitive, does not guarantee that UnregisterConsoleObject() will work in the loop

Parameters

Visitor	must not be 0
ThatStartsWith	must not be 0

Implements IConsoleManager.

GetConsoleHistory()

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

overridevirtual

Implements IConsoleManager.

GetThreadPropagationCallback()

IConsoleThreadPropagation * FConsoleManager::GetThreadPropagationCallback

(

)

Internally needed for ECVF_RenderThreadSafe

IsNameRegistered()

bool FConsoleManager::IsNameRegistered ( const TCHAR *  Name ) const

overridevirtual

Check if a name (command or variable) has been registered with the console manager

Parameters

Name	- Name to check. Must not be 0

Implements IConsoleManager.

IsThreadPropagationThread()

bool FConsoleManager::IsThreadPropagationThread

(

)

Internally needed for ECVF_RenderThreadSafe

OnConsoleObjectUnregistered()

FConsoleObjectWithNameMulticastDelegate & FConsoleManager::OnConsoleObjectUnregistered ( )

overridevirtual

Implements IConsoleManager.

OnCVarChanged()

void FConsoleManager::OnCVarChanged

(

)

OnCVarUnregistered()

FConsoleVariableMulticastDelegate & FConsoleManager::OnCVarUnregistered ( )

overridevirtual

Implements IConsoleManager.

ProcessUserConsoleInput()

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

overridevirtual

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

Parameters

Input	must not be 0
Ar	archive
InWorld	world context

Returns

true if the command was recognized

Implements IConsoleManager.

RegisterConsoleCommand() [1/8]

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

overridevirtual

Register a console command that takes no arguments

Parameters

Name	The name of this command (must not be nullptr)
Help	Help text for this command
Command	The user function to call when this command is executed
Flags	Optional flags bitmask

Implements IConsoleManager.

RegisterConsoleCommand() [2/8]

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

overridevirtual

Register a console command that takes arguments

Parameters

Name	The name of this command (must not be nullptr)
Help	Help text for this command
Command	The user function to call when this command is executed
Flags	Optional flags bitmask

Implements IConsoleManager.

RegisterConsoleCommand() [3/8]

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

overridevirtual

Register a console command that takes arguments

Parameters

Name	The name of this command (must not be nullptr)
Help	Help text for this command
Command	The user function to call when this command is executed
Flags	Optional flags bitmask

Implements IConsoleManager.

RegisterConsoleCommand() [4/8]

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

overridevirtual

Register a console command that takes arguments

Parameters

Name	The name of this command (must not be nullptr)
Help	Help text for this command
Command	The user function to call when this command is executed
Flags	Optional flags bitmask

Implements IConsoleManager.

RegisterConsoleCommand() [5/8]

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

overridevirtual

Register a console command that takes arguments

Parameters

Name	The name of this command (must not be nullptr)
Help	Help text for this command
Command	The user function to call when this command is executed
Flags	Optional flags bitmask

Implements IConsoleManager.

RegisterConsoleCommand() [6/8]

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

overridevirtual

Register a console command that takes arguments

Parameters

Name	The name of this command (must not be nullptr)
Help	Help text for this command
Command	The user function to call when this command is executed
Flags	Optional flags bitmask

Implements IConsoleManager.

RegisterConsoleCommand() [7/8]

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

overridevirtual

Register a console command that takes arguments

Parameters

Name	The name of this command (must not be nullptr)
Help	Help text for this command
Command	The user function to call when this command is executed
Flags	Optional flags bitmask

Implements IConsoleManager.

RegisterConsoleCommand() [8/8]

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

overridevirtual

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

Parameters

Name	The name of this command (must not be nullptr)
Help	Help text for this command
Flags	Optional flags bitmask

Implements IConsoleManager.

RegisterConsoleVariable() [1/5]

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

overridevirtual

Create a bool console variable

Parameters

Name	must not be 0
Help	must not be 0
Flags	bitmask combined from EConsoleVariableFlags

Implements IConsoleManager.

RegisterConsoleVariable() [2/5]

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

overridevirtual

Create a string console variable

Parameters

Name	must not be 0
Help	must not be 0
Flags	bitmask combined from EConsoleVariableFlags

Implements IConsoleManager.

RegisterConsoleVariable() [3/5]

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

overridevirtual

Create a string console variable

Parameters

Name	must not be 0
Help	must not be 0
Flags	bitmask combined from EConsoleVariableFlags

Implements IConsoleManager.

RegisterConsoleVariable() [4/5]

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

overridevirtual

Create a float console variable

Parameters

Name	must not be 0
Help	must not be 0
Flags	bitmask combined from EConsoleVariableFlags

Implements IConsoleManager.

RegisterConsoleVariable() [5/5]

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

overridevirtual

Create a int console variable

Parameters

Name	must not be 0
Help	must not be 0
Flags	bitmask combined from EConsoleVariableFlags

Implements IConsoleManager.

RegisterConsoleVariableBitRef()

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

overridevirtual

Create a reference to a show flag variable

Parameters

CVarName	must not be 0, e.g. "Show.PostProcessing"
FlagName	must not be 0, e.g. "PostProcessing"
BitNumber	in the memory defined by Force0MaskPtr and Force1MaskPtr
Force0MaskPtr	memory that contains the bits that should be forced to 0
Force1MaskPtr	memory that contains the bits that should be forced to 1
Help	must not be 0
Flags	bitmask combined from EConsoleVariableFlags

Implements IConsoleManager.

RegisterConsoleVariableRef() [1/5]

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

overridevirtual

Create a reference to a bool console variable

Parameters

Name	must not be 0
Help	must not be 0
Flags	bitmask combined from EConsoleVariableFlags

Implements IConsoleManager.

RegisterConsoleVariableRef() [2/5]

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

overridevirtual

Create a reference to a float console variable

Parameters

Name	must not be 0
Help	must not be 0
Flags	bitmask combined from EConsoleVariableFlags

Implements IConsoleManager.

RegisterConsoleVariableRef() [3/5]

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

overridevirtual

Create a reference to a name console variable

Parameters

Name	must not be 0
Help	must not be 0
Flags	bitmask combined from EConsoleVariableFlags

Implements IConsoleManager.

RegisterConsoleVariableRef() [4/5]

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

overridevirtual

Create a reference to a string console variable

Parameters

Name	must not be 0
Help	must not be 0
Flags	bitmask combined from EConsoleVariableFlags

Implements IConsoleManager.

RegisterConsoleVariableRef() [5/5]

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

overridevirtual

Create a reference to a int console variable

Parameters

Name	must not be 0
Help	must not be 0
Flags	bitmask combined from EConsoleVariableFlags

Implements IConsoleManager.

RegisterConsoleVariableSink_Handle()

FConsoleVariableSinkHandle FConsoleManager::RegisterConsoleVariableSink_Handle ( const FConsoleCommandDelegate &  Command )

overridevirtual

The registered command is executed at few defined points (see CallAllConsoleVariableSinks)

Parameters

Command

Implements IConsoleManager.

RegisterThreadPropagation()

void FConsoleManager::RegisterThreadPropagation ( uint32  ThreadId, IConsoleThreadPropagation *  InCallback  )

overridevirtual

Implements IConsoleManager.

UnregisterConsoleObject()

void FConsoleManager::UnregisterConsoleObject ( IConsoleObject *  ConsoleObject, bool  bKeepState  )

overridevirtual

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

Parameters

ConsoleObject	- object to remove
bKeepState	if the current state is kept in memory until a cvar with the same name is registered

Implements IConsoleManager.

UnregisterConsoleVariableSink_Handle()

void FConsoleManager::UnregisterConsoleVariableSink_Handle ( FConsoleVariableSinkHandle  Handle )

overridevirtual

The registered command is executed at few defined points (see CallAllConsoleVariableSinks)

Parameters

Command

Implements IConsoleManager.

UnsetAllConsoleVariablesWithTag()

void FConsoleManager::UnsetAllConsoleVariablesWithTag ( FName  Tag, EConsoleVariableFlags  Priority  )

overridevirtual

When a plugin is unmounted, it needs to unset cvars that it had set when it was mounted. This will unset and fixup all variables with the given Tag

Parameters

Priority

If set, then the internal search for CVars is restricted to this SetBy. This is an optimization, only to be used if you know that all CVars set with this tag were set at this priority. Any other priorites cannot be unset

Implements IConsoleManager.

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Core/Private/HAL/ConsoleManager.h
• Engine/Source/Runtime/Core/Private/HAL/ConsoleManager.cpp