aboutsummaryrefslogtreecommitdiff
path: root/engines/metaengine.h
diff options
context:
space:
mode:
authorMax Horn2008-10-04 13:09:01 +0000
committerMax Horn2008-10-04 13:09:01 +0000
commitb41cd58cee80ae682d6806fc448ca6772fd8ef61 (patch)
treebbde0b7da9b77fb704c454c0592fe27f2a825f75 /engines/metaengine.h
parent8706081b82f54dae944f3b75639415330c2cdef2 (diff)
downloadscummvm-rg350-b41cd58cee80ae682d6806fc448ca6772fd8ef61.tar.gz
scummvm-rg350-b41cd58cee80ae682d6806fc448ca6772fd8ef61.tar.bz2
scummvm-rg350-b41cd58cee80ae682d6806fc448ca6772fd8ef61.zip
Renamed some MetaEngine feature flags; removed explicit numbers from this feature flag list (nothing should rely on their specific values, anyway); added a note that Engine::hasFeature should become independant of MetaEngine::hasFeature
svn-id: r34738
Diffstat (limited to 'engines/metaengine.h')
-rw-r--r--engines/metaengine.h41
1 files changed, 26 insertions, 15 deletions
diff --git a/engines/metaengine.h b/engines/metaengine.h
index fc75344f00..542cee683b 100644
--- a/engines/metaengine.h
+++ b/engines/metaengine.h
@@ -88,6 +88,9 @@ public:
*
* The default implementation returns an empty list.
*
+ * @note MetaEngines must indicate that this function has been implemented
+ * via the kSupportsListSaves feature flag.
+ *
* @param target name of a config manager target
* @return a list of save state descriptors
*/
@@ -101,6 +104,9 @@ public:
* 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.
+ *
* @param target name of a config manager target
* @param slot slot number of the save state to be removed
*/
@@ -127,52 +133,57 @@ public:
* either available or not.
*/
enum MetaEngineFeature {
- /** 'Return to launcher' feature (i.e. EVENT_RTL is handled) */
- kSupportsRTL = 0,
+ /**
+ * 'Return to launcher' feature is supported, i.e., EVENT_RTL is handled-
+ */
+ kSupportsRTL,
/**
- * Listing Save States (i.e. implements the listSaves() method;
- * used for --list-saves support)
+ * Listing all Save States for a given target is supported, i.e.,
+ * the listSaves() method is implemented.
+ * Used for --list-saves support, as well as the GMM load dialog.
*/
- kSupportsListSaves = 1,
+ kSupportsListSaves,
- /** Loading from the Launcher / command line (-x) */
- kSupportsDirectLoad = 2,
+ /**
+ * Loading from the Launcher / command line (-x)
+ */
+ kSupportsDirectLoad,
/**
* Deleting Saves from the Launcher (i.e. implements the
* removeSaveState() method)
*/
- kSupportsDeleteSave = 3,
+ kSupportsDeleteSave,
/**
* Features meta infos for savestates (i.e. implements the
* querySaveMetaInfos method properly)
*/
- kSupportsMetaInfos = 4,
+ kSavesSupportMetaInfo,
/**
* Features a thumbnail in savegames (i.e. includes a thumbnail
* in savestates returned via querySaveMetaInfo).
- * This flag may only be set when 'kSupportsMetaInfos' is set.
+ * This flag may only be set when 'kSavesSupportMetaInfo' is set.
*/
- kSupportsThumbnails = 5,
+ kSavesSupportThumbnail,
/**
* Features 'save_date' and 'save_time' entries in the
* savestate returned by querySaveMetaInfo. Those values
* indicate the date/time the savegame was created.
- * This flag may only be set when 'kSupportsMetaInfos' is set.
+ * This flag may only be set when 'kSavesSupportMetaInfo' is set.
*/
- kSupportsSaveDate = 6,
+ kSavesSupportCreationDate,
/**
* Features 'play_time' entry in the savestate returned by
* querySaveMetaInfo. It indicates how long the user played
* the game till the save.
- * This flag may only be set when 'kSupportsMetaInfos' is set.
+ * This flag may only be set when 'kSavesSupportMetaInfo' is set.
*/
- kSupportsSavePlayTime = 7
+ kSavesSupportPlayTime
};
/**