IConsoleManager

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

Windows
MacOS
Linux

Inheritance Hierarchy

IConsoleManager

FConsoleManager

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

Name Description

Protected function Virtual

~IConsoleManager()

Functions

Name Description

Public function

void

 

AddConsoleHistoryEntry

(
    const TCHAR* Key,
    const TCHAR* Input
)

Public function

void

 

CallAllConsoleVariableSinks()

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

IConsoleObje...

 

FindConsoleObject

(
    const TCHAR* Name,
    bool bTrackFrequentCalls
)

Find a console variable or command

Public function Const

IConsoleVari...

 

FindConsoleVariable

(
    const TCHAR* Name,
    bool bTrackFrequentCalls
)

Find a console variable

Public function Const

TConsoleVari...

 

FindTConsoleVariableDataFloat

(
    const TCHAR* Name
)

Find a typed console variable (faster access to the value, no virtual function call)

Public function Const

TConsoleVari...

 

FindTConsoleVariableDataInt

(
    const TCHAR* Name
)

Find a typed console variable (faster access to the value, no virtual function call)

Public function Const

void

 

ForEachConsoleObjectThatContains

(
    const FConsoleObjectVisitor& Visit...,
    const TCHAR* ThatContains
)

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

Public function Const

void

 

ForEachConsoleObjectThatStartsWith

(
    const FConsoleObjectVisitor& Visit...,
    const TCHAR* ThatStartsWith
)

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

Public function Static

IConsoleMana...

 

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

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

IConsoleComm...

 

RegisterConsoleCommand

(
    const TCHAR* Name,
    const TCHAR* Help,
    const FConsoleCommandWithOutputDevi...,
    uint32 Flags
)

Register a console command that takes arguments

Public function

IConsoleComm...

 

RegisterConsoleCommand

(
    const TCHAR* Name,
    const TCHAR* Help,
    const FConsoleCommandWithWorldArgsA...,
    uint32 Flags
)

Register a console command that takes arguments

Public function

IConsoleComm...

 

RegisterConsoleCommand

(
    const TCHAR* Name,
    const TCHAR* Help,
    const FConsoleCommandWithWorldAndAr...,
    uint32 Flags
)

Register a console command that takes arguments

Public function

IConsoleComm...

 

RegisterConsoleCommand

(
    const TCHAR* Name,
    const TCHAR* Help,
    const FConsoleCommandWithWorldDeleg...,
    uint32 Flags
)

Register a console command that takes arguments

Public function

IConsoleComm...

 

RegisterConsoleCommand

(
    const TCHAR* Name,
    const TCHAR* Help,
    const FConsoleCommandWithArgsDelega...,
    uint32 Flags
)

Register a console command that takes arguments

Public function

IConsoleComm...

 

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

IConsoleComm...

 

RegisterConsoleCommand

(
    const TCHAR* Name,
    const TCHAR* Help,
    const FConsoleCommandDelegate& Com...,
    uint32 Flags
)

Register a console command that takes no arguments

Public function

IConsoleVari...

 

RegisterConsoleVariable

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

Create a bool console variable

Public function

IConsoleVari...

 

RegisterConsoleVariable

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

Create a int console variable

Public function

IConsoleVari...

 

RegisterConsoleVariable

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

Create a float console variable

Public function

IConsoleVari...

 

RegisterConsoleVariable

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

Create a string console variable

Public function

IConsoleVari...

 

RegisterConsoleVariable

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

Create a string console variable

Public function

IConsoleVari...

 

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

IConsoleVari...

 

RegisterConsoleVariableRef

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

Create a reference to a bool console variable

Public function

IConsoleVari...

 

RegisterConsoleVariableRef

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

Create a reference to a int console variable

Public function

IConsoleVari...

 

RegisterConsoleVariableRef

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

Create a reference to a float console variable

Public function

IConsoleVari...

 

RegisterConsoleVariableRef

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

Create a reference to a string console variable

Public function

FConsoleVari...

 

RegisterConsoleVariableSink_Handle

(
    const FConsoleCommandDelegate& Com...
)

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

Public function

void

 

RegisterThreadPropagation

(
    uint32 ThreadId,
    IConsoleThreadPropagation* InC...
)

Currently only for render thread

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

 

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

 

UnregisterConsoleVariableSink_Handle

(
    FConsoleVariableSinkHandle Handle
)

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

Constants

Name

Description

Singleton

Singleton for the console manager
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss