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

◆ detectLanguages() [1/4]

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

◆ 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

◆ evaluateLanguage() [2/2]

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

◆ getLanguage() [1/2]

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

◆ 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

◆ 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

◆ _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

◆ _target

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

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