libretro/scummvm
1
0
Fork 0
mirror of https://github.com/libretro/scummvm.git synced 2025-01-22 01:57:16 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Clarified some comments

Browse Source 
svn-id: r34260
This commit is contained in:
Max Horn 2008-09-01 20:31:44 +00:00
parent 2f884b4f25
commit 898a7f4b2d
1 changed files with 16 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
engines/metaengine.h
View File

@ -79,9 +79,9 @@ public:
/**
* Return a list of all save states associated with the given target.
*
* In general, the caller will already have ensured that this (Meta)Engine
* is responsible for the specified target by using findGame on it resp.
* on the associated gameid from the relevant ConfMan entry, if present.
* 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.
*
@ -95,7 +95,7 @@ public:
/**
* Remove the specified save state.
*
* For most engines this just involves a call removeSaveFile().
* For most engines this just amounts to calling _saveFileMan->removeSaveFile().
* Engines which keep an index file will also update it accordingly.
*
* @param slot slot number of the save state to be removed
@ -109,13 +109,13 @@ public:
/**
* A feature in this context means an ability of the engine which can be
* either on or off. Examples include:
* - Listing Save States (--list-saves)
* either available or not. Examples include:
* - Supporting the 'Return to launcher' feature (i.e. handles EVENT_RTL)
* - Listing Save States (i.e. implements the listSaves() method;
* used for --list-saves support)
* - Loading from the Launcher (-x)
* - Deleting Saves from the Launcher
*
* These determine whether the features will be available to the engine
* in the launcher.
* - Deleting Saves from the Launcher (i.e. implements the
* removeSaveState() method)
*/
enum MetaEngineFeature {
kSupportsRTL = 0,
@ -125,7 +125,8 @@ public:
};
/**
* Determine whether the engine supports the specified MetaEngine feature
* Determine whether the engine supports the specified MetaEngine feature.
* Used by e.g. the launcher to determine whether to enable the "Load" button.
*/
virtual bool hasFeature(MetaEngineFeature f) const { return false; };