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

#include <console.h>

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

Public Member Functions

 Console (NWN2Engine &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 Member Functions

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

Private Attributes

NWN2Engine_engine
 
std::vector< Common::UString_music
 All known music resources. More...
 
std::vector< Common::UString_campaigns
 All known campaigns. More...
 
std::vector< Common::UString_modules
 All known modules. 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 38 of file console.h.

Constructor & Destructor Documentation

◆ Console()

Engines::NWN2::Console::Console ( NWN2Engine engine)

◆ ~Console()

Engines::NWN2::Console::~Console ( )
virtual

Reimplemented from Engines::Console.

Definition at line 76 of file console.cpp.

Member Function Documentation

◆ cmdGotoArea()

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

◆ cmdListAreas()

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

Definition at line 153 of file console.cpp.

References _engine, Common::UString::c_str(), Aurora::IFOFile::getAreas(), Engines::NWN2::NWN2Engine::getGame(), Engines::NWN2::Module::getIFO(), Engines::NWN2::Game::getModule(), Engines::NWN2::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::NWN2::Console::cmdListCampaigns ( const CommandLine cl)
private

Definition at line 178 of file console.cpp.

References _campaigns, Common::UString::c_str(), Engines::NWN2::Campaign::getName(), Engines::Console::printf(), and updateCampaigns().

Referenced by Console().

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

◆ cmdListModules()

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

Definition at line 203 of file console.cpp.

References _modules, Common::UString::c_str(), Common::UString::empty(), Engines::NWN2::Module::getName(), Engines::Console::printf(), and updateModules().

Referenced by Console().

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

◆ cmdListMusic()

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

Definition at line 123 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::NWN2::Console::cmdLoadCampaign ( const CommandLine cl)
private

◆ cmdLoadModule()

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

◆ cmdMove()

void Engines::NWN2::Console::cmdMove ( const CommandLine cl)
private

◆ cmdPlayMusic()

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

Definition at line 132 of file console.cpp.

References _engine, Engines::Console::CommandLine::args, Engines::NWN2::NWN2Engine::getGame(), and Engines::NWN2::Game::playMusic().

Referenced by Console().

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

◆ cmdStopMusic()

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

Definition at line 128 of file console.cpp.

References _engine, Engines::NWN2::NWN2Engine::getGame(), and Engines::NWN2::Game::stopMusic().

Referenced by Console().

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

◆ updateAreas()

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

Definition at line 119 of file console.cpp.

References _engine, Aurora::IFOFile::getAreas(), Engines::NWN2::NWN2Engine::getGame(), Engines::NWN2::Module::getIFO(), Engines::NWN2::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::NWN2::Console::updateCaches ( )
privatevirtual

Reimplemented from Engines::Console.

Definition at line 79 of file console.cpp.

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

Here is the call graph for this function:

◆ updateCampaigns()

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

Definition at line 107 of file console.cpp.

References _campaigns, Engines::NWN2::Game::getCampaigns(), and Engines::Console::setArguments().

Referenced by cmdListCampaigns(), cmdLoadCampaign(), and updateCaches().

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

◆ updateModules()

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

Definition at line 113 of file console.cpp.

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

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

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

◆ updateMusic()

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

Definition at line 88 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

◆ _campaigns

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

All known campaigns.

Definition at line 49 of file console.h.

Referenced by cmdListCampaigns(), cmdLoadCampaign(), and updateCampaigns().

◆ _engine

NWN2Engine* Engines::NWN2::Console::_engine
private

◆ _maxSizeMusic

size_t Engines::NWN2::Console::_maxSizeMusic
private

Definition at line 52 of file console.h.

Referenced by cmdListMusic(), and updateMusic().

◆ _modules

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

All known modules.

Definition at line 50 of file console.h.

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

◆ _music

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

All known music resources.

Definition at line 48 of file console.h.

Referenced by cmdListMusic(), and updateMusic().


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