Ticket #2963: preserveGameAttributes.2.patch

binaries/data/config/default.cfg

@@ -32 +32 @@
 ; Pause the game on window focus loss (Only applicable to single player mode)
 pauseonfocusloss = true
 
+; Persist settings after leaving the game setup screen
+persistmatchsettings = true
+
 ; Default player name to use in multiplayer
 ; playername = "anonymous"
 

binaries/data/mods/public/gui/gamesetup/gamesetup.js

@@ -401 +401 @@
         // to allow easy keyboard selection of maps
         Engine.GetGUIObjectByName("mapSelection").focus();
     }
-    // Sync g_GameAttributes to everyone.
+
     if (g_IsController)
+    {
+        loadGameAttributesFromUserCfg();
+        // Sync g_GameAttributes to everyone.
         updateGameAttributes();
+    }
 }
 
 function handleNetMessage(message)
@@ -688 +692 @@
     return g_MapData[name];
 }
 
+const FILEPATH_MATCHSETTINGS_SP = "config/matchsettings.json";
+const FILEPATH_MATCHSETTINGS_MP = "config/matchsettings.mp.json";
+function loadGameAttributesFromUserCfg()
+{
+    if (Engine.ConfigDB_GetValue("user", "persistmatchsettings") != "true")
+        return;
+
+    var settingsFile = g_IsNetworked ? FILEPATH_MATCHSETTINGS_MP : FILEPATH_MATCHSETTINGS_SP;
+    if (!Engine.FileExists(settingsFile))
+        return;
+
+    var attrs = Engine.ReadJSONFile(settingsFile);
+    if (!attrs || !attrs.settings)
+        return;
+
+    g_IsInGuiUpdate = true;
+
+    var mapName = attrs.map || "";
+    var mapSettings = attrs.settings;
+
+    // Assign new seeds and match id
+    attrs.matchID = Engine.GetMatchID();
+    mapSettings.Seed = Math.floor(Math.random() * 65536);
+    mapSettings.AISeed = Math.floor(Math.random() * 65536);
+
+    // TODO: Check new attributes for being semantically correct.
+    g_GameAttributes = attrs;
+
+    var mapFilterSelection = Engine.GetGUIObjectByName("mapFilterSelection");
+    mapFilterSelection.selected = mapFilterSelection.list_data.indexOf(attrs.mapFilter);
+
+    var mapTypeSelection = Engine.GetGUIObjectByName("mapTypeSelection");
+    mapTypeSelection.selected = mapTypeSelection.list_data.indexOf(attrs.mapType);
+
+    initMapNameList();
+
+    var mapSelectionBox = Engine.GetGUIObjectByName("mapSelection");
+    mapSelectionBox.selected = mapSelectionBox.list_data.indexOf(mapName);
+
+    if (mapSettings.PopulationCap)
+    {
+        var populationCapBox = Engine.GetGUIObjectByName("populationCap");
+        populationCapBox.selected = populationCapBox.list_data.indexOf(mapSettings.PopulationCap);
+    }
+    if (mapSettings.StartingResources)
+    {
+        var startingResourcesBox = Engine.GetGUIObjectByName("startingResources");
+        startingResourcesBox.selected = startingResourcesBox.list_data.indexOf(mapSettings.StartingResources);
+    }
+
+    g_IsInGuiUpdate = false;
+
+    onGameAttributesChange();
+}
+
+function saveGameAttributesToUserCfg()
+{
+    var attributes = Engine.ConfigDB_GetValue("user", "persistmatchsettings") == "true" ? g_GameAttributes : {};
+    Engine.WriteJSONFile(g_IsNetworked ? FILEPATH_MATCHSETTINGS_MP : FILEPATH_MATCHSETTINGS_SP, attributes);
+}
 ////////////////////////////////////////////////////////////////////////////////////////////////
 // GUI event handlers
 
 function cancelSetup()
 {
+    if (g_IsController)
+        saveGameAttributesToUserCfg();
+
     Engine.DisconnectNetworkGame();
 
     if (Engine.HasXmppClient())
@@ -803 +870 @@
     {
     case "scenario":
         // Set a default map
-        // TODO: This should be remembered from the last session
         g_GameAttributes.mapPath = "maps/scenarios/";
         g_GameAttributes.map = g_GameAttributes.mapPath + (g_IsNetworked ? DEFAULT_NETWORKED_MAP : DEFAULT_OFFLINE_MAP);
         g_GameAttributes.settings.AISeed = Math.floor(Math.random() * 65536);
@@ -984 +1050 @@
         }
     }
 
+    saveGameAttributesToUserCfg();
+
     if (g_IsNetworked)
     {
         Engine.SetNetworkGameAttributes(g_GameAttributes);

binaries/data/mods/public/gui/options/options.js

@@ -13 +13 @@
         [translate("FPS Overlay"), translate("Show frames per second in top right corner."), {"config":"overlay.fps"}, "boolean"],
         [translate("Realtime Overlay"), translate("Show current system time in top right corner."), {"config":"overlay.realtime"}, "boolean"],
         [translate("Gametime Overlay"), translate("Show current simulation time in top right corner."), {"config":"gui.session.timeelapsedcounter"}, "boolean"],
+        [translate("Persist match settings"), translate("Save and restore match settings for quick reuse when hosting an other game"), {"config":"persistmatchsettings"}, "boolean"],
     ],
     "graphicsSetting":
     [

source/gui/scripting/ScriptFunctions.cpp

@@ -842 +842 @@
     return out.get();
 }
 
+void WriteJSONFile(ScriptInterface::CxPrivate* pCxPrivate, std::wstring filePath, CScriptVal scriptVal)
+{
+    JS::RootedValue val(pCxPrivate->pScriptInterface->GetContext(),  scriptVal.get());
+    std::string str(pCxPrivate->pScriptInterface->StringifyJSON(&val, false));
+
+    VfsPath path(filePath);
+    WriteBuffer buf;
+    buf.Append(str.c_str(), str.length());
+    g_VFS->CreateFile(path, buf.Data(), buf.Size());
+}
+
 CParamNode GetTemplate(ScriptInterface::CxPrivate* UNUSED(pCxPrivate), std::string templateName)
 {
     return g_GUI->GetTemplate(templateName);
@@ -1007 +1018 @@
     scriptInterface.RegisterFunction<int, &GetFps>("GetFPS");
     scriptInterface.RegisterFunction<std::wstring, int, &GetBuildTimestamp>("GetBuildTimestamp");
     scriptInterface.RegisterFunction<CScriptVal, std::wstring, &ReadJSONFile>("ReadJSONFile");
+    scriptInterface.RegisterFunction<void, std::wstring, CScriptVal, &WriteJSONFile>("WriteJSONFile");
     scriptInterface.RegisterFunction<CParamNode, std::string, &GetTemplate>("GetTemplate");
 
     // User report functions