Inheritance diagram for ezConsole:

Public Member Functions
Console Display
virtual void	AddConsoleString (ezStringView sText, ezConsoleString::Type type=ezConsoleString::Type::Default)
	Adds a string to the console.

Events
ezEvent< const ezConsoleEvent & >	m_Events
	The console event variable, to attach to.

const ezEvent< const ezConsoleEvent & > &	Events () const
	Grants access to subscribe and unsubscribe from console events.

Helpers
ezMutex	m_Mutex

ezMutex &	GetMutex () const
	Returns the mutex that's used to prevent multi-threaded access.

static void	SetMainConsole (ezConsole *pConsole)

static ezConsole *	GetMainConsole ()

Command Interpreter
ezSharedPtr< ezCommandInterpreter >	m_pCommandInterpreter

void	SetCommandInterpreter (const ezSharedPtr< ezCommandInterpreter > &pInterpreter)
	Replaces the current command interpreter.

const ezSharedPtr< ezCommandInterpreter > &	GetCommandInterpreter () const
	Returns the currently used command interpreter.

virtual bool	AutoComplete (ezStringBuilder &ref_sText)
	Auto-completes the given text.

virtual void	ExecuteCommand (ezStringView sInput)
	Executes the given input string.

Input History
ezInt32	m_iCurrentInputHistoryElement = -1

ezStaticArray< ezString, 16 >	m_InputHistory

void	AddToInputHistory (ezStringView sText)
	Adds an item to the input history.

const ezStaticArray< ezString, 16 > &	GetInputHistory () const
	Returns the current input history.

void	RetrieveInputHistory (ezInt32 iHistoryUp, ezStringBuilder &ref_sResult)
	Replaces the input line by the next (or previous) history item.

ezResult	SaveInputHistory (ezStringView sFile)
	Writes the current input history to a text file.

void	LoadInputHistory (ezStringView sFile)
	Reads the text file and appends all lines to the input history.

Member Function Documentation

◆ AddConsoleString()

void ezConsole::AddConsoleString	(	ezStringView	sText,
		ezConsoleString::Type	type = `ezConsoleString::Type::Default`
	)

virtual

Adds a string to the console.

The base class only broadcasts an event, but does not store the string anywhere.

Reimplemented in ezQuakeConsole.

bool ezConsole::AutoComplete ( ezStringBuilder & ref_sText )

virtual

Auto-completes the given text.

Returns true, if the string was modified in any way. Adds additional strings to the console output, if there are further auto-completion suggestions.

void ezConsole::ExecuteCommand ( ezStringView sInput )

virtual

Executes the given input string.

The command is forwarded to the set command interpreter.

Reimplemented in ezQuakeConsole.

const ezStaticArray< ezString, 16 > & ezConsole::GetInputHistory ( ) const

inline

Returns the current input history.

Make sure to lock the console's mutex while working with the history.

void ezConsole::SetCommandInterpreter ( const ezSharedPtr< ezCommandInterpreter > & pInterpreter )

inline

Replaces the current command interpreter.

This base class doesn't set any default interpreter, but derived classes may do so.

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

/home/runner/work/ezEngine/ezEngine/Code/Engine/Core/Console/Console.h
/home/runner/work/ezEngine/ezEngine/Code/Engine/Core/Console/Implementation/Console.cpp