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

Stark::StarkMetaEngine Class Reference

Inheritance diagram for Stark::StarkMetaEngine:
Collaboration diagram for Stark::StarkMetaEngine:

List of all members.

Public Member Functions

 StarkMetaEngine ()
const char * getName () const override
 Returns the name of the plugin.
const char * getOriginalCopyright () const override
 Returns some copyright information about the original engine.
bool hasFeature (MetaEngineFeature f) const override
 Determine whether the engine supports the specified MetaEngine feature.
int getMaximumSaveSlot () const override
 Return the maximum save slot that the engine supports.
SaveStateList listSaves (const char *target) const override
 Return a list of all save states associated with the given target.
SaveStateDescriptor querySaveMetaInfos (const char *target, int slot) const override
 Returns meta infos from the specified save state.
void removeSaveState (const char *target, int slot) const override
 Remove the specified save state.
bool createInstance (OSystem *syst, Engine **engine, const ADGameDescription *desc) const override

Detailed Description

Definition at line 374 of file detection.cpp.


Constructor & Destructor Documentation

Stark::StarkMetaEngine::StarkMetaEngine (  )  [inline]

Definition at line 376 of file detection.cpp.


Member Function Documentation

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

Implements AdvancedMetaEngine.

Definition at line 466 of file detection.cpp.

int Stark::StarkMetaEngine::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 400 of file detection.cpp.

const char* Stark::StarkMetaEngine::getName (  )  const [inline, override, virtual]

Returns the name of the plugin.

Implements PluginObject.

Definition at line 381 of file detection.cpp.

const char* Stark::StarkMetaEngine::getOriginalCopyright (  )  const [inline, override, virtual]

Returns some copyright information about the original engine.

Implements MetaEngine.

Definition at line 385 of file detection.cpp.

bool Stark::StarkMetaEngine::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 389 of file detection.cpp.

SaveStateList Stark::StarkMetaEngine::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 404 of file detection.cpp.

SaveStateDescriptor Stark::StarkMetaEngine::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 426 of file detection.cpp.

void Stark::StarkMetaEngine::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 461 of file detection.cpp.


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


Generated on Sat Sep 14 2019 05:04:52 for ResidualVM by doxygen 1.7.1
curved edge   curved edge