#include <console.h>

Inheritance diagram for Engines::Console:

[legend]

Collaboration diagram for Engines::Console:

[legend]

Classes
struct	Command

struct	CommandLine

Public Member Functions
	Console (Engine &engine, const Common::UString &font, int fontHeight=0)

virtual	~Console ()

void	show ()

void	hide ()

bool	isVisible () const

float	getWidth () const

float	getHeight () const

size_t	getLines () const

size_t	getColumns () const

bool	processEvent (const Events::Event &event)

void	disableCommand (const Common::UString &cmd, const Common::UString &reason="")

void	enableCommand (const Common::UString &cmd)

void	clear ()

void	print (const Common::UString &line)

void	printf (const char *s,...) GCC_PRINTF(2

Protected Types
typedef boost::function< void(const CommandLine &cl)>	CommandCallback

Protected Member Functions
void	printException (Common::Exception &e, const Common::UString &prefix="ERROR: ")

bool	registerCommand (const Common::UString &cmd, const CommandCallback &callback, const Common::UString &help)

void	printCommandHelp (const Common::UString &cmd)

void	printList (const std::vector< Common::UString > &list, size_t maxSize=0)

void	setArguments (const Common::UString &cmd, const std::vector< Common::UString > &args)

void	setArguments (const Common::UString &cmd)

virtual void	updateCaches ()

virtual void	showCallback ()

Static Protected Member Functions
static void	splitArguments (Common::UString argLine, std::vector< Common::UString > &args)

Private Types
typedef std::map< Common::UString, Command, Common::UString::iless >	CommandMap

Private Member Functions
void	updateVideos ()

void	updateSounds ()

void	cmdHelp (const CommandLine &cl)

void	cmdClear (const CommandLine &cl)

void	cmdClose (const CommandLine &cl)

void	cmdQuit (const CommandLine &cl)

void	cmdDumpResList (const CommandLine &cl)

void	cmdDumpRes (const CommandLine &cl)

void	cmdDumpTGA (const CommandLine &cl)

void	cmdDump2DA (const CommandLine &cl)

void	cmdDumpAll2DA (const CommandLine &cl)

void	cmdListVideos (const CommandLine &cl)

void	cmdPlayVideo (const CommandLine &cl)

void	cmdListSounds (const CommandLine &cl)

void	cmdPlaySound (const CommandLine &cl)

void	cmdSilence (const CommandLine &cl)

void	cmdGetOption (const CommandLine &cl)

void	cmdSetOption (const CommandLine &cl)

void	cmdShowFPS (const CommandLine &cl)

void	cmdListLangs (const CommandLine &cl)

void	cmdGetLang (const CommandLine &cl)

void	cmdSetLang (const CommandLine &cl)

void	cmdGetString (const CommandLine &cl)

void	cmdGetCamera (const CommandLine &cl)

void	cmdSetCamera (const CommandLine &cl)

void	updateHelpArguments ()

void	printFullHelp ()

bool	printHints (const Common::UString &command)

void	execute (const Common::UString &line)

Private Attributes
Engine *	_engine

bool	_neverShown

bool	_visible

Common::ScopedPtr< Common::ReadLine >	_readLine

Common::ScopedPtr< ConsoleWindow >	_console

CommandMap	_commands

size_t	_tabCount

bool	_printedCompleteWarning

int8	_lastClickCount

uint8	_lastClickButton

uint32	_lastClickTime

ptrdiff_t	_lastClickX

ptrdiff_t	_lastClickY

std::vector< Common::UString >	_videos

std::vector< Common::UString >	_sounds

size_t	_maxSizeVideos

size_t	_maxSizeSounds

Detailed Description

Definition at line 190 of file console.h.

Member Typedef Documentation

◆ CommandCallback

typedef boost::function<void (const CommandLine &cl)> Engines::Console::CommandCallback

protected

Definition at line 221 of file console.h.

◆ CommandMap

typedef std::map<Common::UString, Command, Common::UString::iless> Engines::Console::CommandMap

private

Definition at line 252 of file console.h.

Constructor & Destructor Documentation

◆ Console()

Engines::Console::Console	(	Engine &	engine,
		const Common::UString &	font,
		int	fontHeight = `0`
	)

Definition at line 703 of file console.cpp.

References _console, _readLine, cmdClear(), cmdClose(), cmdDump2DA(), cmdDumpAll2DA(), cmdDumpRes(), cmdDumpResList(), cmdDumpTGA(), cmdGetCamera(), cmdGetLang(), cmdGetOption(), cmdGetString(), cmdHelp(), cmdListLangs(), cmdListSounds(), cmdListVideos(), cmdPlaySound(), cmdPlayVideo(), cmdQuit(), cmdSetCamera(), cmdSetLang(), cmdSetOption(), cmdShowFPS(), cmdSilence(), kCommandHistorySize, kConsoleHistory, kConsoleLines, registerCommand(), and Common::ScopedPtrBase< T, Deallocator >::reset().

Here is the call graph for this function:

◆ ~Console()

Engines::Console::~Console ( )

virtual

Reimplemented in Engines::NWN::Console, Engines::Witcher::Console, Engines::Sonic::Console, Engines::Jade::Console, Engines::KotOR::Console, Engines::KotOR2::Console, Engines::NWN2::Console, Engines::DragonAge::Console, and Engines::DragonAge2::Console.

Definition at line 766 of file console.cpp.

References hide().

Here is the call graph for this function:

Member Function Documentation

◆ clear()

void Engines::Console::clear ( )

Definition at line 1085 of file console.cpp.

References _console.

Referenced by cmdClear(), and processEvent().

Here is the caller graph for this function:

◆ cmdClear()

void Engines::Console::cmdClear ( const CommandLine & cl )

private

Definition at line 1172 of file console.cpp.

References clear().

Referenced by Console().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cmdClose()

void Engines::Console::cmdClose ( const CommandLine & cl )

private

Definition at line 1176 of file console.cpp.

References hide().

Referenced by Console().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cmdDump2DA()

void Engines::Console::cmdDump2DA ( const CommandLine & cl )

private

Definition at line 1227 of file console.cpp.

References Engines::Console::CommandLine::args, Common::UString::c_str(), Engines::Console::CommandLine::cmd, Engines::dump2DA(), Common::UString::empty(), Common::FilePath::getUserDataFile(), printCommandHelp(), and printf().

Referenced by Console().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cmdDumpAll2DA()

void Engines::Console::cmdDumpAll2DA ( const CommandLine & cl )

private

Definition at line 1241 of file console.cpp.

References Common::UString::c_str(), Engines::dump2DA(), Common::FilePath::getUserDataFile(), Aurora::kFileType2DA, printf(), and ResMan.

Referenced by Console().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cmdDumpRes()

void Engines::Console::cmdDumpRes ( const CommandLine & cl )

private

Definition at line 1199 of file console.cpp.

References Engines::Console::CommandLine::args, Common::UString::c_str(), Engines::Console::CommandLine::cmd, Engines::dumpResource(), Common::UString::empty(), Common::FilePath::getUserDataFile(), printCommandHelp(), and printf().

Referenced by Console().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cmdDumpResList()

void Engines::Console::cmdDumpResList ( const CommandLine & cl )

private

Definition at line 1185 of file console.cpp.

References Engines::Console::CommandLine::args, Common::UString::c_str(), Engines::Console::CommandLine::cmd, Engines::dumpResList(), Common::UString::empty(), Common::FilePath::getUserDataFile(), printCommandHelp(), and printf().

Referenced by Console().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cmdDumpTGA()

void Engines::Console::cmdDumpTGA ( const CommandLine & cl )

private

Definition at line 1213 of file console.cpp.

References Engines::Console::CommandLine::args, Common::UString::c_str(), Engines::Console::CommandLine::cmd, Engines::dumpTGA(), Common::UString::empty(), Common::FilePath::getUserDataFile(), printCommandHelp(), and printf().

Referenced by Console().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cmdGetCamera()

void Engines::Console::cmdGetCamera ( const CommandLine & cl )

private

Definition at line 1418 of file console.cpp.

References CameraMan, and printf().

Referenced by Console().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cmdGetLang()

void Engines::Console::cmdGetLang ( const CommandLine & cl )

private

Definition at line 1351 of file console.cpp.

References _engine, Engines::Engine::getLanguage(), LangMan, and printf().

Referenced by Console().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cmdGetOption()

void Engines::Console::cmdGetOption ( const CommandLine & cl )

private

Definition at line 1288 of file console.cpp.

References Engines::Console::CommandLine::args, Engines::Console::CommandLine::cmd, ConfigMan, printCommandHelp(), printf(), and splitArguments().

Referenced by Console().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cmdGetString()

void Engines::Console::cmdGetString ( const CommandLine & cl )

private

Definition at line 1401 of file console.cpp.

References Engines::Console::CommandLine::args, Engines::Console::CommandLine::cmd, Common::UString::empty(), Common::parseString(), printCommandHelp(), printf(), and TalkMan.

Referenced by Console().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cmdHelp()

void Engines::Console::cmdHelp ( const CommandLine & cl )

private

Definition at line 1163 of file console.cpp.

References Engines::Console::CommandLine::args, Common::UString::empty(), printCommandHelp(), and printFullHelp().

Referenced by Console().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cmdListLangs()

void Engines::Console::cmdListLangs ( const CommandLine & cl )

private

Definition at line 1325 of file console.cpp.

References _engine, Engines::Engine::detectLanguages(), LangMan, and printf().

Referenced by Console().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cmdListSounds()

void Engines::Console::cmdListSounds ( const CommandLine & cl )

private

Definition at line 1270 of file console.cpp.

References _maxSizeSounds, _sounds, printList(), and updateSounds().

Referenced by Console().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cmdListVideos()

void Engines::Console::cmdListVideos ( const CommandLine & cl )

private

Definition at line 1256 of file console.cpp.

References _maxSizeVideos, _videos, printList(), and updateVideos().

Referenced by Console().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cmdPlaySound()

void Engines::Console::cmdPlaySound ( const CommandLine & cl )

private

Definition at line 1275 of file console.cpp.

References Engines::Console::CommandLine::args, Engines::Console::CommandLine::cmd, Common::UString::empty(), Sound::kSoundTypeSFX, Engines::playSound(), and printCommandHelp().

Referenced by Console().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cmdPlayVideo()

void Engines::Console::cmdPlayVideo ( const CommandLine & cl )

private

Definition at line 1261 of file console.cpp.

References Engines::Console::CommandLine::args, Engines::Console::CommandLine::cmd, Common::UString::empty(), Engines::playVideo(), and printCommandHelp().

Referenced by Console().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cmdQuit()

void Engines::Console::cmdQuit ( const CommandLine & cl )

private

Definition at line 1180 of file console.cpp.

References EventMan, and print().

Referenced by Console().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cmdSetCamera()

void Engines::Console::cmdSetCamera ( const CommandLine & cl )

private

Definition at line 1426 of file console.cpp.

References Engines::Console::CommandLine::args, CameraMan, Engines::Console::CommandLine::cmd, Common::parseString(), printCommandHelp(), and splitArguments().

Referenced by Console().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cmdSetLang()

void Engines::Console::cmdSetLang ( const CommandLine & cl )

private

Definition at line 1362 of file console.cpp.

References _engine, Engines::Console::CommandLine::args, Engines::Engine::changeLanguage(), Engines::Console::CommandLine::cmd, ConfigMan, Engines::Engine::getLanguage(), LangMan, printCommandHelp(), printf(), and splitArguments().

Referenced by Console().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cmdSetOption()

void Engines::Console::cmdSetOption ( const CommandLine & cl )

private

Definition at line 1300 of file console.cpp.

References _engine, Engines::Console::CommandLine::args, Engines::Console::CommandLine::cmd, ConfigMan, printCommandHelp(), printf(), Engines::Engine::showFPS(), and splitArguments().

Referenced by Console().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cmdShowFPS()

void Engines::Console::cmdShowFPS ( const CommandLine & cl )

private

Definition at line 1315 of file console.cpp.

References _engine, Engines::Console::CommandLine::args, Engines::Console::CommandLine::cmd, ConfigMan, Common::UString::empty(), printCommandHelp(), and Engines::Engine::showFPS().

Referenced by Console().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cmdSilence()

void Engines::Console::cmdSilence ( const CommandLine & cl )

private

Definition at line 1284 of file console.cpp.

References SoundMan.

Referenced by Console().

Here is the caller graph for this function:

◆ disableCommand()

void Engines::Console::disableCommand	(	const Common::UString &	cmd,
		const Common::UString &	reason = `""`
	)

Definition at line 972 of file console.cpp.

References _commands, and Common::UString::c_str().

Referenced by Engines::KotOR2::Game::mainMenu(), Engines::KotOR::Game::mainMenu(), Engines::Jade::Game::mainMenu(), and Engines::NWN::Game::mainMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enableCommand()

void Engines::Console::enableCommand ( const Common::UString & cmd )

Definition at line 983 of file console.cpp.

References _commands, and Common::UString::c_str().

Referenced by Engines::KotOR2::Game::mainMenu(), Engines::KotOR::Game::mainMenu(), Engines::Jade::Game::mainMenu(), and Engines::NWN::Game::mainMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ execute()

void Engines::Console::execute ( const Common::UString & line )

private

Definition at line 993 of file console.cpp.

References _commands, _console, Engines::Console::CommandLine::args, Common::UString::c_str(), Engines::Console::CommandLine::cmd, Common::UString::empty(), Common::UString::findFirst(), kPrompt, printf(), Common::UString::split(), and Common::UString::trim().

Referenced by processEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getColumns()

size_t Engines::Console::getColumns ( ) const

Definition at line 813 of file console.cpp.

References _console.

Referenced by printHints(), and printList().

Here is the caller graph for this function:

◆ getHeight()

float Engines::Console::getHeight ( ) const

Definition at line 805 of file console.cpp.

References _console.

◆ getLines()

size_t Engines::Console::getLines ( ) const

Definition at line 809 of file console.cpp.

References _console.

◆ getWidth()

float Engines::Console::getWidth ( ) const

Definition at line 801 of file console.cpp.

References _console.

◆ hide()

void Engines::Console::hide ( )

Definition at line 787 of file console.cpp.

References _console, _visible, and EventMan.

Referenced by cmdClose(), Engines::Jade::Console::cmdExitModule(), Engines::KotOR::Console::cmdExitModule(), Engines::KotOR2::Console::cmdExitModule(), Engines::NWN::Console::cmdExitModule(), Engines::NWN2::Console::cmdGotoArea(), Engines::Witcher::Console::cmdGotoArea(), Engines::NWN::Console::cmdGotoArea(), Engines::DragonAge::Console::cmdLoadArea(), Engines::DragonAge2::Console::cmdLoadArea(), Engines::DragonAge::Console::cmdLoadCampaign(), Engines::DragonAge2::Console::cmdLoadCampaign(), Engines::NWN2::Console::cmdLoadCampaign(), Engines::Witcher::Console::cmdLoadCampaign(), Engines::NWN::Console::cmdLoadCampaign(), Engines::Jade::Console::cmdLoadModule(), Engines::KotOR::Console::cmdLoadModule(), Engines::KotOR2::Console::cmdLoadModule(), Engines::NWN2::Console::cmdLoadModule(), Engines::NWN::Console::cmdLoadModule(), Engines::Witcher::Console::cmdLoadModule(), processEvent(), Engines::Jade::Module::replaceModule(), Engines::Witcher::Module::replaceModule(), Engines::NWN2::Module::replaceModule(), Engines::KotOR2::Module::replaceModule(), Engines::NWN::Module::replaceModule(), Engines::KotOR::Module::replaceModule(), and ~Console().

Here is the caller graph for this function:

◆ isVisible()

bool Engines::Console::isVisible ( ) const

Definition at line 797 of file console.cpp.

References _visible.

Referenced by Engines::Sonic::Module::handleEvents(), Engines::NWN2::Campaign::handleEvents(), Engines::DragonAge::Campaigns::handleEvents(), Engines::DragonAge2::Campaigns::handleEvents(), Engines::Witcher::Campaign::handleEvents(), Engines::Jade::Module::handleEvents(), Engines::KotOR2::Module::handleEvents(), Engines::NWN::Module::handleEvents(), Engines::KotOR::Module::handleEvents(), processEvent(), and Engines::GUI::processEventQueue().

Here is the caller graph for this function:

◆ print()

void Engines::Console::print ( const Common::UString & line )

Definition at line 1089 of file console.cpp.

References _console.

Referenced by Engines::NWN::Console::cmdListCampaigns(), cmdQuit(), printCommandHelp(), printException(), printf(), printFullHelp(), and printList().

Here is the caller graph for this function:

◆ printCommandHelp()

void Engines::Console::printCommandHelp ( const Common::UString & cmd )

protected

Definition at line 1391 of file console.cpp.

References _commands, print(), and printFullHelp().

Referenced by Engines::KotOR::Console::cmdAddItem(), cmdDump2DA(), cmdDumpRes(), cmdDumpResList(), cmdDumpTGA(), cmdGetOption(), cmdGetString(), Engines::Sonic::Console::cmdGotoArea(), Engines::NWN2::Console::cmdGotoArea(), Engines::Witcher::Console::cmdGotoArea(), Engines::NWN::Console::cmdGotoArea(), cmdHelp(), Engines::KotOR::Console::cmdListRoomsVisibleFrom(), Engines::KotOR2::Console::cmdListRoomsVisibleFrom(), Engines::DragonAge2::Console::cmdLoadArea(), Engines::DragonAge::Console::cmdLoadArea(), Engines::DragonAge2::Console::cmdLoadCampaign(), Engines::DragonAge::Console::cmdLoadCampaign(), Engines::NWN2::Console::cmdLoadCampaign(), Engines::Witcher::Console::cmdLoadCampaign(), Engines::NWN::Console::cmdLoadCampaign(), Engines::Jade::Console::cmdLoadModule(), Engines::KotOR::Console::cmdLoadModule(), Engines::KotOR2::Console::cmdLoadModule(), Engines::NWN2::Console::cmdLoadModule(), Engines::NWN::Console::cmdLoadModule(), Engines::Witcher::Console::cmdLoadModule(), Engines::NWN2::Console::cmdMove(), Engines::Witcher::Console::cmdMove(), Engines::KotOR::Console::cmdPlayAnim(), Engines::KotOR2::Console::cmdPlayAnim(), cmdPlaySound(), cmdPlayVideo(), cmdSetCamera(), cmdSetLang(), cmdSetOption(), and cmdShowFPS().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ printException()

void Engines::Console::printException	(	Common::Exception &	e,
		const Common::UString &	prefix = `"ERROR: "`
	)

protected

Definition at line 1104 of file console.cpp.

References Common::UString::c_str(), Common::StackException::getStack(), print(), and printf().

Here is the call graph for this function:

◆ printf()

void Engines::Console::printf	(	const char *	s,
			...
	)

Definition at line 1093 of file console.cpp.

References print(), and STRINGBUFLEN.

Referenced by cmdDump2DA(), cmdDumpAll2DA(), cmdDumpRes(), cmdDumpResList(), cmdDumpTGA(), cmdGetCamera(), cmdGetLang(), cmdGetOption(), Engines::KotOR::Console::cmdGetPCRoom(), Engines::KotOR2::Console::cmdGetPCRoom(), cmdGetString(), Engines::Sonic::Console::cmdGotoArea(), Engines::NWN2::Console::cmdGotoArea(), Engines::Witcher::Console::cmdGotoArea(), Engines::NWN::Console::cmdGotoArea(), Engines::DragonAge::Console::cmdListAreas(), Engines::DragonAge2::Console::cmdListAreas(), Engines::Sonic::Console::cmdListAreas(), Engines::NWN2::Console::cmdListAreas(), Engines::Witcher::Console::cmdListAreas(), Engines::NWN::Console::cmdListAreas(), Engines::DragonAge::Console::cmdListCampaigns(), Engines::DragonAge2::Console::cmdListCampaigns(), Engines::NWN2::Console::cmdListCampaigns(), Engines::Witcher::Console::cmdListCampaigns(), cmdListLangs(), Engines::KotOR::Console::cmdListModules(), Engines::KotOR2::Console::cmdListModules(), Engines::NWN2::Console::cmdListModules(), Engines::Witcher::Console::cmdListModules(), Engines::KotOR2::Console::cmdListRoomsVisibleFrom(), Engines::KotOR::Console::cmdListRoomsVisibleFrom(), Engines::DragonAge::Console::cmdLoadArea(), Engines::DragonAge2::Console::cmdLoadArea(), Engines::DragonAge2::Console::cmdLoadCampaign(), Engines::DragonAge::Console::cmdLoadCampaign(), Engines::NWN2::Console::cmdLoadCampaign(), Engines::NWN::Console::cmdLoadCampaign(), Engines::Witcher::Console::cmdLoadCampaign(), Engines::Jade::Console::cmdLoadModule(), Engines::KotOR::Console::cmdLoadModule(), Engines::KotOR2::Console::cmdLoadModule(), Engines::NWN2::Console::cmdLoadModule(), Engines::Witcher::Console::cmdLoadModule(), Engines::NWN::Console::cmdLoadModule(), cmdSetLang(), cmdSetOption(), Engines::NWN2::Module::enter(), Engines::KotOR2::Module::enter(), Engines::Jade::Module::enter(), Engines::Witcher::Module::enter(), Engines::NWN::Module::enter(), Engines::KotOR::Module::enter(), Engines::Witcher::Module::enterArea(), Engines::NWN2::Module::enterArea(), Engines::NWN::Module::enterArea(), execute(), printException(), and printHints().

Here is the call graph for this function:

◆ printFullHelp()

void Engines::Console::printFullHelp ( )

private

Definition at line 1463 of file console.cpp.

References _commands, MAX(), print(), and printList().

Referenced by cmdHelp(), and printCommandHelp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ printHints()

bool Engines::Console::printHints ( const Common::UString & command )

private

Definition at line 1052 of file console.cpp.

References _console, _printedCompleteWarning, _readLine, _tabCount, getColumns(), kConsoleLines, kPrompt, printf(), and printList().

Referenced by processEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ printList()

void Engines::Console::printList	(	const std::vector< Common::UString > &	list,
		size_t	maxSize = `0`
	)

protected

Definition at line 1479 of file console.cpp.

References Common::UString::format(), getColumns(), kConsoleHistory, print(), Common::UString::size(), and Common::UString::truncate().

Referenced by Engines::Jade::Console::cmdListModules(), Engines::NWN::Console::cmdListModules(), Engines::NWN2::Console::cmdListMusic(), Engines::KotOR::Console::cmdListMusic(), Engines::KotOR2::Console::cmdListMusic(), Engines::Witcher::Console::cmdListMusic(), Engines::NWN::Console::cmdListMusic(), cmdListSounds(), cmdListVideos(), printFullHelp(), and printHints().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ processEvent()

bool Engines::Console::processEvent ( const Events::Event & event )

Definition at line 817 of file console.cpp.

References _console, _lastClickButton, _lastClickCount, _lastClickTime, _lastClickX, _lastClickY, _printedCompleteWarning, _readLine, _tabCount, clear(), EventMan, execute(), hide(), isVisible(), kConsoleLines, kDoubleClickTime, Events::kEventKeyDown, Events::kEventMouseDown, Events::kEventMouseMove, Events::kEventMouseUp, Events::kEventMouseWheel, and printHints().

Referenced by Engines::Sonic::Module::handleEvents(), Engines::NWN2::Campaign::handleEvents(), Engines::DragonAge2::Campaigns::handleEvents(), Engines::DragonAge::Campaigns::handleEvents(), Engines::Witcher::Campaign::handleEvents(), Engines::Jade::Module::handleEvents(), Engines::KotOR2::Module::handleEvents(), Engines::NWN::Module::handleEvents(), Engines::KotOR::Module::handleEvents(), and Engines::GUI::processEventQueue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ registerCommand()

bool Engines::Console::registerCommand	(	const Common::UString &	cmd,
		const CommandCallback &	callback,
		const Common::UString &	help
	)

protected

Definition at line 1576 of file console.cpp.

References _commands, _readLine, and updateHelpArguments().

Referenced by Engines::DragonAge::Console::Console(), Engines::DragonAge2::Console::Console(), Engines::Jade::Console::Console(), Engines::NWN2::Console::Console(), Engines::KotOR::Console::Console(), Engines::KotOR2::Console::Console(), Engines::Sonic::Console::Console(), Engines::Witcher::Console::Console(), Engines::NWN::Console::Console(), and Console().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setArguments() [1/2]

void Engines::Console::setArguments	(	const Common::UString &	cmd,
		const std::vector< Common::UString > &	args
	)

protected

Definition at line 1565 of file console.cpp.

References _readLine.

Referenced by Engines::DragonAge::Console::updateAreas(), Engines::DragonAge2::Console::updateAreas(), Engines::Sonic::Console::updateAreas(), Engines::NWN2::Console::updateAreas(), Engines::Witcher::Console::updateAreas(), Engines::NWN::Console::updateAreas(), Engines::DragonAge::Console::updateCampaigns(), Engines::DragonAge2::Console::updateCampaigns(), Engines::NWN2::Console::updateCampaigns(), Engines::Witcher::Console::updateCampaigns(), Engines::NWN::Console::updateCampaigns(), Engines::Jade::Console::updateModules(), Engines::KotOR::Console::updateModules(), Engines::KotOR2::Console::updateModules(), Engines::NWN2::Console::updateModules(), Engines::Witcher::Console::updateModules(), Engines::NWN::Console::updateModules(), Engines::KotOR2::Console::updateMusic(), Engines::NWN2::Console::updateMusic(), Engines::KotOR::Console::updateMusic(), Engines::Witcher::Console::updateMusic(), Engines::NWN::Console::updateMusic(), updateSounds(), and updateVideos().

Here is the caller graph for this function:

◆ setArguments() [2/2]

void Engines::Console::setArguments ( const Common::UString & cmd )

protected

Definition at line 1569 of file console.cpp.

References _readLine.

◆ show()

void Engines::Console::show ( )

Definition at line 770 of file console.cpp.

References _console, _neverShown, _visible, EventMan, showCallback(), and updateCaches().

Referenced by Engines::Sonic::Module::handleEvents(), Engines::NWN2::Campaign::handleEvents(), Engines::DragonAge2::Campaigns::handleEvents(), Engines::DragonAge::Campaigns::handleEvents(), Engines::Witcher::Campaign::handleEvents(), Engines::Jade::Module::handleEvents(), Engines::KotOR2::Module::handleEvents(), Engines::NWN::Module::handleEvents(), Engines::KotOR::Module::handleEvents(), and Engines::GUI::processEventQueue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showCallback()

void Engines::Console::showCallback ( )

protectedvirtual

Definition at line 1573 of file console.cpp.

Referenced by show().

Here is the caller graph for this function:

◆ splitArguments()

void Engines::Console::splitArguments	(	Common::UString	argLine,
		std::vector< Common::UString > &	args
	)

staticprotected

Definition at line 1539 of file console.cpp.

References Common::UString::begin(), and Common::UString::end().

Referenced by cmdGetOption(), Engines::NWN2::Console::cmdMove(), Engines::Witcher::Console::cmdMove(), cmdSetCamera(), cmdSetLang(), and cmdSetOption().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateCaches()

void Engines::Console::updateCaches ( )

protectedvirtual

Reimplemented in Engines::NWN::Console, Engines::Witcher::Console, Engines::NWN2::Console, Engines::KotOR::Console, Engines::KotOR2::Console, Engines::Sonic::Console, Engines::Jade::Console, Engines::DragonAge::Console, and Engines::DragonAge2::Console.

Definition at line 1122 of file console.cpp.

References updateSounds(), and updateVideos().

Referenced by show(), Engines::DragonAge::Console::updateCaches(), Engines::DragonAge2::Console::updateCaches(), Engines::Jade::Console::updateCaches(), Engines::Sonic::Console::updateCaches(), Engines::KotOR::Console::updateCaches(), Engines::KotOR2::Console::updateCaches(), Engines::NWN2::Console::updateCaches(), Engines::Witcher::Console::updateCaches(), and Engines::NWN::Console::updateCaches().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateHelpArguments()

void Engines::Console::updateHelpArguments ( )

private

Definition at line 1600 of file console.cpp.

References _commands, and _readLine.

Referenced by registerCommand().

Here is the caller graph for this function:

◆ updateSounds()

void Engines::Console::updateSounds ( )

private

Definition at line 1145 of file console.cpp.

References _maxSizeSounds, _sounds, Aurora::kFileTypeWAV, MAX(), ResMan, and setArguments().

Referenced by cmdListSounds(), and updateCaches().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateVideos()

void Engines::Console::updateVideos ( )

private

Definition at line 1127 of file console.cpp.

References _maxSizeVideos, _videos, Aurora::kResourceVideo, MAX(), ResMan, and setArguments().

Referenced by cmdListVideos(), and updateCaches().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ _commands

CommandMap Engines::Console::_commands

private

Definition at line 263 of file console.h.

Referenced by disableCommand(), enableCommand(), execute(), printCommandHelp(), printFullHelp(), registerCommand(), and updateHelpArguments().

◆ _console

Common::ScopedPtr<ConsoleWindow> Engines::Console::_console

private

Definition at line 261 of file console.h.

Referenced by clear(), Console(), execute(), getColumns(), getHeight(), getLines(), getWidth(), hide(), print(), printHints(), processEvent(), and show().

◆ _engine

Engine* Engines::Console::_engine

private

Definition at line 255 of file console.h.

Referenced by cmdGetLang(), cmdListLangs(), cmdSetLang(), cmdSetOption(), and cmdShowFPS().

◆ _lastClickButton

uint8 Engines::Console::_lastClickButton

private

Definition at line 269 of file console.h.

Referenced by processEvent().

◆ _lastClickCount

int8 Engines::Console::_lastClickCount

private

Definition at line 268 of file console.h.

Referenced by processEvent().

◆ _lastClickTime

uint32 Engines::Console::_lastClickTime

private

Definition at line 270 of file console.h.

Referenced by processEvent().

◆ _lastClickX

ptrdiff_t Engines::Console::_lastClickX

private

Definition at line 272 of file console.h.

Referenced by processEvent().

◆ _lastClickY

ptrdiff_t Engines::Console::_lastClickY

private

Definition at line 273 of file console.h.

Referenced by processEvent().

◆ _maxSizeSounds

size_t Engines::Console::_maxSizeSounds

private

Definition at line 280 of file console.h.

Referenced by cmdListSounds(), and updateSounds().

◆ _maxSizeVideos

size_t Engines::Console::_maxSizeVideos

private

Definition at line 279 of file console.h.

Referenced by cmdListVideos(), and updateVideos().

◆ _neverShown

bool Engines::Console::_neverShown

private

Definition at line 257 of file console.h.

Referenced by show().

◆ _printedCompleteWarning

bool Engines::Console::_printedCompleteWarning

private

Definition at line 266 of file console.h.

Referenced by printHints(), and processEvent().

◆ _readLine

Common::ScopedPtr<Common::ReadLine> Engines::Console::_readLine

private

Definition at line 260 of file console.h.

Referenced by Console(), printHints(), processEvent(), registerCommand(), setArguments(), and updateHelpArguments().

◆ _sounds

std::vector<Common::UString> Engines::Console::_sounds

private

Definition at line 277 of file console.h.

Referenced by cmdListSounds(), and updateSounds().

◆ _tabCount

size_t Engines::Console::_tabCount

private

Definition at line 265 of file console.h.

Referenced by printHints(), and processEvent().

◆ _videos

std::vector<Common::UString> Engines::Console::_videos

private

Definition at line 276 of file console.h.

Referenced by cmdListVideos(), and updateVideos().

◆ _visible

bool Engines::Console::_visible

private

Definition at line 258 of file console.h.

Referenced by hide(), isVisible(), and show().

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

src/engines/aurora/console.h
src/engines/aurora/console.cpp

Classes

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ CommandCallback

◆ CommandMap

Constructor & Destructor Documentation

◆ Console()

◆ ~Console()

Member Function Documentation

◆ clear()

◆ cmdClear()

◆ cmdClose()

◆ cmdDump2DA()

◆ cmdDumpAll2DA()

◆ cmdDumpRes()

◆ cmdDumpResList()

◆ cmdDumpTGA()

◆ cmdGetCamera()

◆ cmdGetLang()

◆ cmdGetOption()

◆ cmdGetString()

◆ cmdHelp()

◆ cmdListLangs()

◆ cmdListSounds()

◆ cmdListVideos()

◆ cmdPlaySound()

◆ cmdPlayVideo()

◆ cmdQuit()

◆ cmdSetCamera()

◆ cmdSetLang()

◆ cmdSetOption()

◆ cmdShowFPS()

◆ cmdSilence()

◆ disableCommand()

◆ enableCommand()

◆ execute()

◆ getColumns()

◆ getHeight()

◆ getLines()

◆ getWidth()

◆ hide()

◆ isVisible()

◆ print()

◆ printCommandHelp()

◆ printException()

◆ printf()

◆ printFullHelp()

◆ printHints()

◆ printList()

◆ processEvent()

◆ registerCommand()

◆ setArguments() [1/2]

◆ setArguments() [2/2]

◆ show()

◆ showCallback()

◆ splitArguments()

◆ updateCaches()

◆ updateHelpArguments()

◆ updateSounds()

◆ updateVideos()

Member Data Documentation

◆ _commands

◆ _console

◆ _engine

◆ _lastClickButton

◆ _lastClickCount

◆ _lastClickTime

◆ _lastClickX

◆ _lastClickY

◆ _maxSizeSounds

◆ _maxSizeVideos

◆ _neverShown

◆ _printedCompleteWarning