Ticket #2030: saveAsv2.patch

binaries/data/mods/public/gui/savedgames/load.js

@@ -14 +14 @@
 
     var date = t.getFullYear()+"-"+twoDigits(1+t.getMonth())+"-"+twoDigits(t.getDate());
     var time = twoDigits(t.getHours())+":"+twoDigits(t.getMinutes())+":"+twoDigits(t.getSeconds());
-    return "["+date+" "+time+"] "+metadata.initAttributes.map;
+    return "["+date+" "+time+"] "+metadata.initAttributes.map+"\n"+(metadata.description?metadata.description:"");
 }
 
 function init()

binaries/data/mods/public/gui/savedgames/load.xml

@@ -8 +8 @@
     <!-- Add a translucent black background to fade out the menu page -->
     <object type="image" z="0" sprite="BackgroundTranslucent"/>
 
-    <object type="image" style="StoneDialog" size="50%-190 50%-200 50%+190 50%+200">
+    <object type="image" style="StoneDialog" size="50%-300 50%-200 50%+300 50%+200">
 
         <object type="text" style="TitleText" size="50%-128 0%-16 50%+128 16">
             Load Game

binaries/data/mods/public/gui/session/menu.js

@@ -167 +167 @@
 // Menu functions
 // =============================================================================
 
+function openSave(pause)
+{
+    getGUIObjectByName("saveGamePanel").hidden = false;
+    savePanelInit();
+    if (pause)
+        pauseGame();
+}
+
+function closeSave(resume)
+{
+    getGUIObjectByName("saveGamePanel").hidden = true;
+    if (resume)
+        resumeGame();
+}
+
 function openSettings(pause)
 {
     getGUIObjectByName("settingsDialogPanel").hidden = false;
@@ -434 +449 @@
     return "Tribute " + amount + " " + resource + " to [color=\"" + playerColor + "\"]" + player.name +
         "[/color]. Shift-click to tribute " + (amount < 500 ? 500 : amount + 500) + ".";
 }
+
+var descriptions;
+
+function sortDecreasingDate(a, b)
+{
+    return b.metadata.time - a.metadata.time;
+}
+
+function twoDigits(n)
+{
+    return n < 10 ? "0" + n : n;
+}
+
+function generateLabel(metadata)
+{
+    var t = new Date(metadata.time*1000);
+
+    var date = t.getFullYear()+"-"+twoDigits(1+t.getMonth())+"-"+twoDigits(t.getDate());
+    var time = twoDigits(t.getHours())+":"+twoDigits(t.getMinutes())+":"+twoDigits(t.getSeconds());
+    return "["+date+" "+time+"] "+metadata.initAttributes.map+"\n"+(metadata.description?metadata.description:"");
+}
+
+function selectDescription()
+{
+    var gameSelection = getGUIObjectByName("gameSelection");
+    if(gameSelection.selected != -1)
+    {
+        
+        getGUIObjectByName("deleteGameButton").enabled = true;
+        var gameID = gameSelection.list_data[gameSelection.selected];
+        getGUIObjectByName("saveGameDesc").caption = descriptions[gameID];
+    }
+}
+
+function savePanelInit()
+{
+    var savedGames = Engine.GetSavedGames();
+
+    var gameSelection = getGUIObjectByName("gameSelection");
+
+    getGUIObjectByName("deleteGameButton").enabled = false;
+    
+    if (savedGames.length == 0)
+    {
+        gameSelection.list = [ "No saved games found" ];
+        gameSelection.selected = -1;
+        return;
+    }
+
+    savedGames.sort(sortDecreasingDate);
+
+    var gameListIDs = [ game.id for each (game in savedGames) ];
+    var gameListLabels = [ generateLabel(game.metadata) for each (game in savedGames) ];
+    
+    descriptions = new Array();
+    [ descriptions[game.id] = (game.metadata.description?game.metadata.description:"none") for each (game in savedGames) ];
+    
+    gameSelection.list = gameListLabels;
+    gameSelection.list_data = gameListIDs;
+    gameSelection.selected = -1;
+}
+
+function saveGame()
+{
+    var gameSelection = getGUIObjectByName("gameSelection");
+    var gameID = gameSelection.list_data[gameSelection.selected];
+    var desc = getGUIObjectByName("saveGameDesc").caption;
+    Engine.SaveGame(gameID?gameID:"savegame",desc,gameSelection.selected != -1);
+    savePanelInit();
+}
+
+function deleteGame()
+{
+    var gameSelection = getGUIObjectByName("gameSelection");
+    var gameLabel = gameSelection.list[gameSelection.selected];
+    var gameID = gameSelection.list_data[gameSelection.selected];
+
+    // Ask for confirmation
+    var btCaptions = ["Yes", "No"];
+    var btCode = [function(){ reallyDeleteGame(gameID); }, null];
+    messageBox(500, 200, "\""+gameLabel+"\"\nSaved game will be permanently deleted, are you sure?", "DELETE", 0, btCaptions, btCode);
+}
+
+function reallyDeleteGame(gameID)
+{
+    if (!Engine.DeleteSavedGame(gameID))
+    {
+        error("Could not delete saved game '"+gameID+"'");
+    }
+
+    // Run init again to refresh saved game list
+    savePanelInit();
+}

binaries/data/mods/public/gui/session/session.xml

@@ -17 +17 @@
     <script file="gui/session/messages.js"/>
     <script file="gui/session/utility_functions.js"/>
 
+
+
     <object name="sn" hotkey="session.gui.toggle">
     <action on="Tick">
         onTick();
@@ -427 +429 @@
     </object>
 
     <!-- ================================  ================================ -->
+    <!-- Save Window -->
+    <!-- ================================  ================================ -->
+    <object name="saveGamePanel" type="image" style="StoneDialog" size="50%-300 50%-200 50%+300 50%+200" hidden="true">
+        <object type="image" z="0" sprite="BackgroundTranslucent"/>
+        <object type="text" style="TitleText" size="50%-128 0%-16 50%+128 16">
+            Save Game
+        </object>
+
+        <object name="gameSelection"
+            style="StoneList"
+            type="list"
+            
+            size="24 24 100%-24 100%-124">
+            <action on="selectionchange">
+                selectDescription();
+            </action>
+        </object>
+
+        
+        <object size="24 100%-124 100%-24 100%-100" name="descLabel" type="text" style="LeftLabelText">Description:</object>
+
+        <object name="saveGameDesc" size="24 100%-96 100%-24 100%-72" type="input" style="StoneInput" max_length="80">
+            quick save
+        </object>
+        
+        <object name="saveButton" type="button" size="0%+25 100%-60 33%+10 100%-32" style="StoneButton">
+            Save
+            <action on="Press">saveGame();closeSave(true);</action>
+        </object>
+
+        <object name="deleteGameButton" type="button" size="33%+20 100%-60 66%-15 100%-32" style="StoneButton">
+            Delete
+            <action on="Press">deleteGame();</action>
+        </object>
+
+        <object type="button" style="StoneButton" size="66%-5 100%-60 100%-25 100%-32">
+            Cancel
+            <action on="Press">closeSave(true);</action>
+        </object>
+
+    </object>
+
+    <!-- ================================  ================================ -->
     <!-- Settings Window -->
     <!-- ================================  ================================ -->
         <object name="settingsDialogPanel"
@@ -702 +747 @@
         >
             Save
             <action on="Press">
-            Engine.SaveGame();
             closeMenu();
+            openSave(true);
             </action>
         </object>
 

source/gui/scripting/ScriptFunctions.cpp

@@ -258 +258 @@
     return metadata.get();
 }
 
-void SaveGame(void* cbdata)
+void SaveGame(void* cbdata, std::wstring givenname, std::wstring description, bool overwrite)
 {
     CGUIManager* guiManager = static_cast<CGUIManager*> (cbdata);
 
-    if (SavedGames::Save(L"quicksave", *g_Game->GetSimulation2(), guiManager, g_Game->GetPlayerID()) < 0)
+    if (SavedGames::Save(givenname, description, overwrite, *g_Game->GetSimulation2(), guiManager, g_Game->GetPlayerID()) < 0)
         LOGERROR(L"Failed to save game");
 }
 
@@ -669 +669 @@
     scriptInterface.RegisterFunction<CScriptVal, std::wstring, &StartSavedGame>("StartSavedGame");
     scriptInterface.RegisterFunction<std::vector<CScriptValRooted>, &GetSavedGames>("GetSavedGames");
     scriptInterface.RegisterFunction<bool, std::wstring, &DeleteSavedGame>("DeleteSavedGame");
-    scriptInterface.RegisterFunction<void, &SaveGame>("SaveGame");
+    scriptInterface.RegisterFunction<void, std::wstring, std::wstring, bool, &SaveGame>("SaveGame");
     scriptInterface.RegisterFunction<void, &QuickSave>("QuickSave");
     scriptInterface.RegisterFunction<void, &QuickLoad>("QuickLoad");
 

source/ps/SavedGame.cpp

@@ -31 +31 @@
 static const int SAVED_GAME_VERSION_MINOR = 0; // increment on compatible changes to the format
 // TODO: we ought to check version numbers when loading files
 
-Status SavedGames::Save(const std::wstring& prefix, CSimulation2& simulation, CGUIManager* gui, int playerID)
+Status SavedGames::Save(const std::wstring& givenname, const std::wstring& description, bool overwrite, CSimulation2& simulation, CGUIManager* gui, int playerID)
 {
     // Determine the filename to save under
-    const VfsPath basenameFormat(L"saves/" + prefix + L"-%04d");
+    const VfsPath basenameFormat(L"saves/" + givenname + (overwrite?L"":L"-%04d"));
     const VfsPath filenameFormat = basenameFormat.ChangeExtension(L".0adsave");
     VfsPath filename;
 
-    // Don't make this a static global like NextNumberedFilename expects, because
-    // that wouldn't work when 'prefix' changes, and because it's not thread-safe
-    size_t nextSaveNumber = 0;
-    vfs::NextNumberedFilename(g_VFS, filenameFormat, nextSaveNumber, filename);
-
+    if(!overwrite)
+    {
+        // Don't make this a static global like NextNumberedFilename expects, because
+        // that wouldn't work when 'prefix' changes, and because it's not thread-safe
+        size_t nextSaveNumber = 0;
+        vfs::NextNumberedFilename(g_VFS, filenameFormat, nextSaveNumber, filename);
+    }
+    else
+    {
+        filename = filenameFormat.string().c_str();
+    }
     // ArchiveWriter_Zip can only write to OsPaths, not VfsPaths,
     // but we'd like to handle saved games via VFS.
     // To avoid potential confusion from writing with non-VFS then
@@ -74 +80 @@
         CScriptVal guiMetadata = simulation.GetScriptInterface().CloneValueFromOtherContext(gui->GetScriptInterface(), gui->GetSavedGameData().get());
         simulation.GetScriptInterface().SetProperty(metadata.get(), "gui", guiMetadata);
     }
+    simulation.GetScriptInterface().SetProperty(metadata.get(), "description", description);
     
     std::string metadataString = simulation.GetScriptInterface().StringifyJSON(metadata.get(), true);
     

source/ps/SavedGame.h

@@ -41 +41 @@
 /**
  * Create new saved game archive with given prefix and simulation data
  *
- * @param prefix Create new numbered file starting with this prefix
+ * @param givenname Name to save the game with; can be used as a prefix depending
+ *  on the overwrite bool.
+ * @param description A user-given description of the save
+ * @param overwrite if true, overwrite given filename, otherwise consider
+ *  filename a prefix
  * @param simulation
  * @param gui if not NULL, store some UI-related data with the saved game
  * @param playerID ID of the player who saved this file
  * @return INFO::OK if successfully saved, else an error Status
  */
-Status Save(const std::wstring& prefix, CSimulation2& simulation, CGUIManager* gui, int playerID);
+Status Save(const std::wstring& givenname, const std::wstring& description, bool overwrite, CSimulation2& simulation, CGUIManager* gui, int playerID);
 
 /**
  * Load saved game archive with the given name