xoreos  0.0.5
Public Member Functions | Static Private Attributes | List of all members
Engines::Sonic::EngineProbe Class Reference
Inheritance diagram for Engines::Sonic::EngineProbe:
Inheritance graph
[legend]
Collaboration diagram for Engines::Sonic::EngineProbe:
Collaboration graph
[legend]

Public Member Functions

 EngineProbe ()
 
 ~EngineProbe ()
 
Aurora::GameID getGameID () const
 Get the GameID that the probe is able to detect. More...
 
const Common::UStringgetGameName () const
 Return a string of the full game name. More...
 
Aurora::Platform getPlatform () const
 Get the Platform that the probe is able to detect. More...
 
Engines::EnginecreateEngine () const
 Create the respective engine for the GameID. More...
 
bool probe (const Common::UString &directory, const Common::FileList &rootFiles) const
 Check for the game in that directory, containing these files. More...
 
bool probe (Common::SeekableReadStream &stream) const
 Check for the game in that file. More...
 

Static Private Attributes

static const Common::UString kGameName = "Sonic Chronicles: The Dark Brotherhood"
 

Detailed Description

Definition at line 39 of file probes.cpp.

Constructor & Destructor Documentation

◆ EngineProbe()

Engines::Sonic::EngineProbe::EngineProbe ( )
inline

Definition at line 44 of file probes.cpp.

◆ ~EngineProbe()

Engines::Sonic::EngineProbe::~EngineProbe ( )
inlinevirtual

Reimplemented from Engines::EngineProbe.

Definition at line 45 of file probes.cpp.

Member Function Documentation

◆ createEngine()

Engines::Engine* Engines::Sonic::EngineProbe::createEngine ( ) const
inlinevirtual

Create the respective engine for the GameID.

Implements Engines::EngineProbe.

Definition at line 59 of file probes.cpp.

◆ getGameID()

Aurora::GameID Engines::Sonic::EngineProbe::getGameID ( ) const
inlinevirtual

Get the GameID that the probe is able to detect.

Implements Engines::EngineProbe.

Definition at line 47 of file probes.cpp.

References Aurora::kGameIDSonic.

◆ getGameName()

const Common::UString& Engines::Sonic::EngineProbe::getGameName ( ) const
inlinevirtual

Return a string of the full game name.

Implements Engines::EngineProbe.

Definition at line 51 of file probes.cpp.

References kGameName.

◆ getPlatform()

Aurora::Platform Engines::Sonic::EngineProbe::getPlatform ( ) const
inlinevirtual

Get the Platform that the probe is able to detect.

Implements Engines::EngineProbe.

Definition at line 55 of file probes.cpp.

References Aurora::kPlatformNDS.

◆ probe() [1/2]

bool Engines::Sonic::EngineProbe::probe ( const Common::UString directory,
const Common::FileList rootFiles 
) const
inlinevirtual

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

Implements Engines::EngineProbe.

Definition at line 63 of file probes.cpp.

◆ probe() [2/2]

bool Engines::Sonic::EngineProbe::probe ( Common::SeekableReadStream stream) const
inlinevirtual

Check for the game in that file.

Implements Engines::EngineProbe.

Definition at line 67 of file probes.cpp.

References Aurora::NDSFile::isNDS().

Here is the call graph for this function:

Member Data Documentation

◆ kGameName

const Common::UString Engines::Sonic::EngineProbe::kGameName = "Sonic Chronicles: The Dark Brotherhood"
staticprivate

Definition at line 41 of file probes.cpp.

Referenced by getGameName().


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