Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Engine > UConsole

Light Theme

Dark Theme

UConsole

A basic command line console that accepts most commands.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UConsole

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Engine/Console.h
Include	#include "Engine/Console.h"

Syntax

class UConsole :
public UObject,
public FOutputDevice

Remarks

A basic command line console that accepts most commands.

Variables

	Name	Description
TArray< FAutoCo...	AutoComplete	Current list of matching commands for auto-complete,
int32	AutoCompleteCursor	-1: auto complete cursor is not visible, >=0
int32	AutoCompleteIndex	Currently selected auto complete index
TArray< FAutoCo...	AutoCompleteList	Full list of auto-complete commands and info
FAutoCompleteNo...	AutoCompleteTree
uint32: 1	bAutoCompleteLocked	Is the current auto-complete selection locked
uint32: 1	bCaptureKeyInput	Indicates that InputChar events should be captured to prevent them from being passed on to other interactions.
uint32: 1	bCtrl	True while a control key is pressed.
uint32: 1	bIsRuntimeAutoCompleteUpToDate	Do we need to rebuild auto complete?
uint32: 1	bShift	True while a shift key is pressed.
FName	ConsoleState	NAME_Typing, NAME_Open or NAME_None.
ULocalPlayer &#...	ConsoleTargetPlayer	The player which the next console command should be executed in the context of.
UTexture2D *...	DefaultTexture_Black
UTexture2D *...	DefaultTexture_White
TArray< FString...	HistoryBuffer	Holds the history buffer, order is old to new
FString	LastAutoCompletedCommand	The most recent input that was autocompleted during this open console session.
FString	PrecompletedInputLine	The command the user would get if they autocompleted their current input.
int32	SBHead	Where in the scrollback buffer are we
int32	SBPos
TArray< FString...	Scrollback	Holds the scrollback buffer
FString	TypedStr	The command the user is currently typing.
int32	TypedStrPos

Constructors

	Name	Description
	UConsole ( const FObjectInitializer& ObjectIn... )

Destructors

	Name	Description
	~UConsole()

Functions

	Name	Description
void	AppendInputText ( const FString& Text )	Appends the specified text to the string of typed text
void	AugmentRuntimeAutoCompleteList ( TArray< FAutoCompleteCommand >& Li... )	Virtual function to allow subclasses of UConsole to add additional commands
void	BeginState_Open ( FName PreviousStateName )	Perform actions on transition to the Open state
void	BeginState_Typing ( FName PreviousStateName )	Perform actions on transition to Typing state
void	BuildRuntimeAutoCompleteList ( bool bForce )	Build the list of auto complete console commands
void	ClearOutput()	Clears the console output buffer.
bool	ConsoleActive()
void	ConsoleCommand ( const FString& Command )	Executes a console command.
void	EndState_Open ( FName NextStateName )	Perform actions on transition from Open state
void	EndState_Typing ( FName NextStateName )	Perform actions on transition from Typing state
void	FakeGotoState ( FName NextStateName )	Controls state transitions for the console
void	FlushPlayerInput()	Clears out all pressed keys from the player's input object.
bool	InputAxis ( int32 ControllerId, FKey Key, float Delta, float DeltaTime, int32 NumSamples, bool bGamepad )
bool	InputChar ( int32 ControllerId, const FString& Unicode )
bool	InputChar_Open ( int32 ControllerId, const FString& Unicode )	This state is used when the console is open.
bool	InputChar_Typing ( int32 ControllerId, const FString& Unicode )	Process a character input event (typing) routed through unrealscript from another object.
bool	InputKey ( int32 ControllerId, FKey Key, EInputEvent Event, float AmountDepressed, bool bGamepad )
bool	InputKey_Open ( int32 ControllerId, FKey Key, EInputEvent Event, float AmountDepressed, bool bGamepad )	Process an input key event routed through unrealscript from another object.
bool	InputTouch ( int32 ControllerId, uint32 Handle, ETouchType::Type Type, const FVector2D& TouchLocation, float Force, FDateTime DeviceTimestamp, uint32 TouchpadIndex )
void	OutputText ( const FString& Text )	Prints a (potentially multi-line) FString of text to the console.
void	PostRender_Console ( UCanvas* Canvas )	Render to the canvas based on the console state
void	PostRender_Console_Open ( UCanvas* Canvas )	Perform rendering of the console on the canvas
void	PostRender_Console_Typing ( UCanvas* Canvas )	Perform rendering of the console on the canvas
bool	ProcessControlKey ( FKey Key, EInputEvent Event )	Looks for Control key presses and the copy/paste combination that apply to both the console bar and the full open console
bool	ProcessShiftKey ( FKey Key, EInputEvent Event )	Looks for Shift key presses
void	SetCursorPos ( int32 Position )	Set cursor position for typing text
void	SetInputText ( const FString& Text )	Set the input to text
void	StartTyping ( const FString& Text )	Opens the typing bar with text already entered.
void	UpdateCompleteIndices()	Update the auto complete indices from the typed string

Overridden from UObject

		Name	Description
	void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Typedefs

Name	Description
FOnConsoleActivationStateChanged	Deletate for when the console is activated or deactivated
FRegisterConsoleAutoCompleteEntries	Delegate for registering hot-reloaded classes that have been added

Constants

Name	Description
MAX_HISTORY_ENTRIES	Max number of command history entries
OnConsoleActivationStateChanged
RegisterConsoleAutoCompleteEntries

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

Take our survey

Dismiss