xoreos  0.0.5
Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
Engines::NWN::Console Class Reference

#include <console.h>

Inheritance diagram for Engines::NWN::Console:
Inheritance graph
[legend]
Collaboration diagram for Engines::NWN::Console:
Collaboration graph
[legend]

Public Member Functions

 Console (NWNEngine &engine)
 
 ~Console ()
 
- Public Member Functions inherited from Engines::Console
 Console (Engine &engine, const Common::UString &font, int fontHeight=0)
 
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
 

Private Types

typedef std::map< Common::UString, int, Common::UString::ilessCampaignMap
 

Private Member Functions

void updateCaches ()
 
void updateCampaigns ()
 
void updateModules ()
 
void updateAreas ()
 
void updateMusic ()
 
void cmdExitModule (const CommandLine &cl)
 
void cmdListCampaigns (const CommandLine &cl)
 
void cmdLoadCampaign (const CommandLine &cl)
 
void cmdListModules (const CommandLine &cl)
 
void cmdLoadModule (const CommandLine &cl)
 
void cmdListAreas (const CommandLine &cl)
 
void cmdGotoArea (const CommandLine &cl)
 
void cmdListMusic (const CommandLine &cl)
 
void cmdStopMusic (const CommandLine &cl)
 
void cmdPlayMusic (const CommandLine &cl)
 

Private Attributes

NWNEngine_engine
 
std::vector< Common::UString_campaigns
 All known campaigns modules. More...
 
std::vector< Common::UString_modules
 All known modules. More...
 
std::vector< Common::UString_music
 All known music resources. More...
 
CampaignMap _campaignModules
 Mapping campaign module file -> campaign module name. More...
 
size_t _maxSizeMusic
 

Additional Inherited Members

- Protected Types inherited from Engines::Console
typedef boost::function< void(const CommandLine &cl)> CommandCallback
 
- Protected Member Functions inherited from Engines::Console
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 showCallback ()
 
- Static Protected Member Functions inherited from Engines::Console
static void splitArguments (Common::UString argLine, std::vector< Common::UString > &args)
 

Detailed Description

Definition at line 42 of file console.h.

Member Typedef Documentation

◆ CampaignMap

Definition at line 49 of file console.h.

Constructor & Destructor Documentation

◆ Console()

Engines::NWN::Console::Console ( NWNEngine engine)

◆ ~Console()

Engines::NWN::Console::~Console ( )
virtual

Reimplemented from Engines::Console.

Definition at line 91 of file console.cpp.

Member Function Documentation

◆ cmdExitModule()

void Engines::NWN::Console::cmdExitModule ( const CommandLine cl)
private

Definition at line 175 of file console.cpp.

References _engine, Engines::NWN::Module::exit(), Engines::NWN::NWNEngine::getGame(), Engines::NWN::Game::getModule(), and Engines::Console::hide().

Referenced by Console().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ cmdGotoArea()

void Engines::NWN::Console::cmdGotoArea ( const CommandLine cl)
private

◆ cmdListAreas()

void Engines::NWN::Console::cmdListAreas ( const CommandLine cl)
private

Definition at line 228 of file console.cpp.

References _engine, Common::UString::c_str(), Aurora::IFOFile::getAreas(), Engines::NWN::NWNEngine::getGame(), Engines::NWN::Module::getIFO(), Engines::NWN::Game::getModule(), Engines::NWN::Area::getName(), Engines::Console::printf(), and updateAreas().

Referenced by Console().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ cmdListCampaigns()

void Engines::NWN::Console::cmdListCampaigns ( const CommandLine cl)
private

Definition at line 181 of file console.cpp.

References _campaigns, Engines::Console::print(), and updateCampaigns().

Referenced by Console().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ cmdListModules()

void Engines::NWN::Console::cmdListModules ( const CommandLine cl)
private

Definition at line 205 of file console.cpp.

References _modules, Engines::Console::printList(), and updateModules().

Referenced by Console().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ cmdListMusic()

void Engines::NWN::Console::cmdListMusic ( const CommandLine cl)
private

Definition at line 255 of file console.cpp.

References _maxSizeMusic, _music, Engines::Console::printList(), and updateMusic().

Referenced by Console().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ cmdLoadCampaign()

void Engines::NWN::Console::cmdLoadCampaign ( const CommandLine cl)
private

◆ cmdLoadModule()

void Engines::NWN::Console::cmdLoadModule ( const CommandLine cl)
private

◆ cmdPlayMusic()

void Engines::NWN::Console::cmdPlayMusic ( const CommandLine cl)
private

Definition at line 264 of file console.cpp.

References _engine, Engines::Console::CommandLine::args, Engines::NWN::NWNEngine::getGame(), and Engines::NWN::Game::playMusic().

Referenced by Console().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ cmdStopMusic()

void Engines::NWN::Console::cmdStopMusic ( const CommandLine cl)
private

Definition at line 260 of file console.cpp.

References _engine, Engines::NWN::NWNEngine::getGame(), and Engines::NWN::Game::stopMusic().

Referenced by Console().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ updateAreas()

void Engines::NWN::Console::updateAreas ( )
private

Definition at line 152 of file console.cpp.

References _engine, Aurora::IFOFile::getAreas(), Engines::NWN::NWNEngine::getGame(), Engines::NWN::Module::getIFO(), Engines::NWN::Game::getModule(), and Engines::Console::setArguments().

Referenced by cmdListAreas(), and updateCaches().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ updateCaches()

void Engines::NWN::Console::updateCaches ( )
privatevirtual

Reimplemented from Engines::Console.

Definition at line 94 of file console.cpp.

References updateAreas(), Engines::Console::updateCaches(), updateCampaigns(), updateModules(), and updateMusic().

Here is the call graph for this function:

◆ updateCampaigns()

void Engines::NWN::Console::updateCampaigns ( )
private

Definition at line 103 of file console.cpp.

References _campaignModules, _campaigns, ARRAYSIZE, ConfigMan, Common::UString::findFirst(), kCampaignNames, Engines::Console::setArguments(), TalkMan, Common::UString::trim(), and Common::UString::truncate().

Referenced by cmdListCampaigns(), and updateCaches().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ updateModules()

void Engines::NWN::Console::updateModules ( )
private

Definition at line 146 of file console.cpp.

References _modules, Engines::NWN::Game::getModules(), and Engines::Console::setArguments().

Referenced by cmdListModules(), and updateCaches().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ updateMusic()

void Engines::NWN::Console::updateMusic ( )
private

Definition at line 156 of file console.cpp.

References _maxSizeMusic, _music, Aurora::kFileTypeBMU, MAX(), ResMan, and Engines::Console::setArguments().

Referenced by cmdListMusic(), and updateCaches().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ _campaignModules

CampaignMap Engines::NWN::Console::_campaignModules
private

Mapping campaign module file -> campaign module name.

Definition at line 59 of file console.h.

Referenced by cmdLoadCampaign(), and updateCampaigns().

◆ _campaigns

std::vector<Common::UString> Engines::NWN::Console::_campaigns
private

All known campaigns modules.

Definition at line 55 of file console.h.

Referenced by cmdListCampaigns(), and updateCampaigns().

◆ _engine

NWNEngine* Engines::NWN::Console::_engine
private

◆ _maxSizeMusic

size_t Engines::NWN::Console::_maxSizeMusic
private

Definition at line 61 of file console.h.

Referenced by cmdListMusic(), and updateMusic().

◆ _modules

std::vector<Common::UString> Engines::NWN::Console::_modules
private

All known modules.

Definition at line 56 of file console.h.

Referenced by cmdListModules(), cmdLoadModule(), and updateModules().

◆ _music

std::vector<Common::UString> Engines::NWN::Console::_music
private

All known music resources.

Definition at line 57 of file console.h.

Referenced by cmdListMusic(), and updateMusic().


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