FConsoleManager

Windows
MacOS
Linux

Inheritance Hierarchy

IConsoleManager

FConsoleManager

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/HAL/ConsoleManager.h

Include

#include "HAL/ConsoleManager.h"

Syntax

class FConsoleManager : public IConsoleManager

Constructors

Name Description

Public function

FConsoleManager()

Constructor

Destructors

Name Description

Public function

~FConsoleManager()

Destructor

Functions

Name Description

Public function Const

FString

 

FindConsoleObjectName

(
    const IConsoleObject* Obj
)

Public function

IConsoleThre...

 

GetThreadPropagationCallback()

Internally needed or ECVF_RenderThreadSafe

Public function

bool

 

IsThreadPropagationThread()

Internally needed or ECVF_RenderThreadSafe

Public function

void

 

OnCVarChanged()

Public function

void

 

Test()

Can be moved out into some automated testing system

Overridden from IConsoleManager

Name Description

Public function Virtual

void

 

AddConsoleHistoryEntry

(
    const TCHAR* Key,
    const TCHAR* Input
)

Public function Virtual

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 Virtual Const

IConsoleObje...

 

FindConsoleObject

(
    const TCHAR* Name,
    bool bTrackFrequentCalls
)

Find a console variable or command

Public function Virtual Const

IConsoleVari...

 

FindConsoleVariable

(
    const TCHAR* Name,
    bool bTrackFrequentCalls
)

Find a console variable

Public function Virtual Const

void

 

ForEachConsoleObjectThatContains

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

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

Public function Virtual 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 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

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

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 Virtual

IConsoleComm...

 

RegisterConsoleCommand

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

Register a console command that takes no arguments

Public function Virtual

IConsoleComm...

 

RegisterConsoleCommand

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

Register a console command that takes arguments

Public function Virtual

IConsoleComm...

 

RegisterConsoleCommand

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

Register a console command that takes arguments

Public function Virtual

IConsoleComm...

 

RegisterConsoleCommand

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

Register a console command that takes arguments

Public function Virtual

IConsoleComm...

 

RegisterConsoleCommand

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

Register a console command that takes arguments

Public function Virtual

IConsoleComm...

 

RegisterConsoleCommand

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

Register a console command that takes arguments

Public function Virtual

IConsoleVari...

 

RegisterConsoleVariable

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

Create a string console variable

Public function Virtual

IConsoleVari...

 

RegisterConsoleVariable

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

Create a string console variable

Public function Virtual

IConsoleVari...

 

RegisterConsoleVariable

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

Create a float console variable

Public function Virtual

IConsoleVari...

 

RegisterConsoleVariable

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

Create a int console variable

Public function Virtual

IConsoleVari...

 

RegisterConsoleVariable

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

Create a bool console variable

Public function Virtual

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 Virtual

IConsoleVari...

 

RegisterConsoleVariableRef

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

Create a reference to a int console variable

Public function Virtual

IConsoleVari...

 

RegisterConsoleVariableRef

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

Create a reference to a string console variable

Public function Virtual

IConsoleVari...

 

RegisterConsoleVariableRef

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

Create a reference to a bool console variable

Public function Virtual

IConsoleVari...

 

RegisterConsoleVariableRef

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

Create a reference to a float console variable

Public function Virtual

FConsoleVari...

 

RegisterConsoleVariableSink_Handle

(
    const FConsoleCommandDelegate& Com...
)

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

Public function Virtual

void

 

RegisterThreadPropagation

(
    uint32 ThreadId,
    IConsoleThreadPropagation* InC...
)

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

 

UnregisterConsoleVariableSink_Handle

(
    FConsoleVariableSinkHandle Handle
)

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

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