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

[lordhoto at users.sourceforge.net]

Revision: 34971
          http://scummvm.svn.sourceforge.net/scummvm/?rev=34971&view=rev
Author:   lordhoto
Date:     2008-11-09 20:08:54 +0000 (Sun, 09 Nov 2008)

Log Message:
-----------
Update documentation.

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

Modified: scummvm/trunk/engines/metaengine.h
===================================================================
--- scummvm/trunk/engines/metaengine.h	2008-11-09 20:07:46 UTC (rev 34970)
+++ scummvm/trunk/engines/metaengine.h	2008-11-09 20:08:54 UTC (rev 34971)
@@ -167,7 +167,17 @@
 
 		/**
 		 * Features meta infos for savestates (i.e. implements the
-		 * querySaveMetaInfos method properly)
+		 * querySaveMetaInfos method properly).
+		 *
+		 * Engines implementing meta infos always have to provide
+		 * the following entries in the save state descriptor queried
+		 * by querySaveMetaInfos:
+		 * - 'is_deletable', which indicates if a given save is
+		 *                   safe for deletion
+		 * - 'is_write_protected', which indicates if a given save
+		 *                         can be overwritten by the user.
+		 *                         (note: of course you do not have to
+		 *                         set this, since it defaults to 'false')
 		 */
 		kSavesSupportMetaInfo,
 


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