ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

Wintermute::WintermuteMetaEngine Class Reference

Inheritance diagram for Wintermute::WintermuteMetaEngine:
Collaboration diagram for Wintermute::WintermuteMetaEngine:

List of all members.

Public Member Functions

 WintermuteMetaEngine ()
const char * getEngineId () const override
 Get the engine ID.
const char * getName () const override
 Returns the name of the plugin.
const char * getOriginalCopyright () const override
 Returns some copyright information about the original engine.
ADDetectedGame fallbackDetect (const FileMap &allFiles, const Common::FSList &fslist) const override
 An (optional) generic fallback detect function which is invoked if the regular MD5 based detection failed to detect anything.
bool createInstance (OSystem *syst, Engine **engine, const ADGameDescription *desc) const override
bool hasFeature (MetaEngineFeature f) const override
 Determine whether the engine supports the specified MetaEngine feature.
SaveStateList listSaves (const char *target) const override
 Return a list of all save states associated with the given target.
int getMaximumSaveSlot () const override
 Return the maximum save slot that the engine supports.
void removeSaveState (const char *target, int slot) const override
 Remove the specified save state.
SaveStateDescriptor querySaveMetaInfos (const char *target, int slot) const override
 Returns meta infos from the specified save state.
const Common::AchievementsInfo getAchievementsInfo (const Common::String &target) const override
 Return a list of achievement descriptions for the specified target.
Common::KeymapArray initKeymaps (const char *target) const override
 Return the keymap used by the target.

Detailed Description

Definition at line 91 of file detection.cpp.


Constructor & Destructor Documentation

Wintermute::WintermuteMetaEngine::WintermuteMetaEngine (  )  [inline]

Definition at line 93 of file detection.cpp.


Member Function Documentation

bool Wintermute::WintermuteMetaEngine::createInstance ( OSystem syst,
Engine **  engine,
const ADGameDescription desc 
) const [inline, override, virtual]

Implements AdvancedMetaEngine.

Definition at line 160 of file detection.cpp.

ADDetectedGame Wintermute::WintermuteMetaEngine::fallbackDetect ( const FileMap allFiles,
const Common::FSList fslist 
) const [inline, override, virtual]

An (optional) generic fallback detect function which is invoked if the regular MD5 based detection failed to detect anything.

Reimplemented from AdvancedMetaEngine.

Definition at line 114 of file detection.cpp.

const Common::AchievementsInfo Wintermute::WintermuteMetaEngine::getAchievementsInfo ( const Common::String target  )  const [inline, override, virtual]

Return a list of achievement descriptions for the specified target.

The default implementation returns an empty list.

Parameters:
target name of a config manager target
Returns:
a list of achievement descriptions for an engine plugin and target

Reimplemented from MetaEngine.

Definition at line 217 of file detection.cpp.

const char* Wintermute::WintermuteMetaEngine::getEngineId (  )  const [inline, override, virtual]

Get the engine ID.

Implements MetaEngine.

Definition at line 102 of file detection.cpp.

int Wintermute::WintermuteMetaEngine::getMaximumSaveSlot (  )  const [inline, override, virtual]

Return the maximum save slot that the engine supports.

Note:
MetaEngines must indicate that this function has been implemented via the kSupportsListSaves feature flag.

The default implementation limits the save slots to zero (0).

Returns:
maximum save slot number supported

Reimplemented from MetaEngine.

Definition at line 200 of file detection.cpp.

const char* Wintermute::WintermuteMetaEngine::getName (  )  const [inline, override, virtual]

Returns the name of the plugin.

Implements PluginObject.

Definition at line 106 of file detection.cpp.

const char* Wintermute::WintermuteMetaEngine::getOriginalCopyright (  )  const [inline, override, virtual]

Returns some copyright information about the original engine.

Implements MetaEngine.

Definition at line 110 of file detection.cpp.

bool Wintermute::WintermuteMetaEngine::hasFeature ( MetaEngineFeature  f  )  const [inline, override, virtual]

Determine whether the engine supports the specified MetaEngine feature.

Used by e.g. the launcher to determine whether to enable the "Load" button.

Reimplemented from MetaEngine.

Definition at line 168 of file detection.cpp.

Common::KeymapArray Wintermute::WintermuteMetaEngine::initKeymaps ( const char *  target  )  const [inline, override, virtual]

Return the keymap used by the target.

Reimplemented from MetaEngine.

Definition at line 245 of file detection.cpp.

SaveStateList Wintermute::WintermuteMetaEngine::listSaves ( const char *  target  )  const [inline, override, virtual]

Return a list of all save states associated with the given target.

The returned list is guaranteed to be sorted by slot numbers. That means smaller slot numbers are always stored before bigger slot numbers.

The caller has to ensure that this (Meta)Engine is responsible for the specified target (by using findGame on it respectively on the associated gameid from the relevant ConfMan entry, if present).

The default implementation returns an empty list.

Note:
MetaEngines must indicate that this function has been implemented via the kSupportsListSaves feature flag.
Parameters:
target name of a config manager target
Returns:
a list of save state descriptors

Reimplemented from MetaEngine.

Definition at line 187 of file detection.cpp.

SaveStateDescriptor Wintermute::WintermuteMetaEngine::querySaveMetaInfos ( const char *  target,
int  slot 
) const [inline, override, virtual]

Returns meta infos from the specified save state.

Depending on the MetaEngineFeatures set this can include thumbnails, save date / time, play time.

Parameters:
target name of a config manager target
slot slot number of the save state

Reimplemented from MetaEngine.

Definition at line 209 of file detection.cpp.

void Wintermute::WintermuteMetaEngine::removeSaveState ( const char *  target,
int  slot 
) const [inline, override, virtual]

Remove the specified save state.

For most engines this just amounts to calling _saveFileMan->removeSaveFile(). Engines which keep an index file will also update it accordingly.

Note:
MetaEngines must indicate that this function has been implemented via the kSupportsDeleteSave feature flag.
Parameters:
target name of a config manager target
slot slot number of the save state to be removed

Reimplemented from MetaEngine.

Definition at line 204 of file detection.cpp.


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


Generated on Sat Aug 8 2020 05:04:08 for ResidualVM by doxygen 1.7.1
curved edge   curved edge