Engines::EngineProbe Class Reference

A probe able to detect one specific game. More...

#include <engineprobe.h>

Inheritance diagram for Engines::EngineProbe:

Collaboration diagram for Engines::EngineProbe:

Public Member Functions
virtual	~EngineProbe ()
virtual Aurora::GameID	getGameID () const =0
	Get the GameID that the probe is able to detect. More...
virtual Aurora::Platform	getPlatform () const =0
	Get the Platform that the probe is able to detect. More...
virtual const Common::UString &	getGameName () const =0
	Return a string of the full game name. More...
virtual bool	probe (const Common::UString &directory, const Common::FileList &rootFiles) const =0
	Check for the game in that directory, containing these files. More...
virtual bool	probe (Common::SeekableReadStream &stream) const =0
	Check for the game in that file. More...
virtual Engine *	createEngine () const =0
	Create the respective engine for the GameID. More...

Detailed Description

A probe able to detect one specific game.

Definition at line 44 of file engineprobe.h.

Constructor & Destructor Documentation

~EngineProbe()

virtual Engines::EngineProbe::~EngineProbe ( )

inlinevirtual

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

Definition at line 46 of file engineprobe.h.

Member Function Documentation

createEngine()

virtual Engine* Engines::EngineProbe::createEngine ( ) const

pure virtual

Create the respective engine for the GameID.

Implemented in Engines::Sonic::EngineProbe, Engines::KotOR::EngineProbe, Engines::KotOR2::EngineProbe, Engines::NWN::EngineProbe, Engines::Witcher::EngineProbe, Engines::Jade::EngineProbe, Engines::DragonAge::EngineProbe, Engines::DragonAge2::EngineProbe, and Engines::NWN2::EngineProbe.

Referenced by Engines::GameInstanceEngine::createEngine().

Here is the caller graph for this function:

getGameID()

virtual Aurora::GameID Engines::EngineProbe::getGameID ( ) const

pure virtual

Get the GameID that the probe is able to detect.

Implemented in Engines::Sonic::EngineProbe, Engines::DragonAge::EngineProbe, Engines::KotOR::EngineProbe, Engines::KotOR2::EngineProbe, Engines::NWN::EngineProbe, Engines::Witcher::EngineProbe, Engines::DragonAge2::EngineProbe, Engines::Jade::EngineProbe, and Engines::NWN2::EngineProbe.

Referenced by Engines::GameInstanceEngine::listLanguages(), and Engines::GameInstanceEngine::run().

Here is the caller graph for this function:

getGameName()

virtual const Common::UString& Engines::EngineProbe::getGameName ( ) const

pure virtual

Return a string of the full game name.

Implemented in Engines::Sonic::EngineProbe, Engines::DragonAge::EngineProbe, Engines::KotOR::EngineProbe, Engines::KotOR2::EngineProbe, Engines::NWN::EngineProbe, Engines::Witcher::EngineProbe, Engines::DragonAge2::EngineProbe, Engines::Jade::EngineProbe, and Engines::NWN2::EngineProbe.

Referenced by Engines::GameInstanceEngine::getGameName().

Here is the caller graph for this function:

getPlatform()

virtual Aurora::Platform Engines::EngineProbe::getPlatform ( ) const

pure virtual

Get the Platform that the probe is able to detect.

Implemented in Engines::KotOR2::EngineProbeXbox, Engines::KotOR::EngineProbeAndroid, Engines::NWN::EngineProbeFallback, Engines::KotOR2::EngineProbeMac, Engines::KotOR::EngineProbeXbox, Engines::Jade::EngineProbeAndroid, Engines::NWN::EngineProbeLinux, Engines::Jade::EngineProbeXbox, Engines::KotOR::EngineProbeMac, Engines::KotOR2::EngineProbeLinux, Engines::NWN::EngineProbeMac, Engines::DragonAge::EngineProbeXbox360, Engines::KotOR::EngineProbeWindows, Engines::KotOR2::EngineProbeWindows, Engines::NWN::EngineProbeWindows, Engines::Jade::EngineProbeWindows, Engines::DragonAge::EngineProbeWindows, Engines::DragonAge2::EngineProbeWindows, Engines::NWN2::EngineProbe, Engines::Sonic::EngineProbe, and Engines::Witcher::EngineProbe.

Referenced by Engines::GameInstanceEngine::getGameName(), Engines::GameInstanceEngine::listLanguages(), and Engines::GameInstanceEngine::run().

Here is the caller graph for this function:

probe() [1/2]

virtual bool Engines::EngineProbe::probe ( const Common::UString &  directory, const Common::FileList &  rootFiles  ) const

pure virtual

Check for the game in that directory, containing these files.

Implemented in Engines::KotOR2::EngineProbeXbox, Engines::KotOR::EngineProbeAndroid, Engines::NWN::EngineProbeFallback, Engines::KotOR2::EngineProbeMac, Engines::KotOR::EngineProbeXbox, Engines::Jade::EngineProbeAndroid, Engines::NWN::EngineProbeLinux, Engines::Jade::EngineProbeXbox, Engines::KotOR::EngineProbeMac, Engines::KotOR2::EngineProbeLinux, Engines::NWN::EngineProbeMac, Engines::DragonAge::EngineProbeXbox360, Engines::DragonAge2::EngineProbeWindowsOrigin, Engines::KotOR::EngineProbeWindows, Engines::KotOR2::EngineProbeWindows, Engines::NWN::EngineProbeWindows, Engines::Jade::EngineProbeWindows, Engines::DragonAge2::EngineProbeWindowsRetail, Engines::DragonAge::EngineProbeWindows, Engines::Witcher::EngineProbe, Engines::NWN2::EngineProbe, and Engines::Sonic::EngineProbe.

probe() [2/2]

virtual bool Engines::EngineProbe::probe ( Common::SeekableReadStream &  stream ) const

pure virtual

Check for the game in that file.

Implemented in Engines::Sonic::EngineProbe, Engines::Witcher::EngineProbe, Engines::NWN2::EngineProbe, Engines::DragonAge::EngineProbe, Engines::DragonAge2::EngineProbe, Engines::KotOR::EngineProbe, Engines::KotOR2::EngineProbe, Engines::NWN::EngineProbe, and Engines::Jade::EngineProbe.

---

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

• src/engines/engineprobe.h