#include <console.h>

Inheritance diagram for CGameConsole:

Collaboration diagram for CGameConsole:

Classes
class	CInstance

Public Types
enum	{ CONSOLETYPE_LOCAL = 0 , CONSOLETYPE_REMOTE , NUM_CONSOLETYPES }

Public Member Functions
	CGameConsole ()
	~CGameConsole () override
int	Sizeof () const override
void	PrintLine (int Type, const char *pLine)
void	RequireUsername (bool UsernameReq)
void	OnStateChange (int NewState, int OldState) override
void	OnConsoleInit () override
void	OnInit () override
void	OnReset () override
void	OnRender () override
void	OnMessage (int MsgType, void *pRawMsg) override
bool	OnInput (const IInput::CEvent &Event) override
void	Prompt (char(&aPrompt)[32])
void	Toggle (int Type)
bool	IsActive () const
void	ForceUpdateRemoteCompletionSuggestions ()
Public Member Functions inherited from CComponent
virtual void	OnShutdown ()
virtual void	OnWindowResize ()
virtual void	OnUpdate ()
virtual void	OnNewSnapshot ()
virtual void	OnRelease ()
virtual void	OnMapLoad ()
virtual bool	OnCursorMove (float x, float y, IInput::ECursorType CursorType)
virtual bool	OnTouchState (std::vector< IInput::CTouchFingerState > &vTouchFingerStates)
Public Member Functions inherited from CComponentInterfaces
virtual void	OnInterfacesInit (CGameClient *pClient)
virtual	~CComponentInterfaces ()=default

Private Member Functions
CInstance *	ConsoleForType (int ConsoleType)
CInstance *	CurrentConsole ()
int	PossibleMaps (const char pStr, IConsole::FPossibleCallback pfnCallback=IConsole::EmptyPossibleCommandCallback, void pUser=nullptr)

Static Private Member Functions
static void	PossibleCommandsRenderCallback (int Index, const char pStr, void pUser)
static void	ConToggleLocalConsole (IConsole::IResult pResult, void pUserData)
static void	ConToggleRemoteConsole (IConsole::IResult pResult, void pUserData)
static void	ConClearLocalConsole (IConsole::IResult pResult, void pUserData)
static void	ConClearRemoteConsole (IConsole::IResult pResult, void pUserData)
static void	ConDumpLocalConsole (IConsole::IResult pResult, void pUserData)
static void	ConDumpRemoteConsole (IConsole::IResult pResult, void pUserData)
static void	ConConsolePageUp (IConsole::IResult pResult, void pUserData)
static void	ConConsolePageDown (IConsole::IResult pResult, void pUserData)
static void	ConConsolePageTop (IConsole::IResult pResult, void pUserData)
static void	ConConsolePageBottom (IConsole::IResult pResult, void pUserData)
static void	ConchainConsoleOutputLevel (IConsole::IResult pResult, void pUserData, IConsole::FCommandCallback pfnCallback, void *pCallbackUserData)

Private Attributes
class IConsole *	m_pConsole
CConsoleLogger *	m_pConsoleLogger = nullptr
CInstance	m_LocalConsole
CInstance	m_RemoteConsole
int	m_ConsoleType
int	m_ConsoleState
float	m_StateChangeEnd
float	m_StateChangeDuration
bool	m_WantsSelectionCopy = false
CUi::CTouchState	m_TouchState

Static Private Attributes
static constexpr ColorRGBA	ms_SearchHighlightColor = ColorRGBA(1.0f, 0.0f, 0.0f, 1.0f)
static constexpr ColorRGBA	ms_SearchSelectedColor = ColorRGBA(1.0f, 1.0f, 0.0f, 1.0f)

Friends
class	CConsoleLogger

Additional Inherited Members
Protected Member Functions inherited from CComponentInterfaces
class CGameClient *	GameClient () const
class IClient *	Client () const
class IKernel *	Kernel () const
class IEngine *	Engine () const
class IGraphics *	Graphics () const
class ITextRender *	TextRender () const
class IInput *	Input () const
class IStorage *	Storage () const
class CUi *	Ui () const
class ISound *	Sound () const
class CRenderTools *	RenderTools () const
class CRenderMap *	RenderMap () const
class IConfigManager *	ConfigManager () const
class CConfig *	Config () const
class IConsole *	Console () const
class IDemoPlayer *	DemoPlayer () const
class IDemoRecorder *	DemoRecorder (int Recorder) const
class IFavorites *	Favorites () const
class IServerBrowser *	ServerBrowser () const
class CLayers *	Layers () const
class CCollision *	Collision () const
int64_t	time () const
float	LocalTime () const
class IHttp *	Http () const

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
CONSOLETYPE_LOCAL
CONSOLETYPE_REMOTE
NUM_CONSOLETYPES

Constructor & Destructor Documentation

◆ CGameConsole()

CGameConsole::CGameConsole ( )

◆ ~CGameConsole()

CGameConsole::~CGameConsole ( )

override

Member Function Documentation

◆ ConchainConsoleOutputLevel()

void CGameConsole::ConchainConsoleOutputLevel	(	IConsole::IResult *	pResult,
		void *	pUserData,
		IConsole::FCommandCallback	pfnCallback,
		void *	pCallbackUserData )

staticprivate

◆ ConClearLocalConsole()

void CGameConsole::ConClearLocalConsole	(	IConsole::IResult *	pResult,
		void *	pUserData )

staticprivate

◆ ConClearRemoteConsole()

void CGameConsole::ConClearRemoteConsole	(	IConsole::IResult *	pResult,
		void *	pUserData )

staticprivate

◆ ConConsolePageBottom()

void CGameConsole::ConConsolePageBottom	(	IConsole::IResult *	pResult,
		void *	pUserData )

staticprivate

◆ ConConsolePageDown()

void CGameConsole::ConConsolePageDown	(	IConsole::IResult *	pResult,
		void *	pUserData )

staticprivate

◆ ConConsolePageTop()

void CGameConsole::ConConsolePageTop	(	IConsole::IResult *	pResult,
		void *	pUserData )

staticprivate

◆ ConConsolePageUp()

void CGameConsole::ConConsolePageUp	(	IConsole::IResult *	pResult,
		void *	pUserData )

staticprivate

◆ ConDumpLocalConsole()

void CGameConsole::ConDumpLocalConsole	(	IConsole::IResult *	pResult,
		void *	pUserData )

staticprivate

◆ ConDumpRemoteConsole()

void CGameConsole::ConDumpRemoteConsole	(	IConsole::IResult *	pResult,
		void *	pUserData )

staticprivate

◆ ConsoleForType()

CGameConsole::CInstance * CGameConsole::ConsoleForType ( int ConsoleType )

private

◆ ConToggleLocalConsole()

void CGameConsole::ConToggleLocalConsole	(	IConsole::IResult *	pResult,
		void *	pUserData )

staticprivate

◆ ConToggleRemoteConsole()

void CGameConsole::ConToggleRemoteConsole	(	IConsole::IResult *	pResult,
		void *	pUserData )

staticprivate

◆ CurrentConsole()

CGameConsole::CInstance * CGameConsole::CurrentConsole ( )

private

◆ ForceUpdateRemoteCompletionSuggestions()

void CGameConsole::ForceUpdateRemoteCompletionSuggestions ( )

◆ IsActive()

bool CGameConsole::IsActive ( ) const

inline

◆ OnConsoleInit()

void CGameConsole::OnConsoleInit ( )

overridevirtual

Called to let the components register their console commands.

Reimplemented from CComponent.

◆ OnInit()

void CGameConsole::OnInit ( )

overridevirtual

Called to let the components run initialization code.

Reimplemented from CComponent.

◆ OnInput()

bool CGameConsole::OnInput ( const IInput::CEvent & Event )

overridevirtual

Called on a input event.

Parameters

Event The input event.

Reimplemented from CComponent.

◆ OnMessage()

void CGameConsole::OnMessage	(	int	Msg,
		void *	pRawMsg )

overridevirtual

Called when receiving a network message.

Parameters

Msg	The message type.
pRawMsg	The message data.

See also: NETMSGTYPE_SV_DDRACETIME; CNetMsg_Sv_DDRaceTime

Reimplemented from CComponent.

◆ OnRender()

void CGameConsole::OnRender ( )

overridevirtual

Called when the component should get rendered.

The render order depends on the component insertion order.

Reimplemented from CComponent.

◆ OnReset()

void CGameConsole::OnReset ( )

overridevirtual

Called to reset the component. This method is usually called on your component constructor to avoid code duplication.

See also: CHud::CHud(); CHud::OnReset()

Reimplemented from CComponent.

◆ OnStateChange()

void CGameConsole::OnStateChange	(	int	NewState,
		int	OldState )

overridevirtual

This method is called when the client changes state, e.g from offline to online.

See also: IClient::STATE_CONNECTING; IClient::STATE_LOADING; IClient::STATE_ONLINE

Reimplemented from CComponent.

◆ PossibleCommandsRenderCallback()

void CGameConsole::PossibleCommandsRenderCallback	(	int	Index,
		const char *	pStr,
		void *	pUser )

staticprivate

◆ PossibleMaps()

int CGameConsole::PossibleMaps	(	const char *	pStr,
		IConsole::FPossibleCallback	pfnCallback = IConsole::EmptyPossibleCommandCallback,
		void *	pUser = nullptr )

private

◆ PrintLine()

void CGameConsole::PrintLine	(	int	Type,
		const char *	pLine )

◆ Prompt()

void CGameConsole::Prompt ( char(&) aPrompt[32] )

◆ RequireUsername()

void CGameConsole::RequireUsername ( bool UsernameReq )

◆ Sizeof()

int CGameConsole::Sizeof ( ) const

inlineoverridevirtual

Gets the size of the non-abstract component.

Implements CComponent.

◆ Toggle()

void CGameConsole::Toggle ( int Type )

◆ CConsoleLogger

friend class CConsoleLogger

friend

Member Data Documentation

◆ m_ConsoleState

int CGameConsole::m_ConsoleState

private

◆ m_ConsoleType

int CGameConsole::m_ConsoleType

private

◆ m_LocalConsole

CInstance CGameConsole::m_LocalConsole

private

◆ m_pConsole

class IConsole* CGameConsole::m_pConsole

private

◆ m_pConsoleLogger

CConsoleLogger* CGameConsole::m_pConsoleLogger = nullptr

private

◆ m_RemoteConsole

CInstance CGameConsole::m_RemoteConsole

private

◆ m_StateChangeDuration

float CGameConsole::m_StateChangeDuration

private

◆ m_StateChangeEnd

float CGameConsole::m_StateChangeEnd

private

◆ m_TouchState

CUi::CTouchState CGameConsole::m_TouchState

private

◆ m_WantsSelectionCopy

bool CGameConsole::m_WantsSelectionCopy = false

private

◆ ms_SearchHighlightColor

ColorRGBA CGameConsole::ms_SearchHighlightColor = ColorRGBA(1.0f, 0.0f, 0.0f, 1.0f)

staticconstexprprivate

◆ ms_SearchSelectedColor

ColorRGBA CGameConsole::ms_SearchSelectedColor = ColorRGBA(1.0f, 1.0f, 0.0f, 1.0f)

staticconstexprprivate

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

src/game/client/components/console.h
src/game/client/components/console.cpp

Classes

Public Types

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ CGameConsole()

◆ ~CGameConsole()

Member Function Documentation

◆ ConchainConsoleOutputLevel()

◆ ConClearLocalConsole()

◆ ConClearRemoteConsole()

◆ ConConsolePageBottom()

◆ ConConsolePageDown()

◆ ConConsolePageTop()

◆ ConConsolePageUp()

◆ ConDumpLocalConsole()

◆ ConDumpRemoteConsole()

◆ ConsoleForType()

◆ ConToggleLocalConsole()

◆ ConToggleRemoteConsole()

◆ CurrentConsole()

◆ ForceUpdateRemoteCompletionSuggestions()

◆ IsActive()

◆ OnConsoleInit()

◆ OnInit()

◆ OnInput()

◆ OnMessage()

◆ OnRender()

◆ OnReset()

◆ OnStateChange()

◆ PossibleCommandsRenderCallback()

◆ PossibleMaps()

◆ PrintLine()

◆ Prompt()

◆ RequireUsername()

◆ Sizeof()

◆ Toggle()

Friends And Related Symbol Documentation

◆ CConsoleLogger

Member Data Documentation

◆ m_ConsoleState

◆ m_ConsoleType

◆ m_LocalConsole

◆ m_pConsole

◆ m_pConsoleLogger

◆ m_RemoteConsole

◆ m_StateChangeDuration

◆ m_StateChangeEnd

◆ m_TouchState

◆ m_WantsSelectionCopy

◆ ms_SearchHighlightColor

◆ ms_SearchSelectedColor