xoreos  0.0.5
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Engines::Engine Class Referenceabstract

The base class for an engine within BioWare's Aurora family. More...

#include <engine.h>

Inheritance diagram for Engines::Engine:
Inheritance graph
[legend]
Collaboration diagram for Engines::Engine:
Collaboration graph
[legend]

Public Member Functions

 Engine ()
 
virtual ~Engine ()
 
virtual bool detectLanguages (Aurora::GameID game, const Common::UString &target, Aurora::Platform platform, std::vector< Aurora::Language > &languages) const
 Detect which languages this game instance supports. More...
 
virtual bool detectLanguages (Aurora::GameID game, const Common::UString &target, Aurora::Platform platform, std::vector< Aurora::Language > &languagesText, std::vector< Aurora::Language > &languagesVoice) const
 Detect which languages this game instance supports. More...
 
bool detectLanguages (std::vector< Aurora::Language > &languages) const
 
bool detectLanguages (std::vector< Aurora::Language > &languagesText, std::vector< Aurora::Language > &languagesVoice) const
 
virtual bool getLanguage (Aurora::Language &language) const
 Return the game's current language. More...
 
virtual bool getLanguage (Aurora::Language &languageText, Aurora::Language &languageVoice) const
 Return the game's current language. More...
 
virtual bool changeLanguage ()
 Change the game's current language. More...
 
void start (Aurora::GameID game, const Common::UString &target, Aurora::Platform platform)
 
void showFPS ()
 Evaluate the FPS display setting and show/hide the FPS display. More...
 

Protected Member Functions

virtual void run ()=0
 Run the game. More...
 
bool evaluateLanguage (bool find, Aurora::Language &language) const
 
bool evaluateLanguage (bool find, Aurora::Language &languageVoice, Aurora::Language &languageText) const
 

Protected Attributes

Aurora::GameID _game
 
Aurora::Platform _platform
 
Common::UString _target
 
Common::ScopedPtr< Console > _console
 
Common::ScopedPtr< Graphics::Aurora::FPS > _fps
 

Detailed Description

The base class for an engine within BioWare's Aurora family.

Definition at line 49 of file engine.h.

Constructor & Destructor Documentation

◆ Engine()

Engines::Engine::Engine ( )

Definition at line 39 of file engine.cpp.

◆ ~Engine()

Engines::Engine::~Engine ( )
virtual

Definition at line 42 of file engine.cpp.

Member Function Documentation

◆ changeLanguage()

bool Engines::Engine::changeLanguage ( )
virtual

Change the game's current language.

Reimplemented in Engines::Witcher::WitcherEngine, Engines::DragonAge::DragonAgeEngine, Engines::DragonAge2::DragonAge2Engine, Engines::NWN::NWNEngine, Engines::Sonic::SonicEngine, Engines::Jade::JadeEngine, Engines::KotOR::KotOREngine, Engines::NWN2::NWN2Engine, and Engines::KotOR2::KotOR2Engine.

Definition at line 77 of file engine.cpp.

Referenced by Engines::Console::cmdSetLang().

Here is the caller graph for this function:

◆ detectLanguages() [1/4]

bool Engines::Engine::detectLanguages ( Aurora::GameID  game,
const Common::UString &  target,
Aurora::Platform  platform,
std::vector< Aurora::Language > &  languages 
) const
virtual

Detect which languages this game instance supports.

Reimplemented in Engines::DragonAge::DragonAgeEngine, Engines::DragonAge2::DragonAge2Engine, Engines::NWN::NWNEngine, Engines::Sonic::SonicEngine, Engines::Jade::JadeEngine, Engines::KotOR::KotOREngine, Engines::NWN2::NWN2Engine, and Engines::KotOR2::KotOR2Engine.

Definition at line 45 of file engine.cpp.

Referenced by Engines::Console::cmdListLangs(), detectLanguages(), and evaluateLanguage().

Here is the caller graph for this function:

◆ detectLanguages() [2/4]

bool Engines::Engine::detectLanguages ( Aurora::GameID  game,
const Common::UString &  target,
Aurora::Platform  platform,
std::vector< Aurora::Language > &  languagesText,
std::vector< Aurora::Language > &  languagesVoice 
) const
virtual

Detect which languages this game instance supports.

Reimplemented in Engines::Witcher::WitcherEngine.

Definition at line 51 of file engine.cpp.

◆ detectLanguages() [3/4]

bool Engines::Engine::detectLanguages ( std::vector< Aurora::Language > &  languages) const

Definition at line 58 of file engine.cpp.

References _game, _platform, _target, and detectLanguages().

Here is the call graph for this function:

◆ detectLanguages() [4/4]

bool Engines::Engine::detectLanguages ( std::vector< Aurora::Language > &  languagesText,
std::vector< Aurora::Language > &  languagesVoice 
) const

Definition at line 62 of file engine.cpp.

References _game, _platform, _target, and detectLanguages().

Here is the call graph for this function:

◆ evaluateLanguage() [1/2]

bool Engines::Engine::evaluateLanguage ( bool  find,
Aurora::Language &  language 
) const
protected

Definition at line 198 of file engine.cpp.

References ConfigMan, detectLanguages(), Common::UString::empty(), Engines::fiddleLangChinese(), Aurora::kLanguageInvalid, LangMan, Engines::resolveLangInvalid(), Engines::resolveLangUnavailable(), status(), and warning().

Referenced by Engines::KotOR2::KotOR2Engine::changeLanguage(), Engines::Jade::JadeEngine::changeLanguage(), Engines::KotOR::KotOREngine::changeLanguage(), Engines::NWN2::NWN2Engine::changeLanguage(), Engines::Sonic::SonicEngine::changeLanguage(), Engines::DragonAge::DragonAgeEngine::changeLanguage(), Engines::NWN::NWNEngine::changeLanguage(), Engines::DragonAge2::DragonAge2Engine::changeLanguage(), Engines::Witcher::WitcherEngine::changeLanguage(), Engines::KotOR2::KotOR2Engine::init(), Engines::Jade::JadeEngine::init(), Engines::Sonic::SonicEngine::init(), Engines::NWN2::NWN2Engine::init(), Engines::KotOR::KotOREngine::init(), Engines::DragonAge2::DragonAge2Engine::init(), Engines::DragonAge::DragonAgeEngine::init(), Engines::Witcher::WitcherEngine::init(), and Engines::NWN::NWNEngine::init().

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

◆ evaluateLanguage() [2/2]

bool Engines::Engine::evaluateLanguage ( bool  find,
Aurora::Language &  languageVoice,
Aurora::Language &  languageText 
) const
protected

Definition at line 250 of file engine.cpp.

References ConfigMan, detectLanguages(), Common::UString::empty(), Engines::fiddleLangChinese(), Aurora::kLanguageInvalid, LangMan, Engines::resolveLangInvalid(), and Engines::resolveLangUnavailable().

Here is the call graph for this function:

◆ getLanguage() [1/2]

bool Engines::Engine::getLanguage ( Aurora::Language &  language) const
virtual

Return the game's current language.

Reimplemented in Engines::DragonAge::DragonAgeEngine, Engines::DragonAge2::DragonAge2Engine, Engines::NWN::NWNEngine, Engines::Sonic::SonicEngine, Engines::Jade::JadeEngine, Engines::KotOR::KotOREngine, Engines::NWN2::NWN2Engine, and Engines::KotOR2::KotOR2Engine.

Definition at line 68 of file engine.cpp.

Referenced by Engines::Console::cmdGetLang(), and Engines::Console::cmdSetLang().

Here is the caller graph for this function:

◆ getLanguage() [2/2]

bool Engines::Engine::getLanguage ( Aurora::Language &  languageText,
Aurora::Language &  languageVoice 
) const
virtual

Return the game's current language.

Reimplemented in Engines::Witcher::WitcherEngine.

Definition at line 72 of file engine.cpp.

◆ run()

virtual void Engines::Engine::run ( )
protectedpure virtual

Run the game.

Implemented in Engines::DragonAge::DragonAgeEngine, Engines::DragonAge2::DragonAge2Engine, Engines::Witcher::WitcherEngine, Engines::NWN::NWNEngine, Engines::Sonic::SonicEngine, Engines::Jade::JadeEngine, Engines::KotOR::KotOREngine, Engines::NWN2::NWN2Engine, and Engines::KotOR2::KotOR2Engine.

Referenced by start().

Here is the caller graph for this function:

◆ showFPS()

void Engines::Engine::showFPS ( )

Evaluate the FPS display setting and show/hide the FPS display.

Definition at line 91 of file engine.cpp.

References _fps, ConfigMan, FontMan, Graphics::Aurora::kSystemFontMono, and Common::ScopedPtrBase< T, Deallocator >::reset().

Referenced by Engines::Console::cmdSetOption(), Engines::Console::cmdShowFPS(), and start().

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

◆ start()

void Engines::Engine::start ( Aurora::GameID  game,
const Common::UString &  target,
Aurora::Platform  platform 
)

Definition at line 81 of file engine.cpp.

References _game, _platform, _target, run(), and showFPS().

Here is the call graph for this function:

Member Data Documentation

◆ _console

Common::ScopedPtr<Console> Engines::Engine::_console
protected

Definition at line 87 of file engine.h.

Referenced by Engines::DragonAge2::DragonAge2Engine::DragonAge2Engine(), Engines::DragonAge::DragonAgeEngine::DragonAgeEngine(), Engines::Jade::JadeEngine::JadeEngine(), Engines::KotOR2::KotOR2Engine::KotOR2Engine(), Engines::KotOR::KotOREngine::KotOREngine(), Engines::NWN2::NWN2Engine::NWN2Engine(), Engines::NWN::NWNEngine::NWNEngine(), Engines::KotOR2::KotOR2Engine::run(), Engines::KotOR::KotOREngine::run(), Engines::Jade::JadeEngine::run(), Engines::NWN2::NWN2Engine::run(), Engines::Sonic::SonicEngine::run(), Engines::NWN::NWNEngine::run(), Engines::Witcher::WitcherEngine::run(), Engines::DragonAge::DragonAgeEngine::run(), Engines::DragonAge2::DragonAge2Engine::run(), Engines::Sonic::SonicEngine::SonicEngine(), and Engines::Witcher::WitcherEngine::WitcherEngine().

◆ _fps

Common::ScopedPtr<Graphics::Aurora::FPS> Engines::Engine::_fps
protected

Definition at line 89 of file engine.h.

Referenced by showFPS().

◆ _game

Aurora::GameID Engines::Engine::_game
protected

Definition at line 83 of file engine.h.

Referenced by detectLanguages(), and start().

◆ _platform

Aurora::Platform Engines::Engine::_platform
protected

Definition at line 84 of file engine.h.

Referenced by detectLanguages(), Engines::KotOR::KotOREngine::detectVersion(), Engines::NWN::NWNEngine::detectVersion(), Engines::KotOR::KotOREngine::hasYavin4Module(), Engines::Jade::JadeEngine::init(), Engines::KotOR2::KotOR2Engine::initCursors(), Engines::KotOR::KotOREngine::initCursors(), Engines::Jade::JadeEngine::initResources(), Engines::KotOR2::KotOR2Engine::initResources(), Engines::KotOR::KotOREngine::initResources(), Engines::Jade::JadeEngine::playIntroVideos(), Engines::KotOR::KotOREngine::playIntroVideos(), Engines::KotOR2::KotOR2Engine::run(), Engines::Jade::JadeEngine::run(), and start().

◆ _target

Common::UString Engines::Engine::_target
protected

Definition at line 85 of file engine.h.

Referenced by detectLanguages(), Engines::KotOR::KotOREngine::detectVersion(), Engines::NWN::NWNEngine::detectVersion(), Engines::Jade::JadeEngine::initGameConfig(), Engines::NWN2::NWN2Engine::initGameConfig(), Engines::Witcher::WitcherEngine::initGameConfig(), Engines::KotOR::KotOREngine::initGameConfig(), Engines::NWN::NWNEngine::initGameConfig(), Engines::Jade::JadeEngine::initResources(), Engines::KotOR2::KotOR2Engine::initResources(), Engines::NWN2::NWN2Engine::initResources(), Engines::Sonic::SonicEngine::initResources(), Engines::DragonAge2::DragonAge2Engine::initResources(), Engines::DragonAge::DragonAgeEngine::initResources(), Engines::Witcher::WitcherEngine::initResources(), Engines::KotOR::KotOREngine::initResources(), Engines::NWN::NWNEngine::initResources(), and start().

The documentation for this class was generated from the following files:
Generated on Sun Nov 18 2018 15:13:51 for xoreos by   doxygen 1.8.14