[Scummvm-cvs-logs] SF.net SVN: scummvm:[34260] scummvm/trunk/engines/metaengine.h

fingolfin at users.sourceforge.net fingolfin at users.sourceforge.net
Mon Sep 1 22:31:44 CEST 2008


Revision: 34260
          http://scummvm.svn.sourceforge.net/scummvm/?rev=34260&view=rev
Author:   fingolfin
Date:     2008-09-01 20:31:44 +0000 (Mon, 01 Sep 2008)

Log Message:
-----------
Clarified some comments

Modified Paths:
--------------
    scummvm/trunk/engines/metaengine.h

Modified: scummvm/trunk/engines/metaengine.h
===================================================================
--- scummvm/trunk/engines/metaengine.h	2008-09-01 20:23:25 UTC (rev 34259)
+++ scummvm/trunk/engines/metaengine.h	2008-09-01 20:31:44 UTC (rev 34260)
@@ -79,9 +79,9 @@
 	/**
 	 * 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 @@
 	/**
 	 * 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,23 +109,24 @@
 	
 	/**
 	 * 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,
-		kSupportsListSaves 	= 1,
-		kSupportsDirectLoad 	= 2,
-		kSupportsDeleteSave 	= 3
+		kSupportsRTL            = 0,
+		kSupportsListSaves      = 1,
+		kSupportsDirectLoad     = 2,
+		kSupportsDeleteSave     = 3
 	};	
 
 	/**
-	 * 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; };
 


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.




More information about the Scummvm-git-logs mailing list