Ticket #3742: restore_selection_v2.patch

binaries/data/mods/public/gui/replaymenu/replay_actions.js

@@ -1 +1 @@
 /**
+ * Creates the data for restoring selection, order and filters when returning to the replay menu
+ */
+function createReplayMenuData(selectedDirectory)
+{
+    return {
+        "selectedDirectory": selectedDirectory, 
+        "selectedColumn": Engine.GetGUIObjectByName("replaySelection").selected_column,
+        "selectedColumnOrder": Engine.GetGUIObjectByName("replaySelection").selected_column_order,
+        "selectedFilters": {
+            "date": Engine.GetGUIObjectByName("dateTimeFilter").list_data[Engine.GetGUIObjectByName("dateTimeFilter").selected],
+            "playernames": Engine.GetGUIObjectByName("playersFilter").caption,
+            "mapName": Engine.GetGUIObjectByName("mapNameFilter").list_data[Engine.GetGUIObjectByName("mapNameFilter").selected],
+            "mapSize": Engine.GetGUIObjectByName("mapSizeFilter").list_data[Engine.GetGUIObjectByName("mapSizeFilter").selected],
+            "popCap": Engine.GetGUIObjectByName("populationFilter").list_data[Engine.GetGUIObjectByName("populationFilter").selected],
+            "duration": Engine.GetGUIObjectByName("durationFilter").list_data[Engine.GetGUIObjectByName("durationFilter").selected]
+        }
+    }
+}
+/**
  * Starts the selected visual replay, or shows an error message in case of incompatibility.
  */
 function startReplay()
@@ -25 +44 @@
     Engine.StartVisualReplay(replayDirectory);
     Engine.SwitchGuiPage("page_loading.xml", {
         "attribs": Engine.GetReplayAttributes(replayDirectory),
-        "isNetworked" : false,
+        "isNetworked": false,
         "playerAssignments": {
             "local":{
                 "name": translate("You"),
@@ -33 +52 @@
             }
         },
         "savedGUIData": "",
-        "isReplay" : true
+        "isReplay": true,
+        "replayMenuData": createReplayMenuData(replayDirectory)
     });
 }
 
@@ -79 +99 @@
     // Open summary screen
     summary.isReplay = true;
     summary.gameResult = translate("Scores at the end of the game.");
-    summary.replayDirectory = g_ReplaysFiltered[selected].directory;
+    summary.replayMenuData = createReplayMenuData(g_ReplaysFiltered[selected].directory);
     Engine.SwitchGuiPage("page_summary.xml", summary);
 }
 

binaries/data/mods/public/gui/replaymenu/replay_filters.js

@@ -21 +21 @@
  * Reloads the selectable values in the filters. The filters depend on g_Settings and g_Replays
  * (including its derivatives g_MapSizes, g_MapNames).
  */
-function initFilters()
+function initFilters(data)
 {
-    initDateFilter();
-    initMapNameFilter();
-    initMapSizeFilter();
-    initPopCapFilter();
-    initDurationFilter();
+    initDateFilter(data);
+    initMapNameFilter(data);
+    initMapSizeFilter(data);
+    initPopCapFilter(data);
+    initDurationFilter(data);
 }
 
 /**
  * Allow to filter by month. Uses g_Replays.
  */
-function initDateFilter()
+function initDateFilter(data)
 {
     var months = g_Replays.map(replay => getReplayMonth(replay));
     months = months.filter((month, index) => months.indexOf(month) == index).sort();
-    months.unshift(translateWithContext("datetime", "Any"));
 
     var dateTimeFilter = Engine.GetGUIObjectByName("dateTimeFilter");
-    dateTimeFilter.list = months;
-    dateTimeFilter.list_data = months;
+    dateTimeFilter.list = [translateWithContext("datetime", "Any")].concat(months);
+    dateTimeFilter.list_data = [""].concat(months);
 
+    if(data && data.replayMenuData)
+        dateTimeFilter.selected = dateTimeFilter.list_data.indexOf(data.replayMenuData.selectedFilters.date);
+
     if (dateTimeFilter.selected == -1 || dateTimeFilter.selected >= dateTimeFilter.list.length)
         dateTimeFilter.selected = 0;
 }
@@ -50 +52 @@
 /**
  * Allow to filter by mapsize. Uses g_MapSizes.
  */
-function initMapSizeFilter()
+function initMapSizeFilter(data)
 {
     var mapSizeFilter = Engine.GetGUIObjectByName("mapSizeFilter");
     mapSizeFilter.list = [translateWithContext("map size", "Any")].concat(g_MapSizes.Name);
     mapSizeFilter.list_data = [-1].concat(g_MapSizes.Tiles);
 
+    if(data && data.replayMenuData)
+        mapSizeFilter.selected = mapSizeFilter.list_data.indexOf(data.replayMenuData.selectedFilters.mapSize);
+
     if (mapSizeFilter.selected == -1 || mapSizeFilter.selected >= mapSizeFilter.list.length)
         mapSizeFilter.selected = 0;
 }
@@ -63 +68 @@
 /**
  * Allow to filter by mapname. Uses g_MapNames.
  */
-function initMapNameFilter()
+function initMapNameFilter(data)
 {
     var mapNameFilter = Engine.GetGUIObjectByName("mapNameFilter");
-    mapNameFilter.list = [translateWithContext("map name", "Any")].concat(g_MapNames);
-    mapNameFilter.list_data = [""].concat(g_MapNames.map(mapName => translate(mapName)));
+    mapNameFilter.list = [translateWithContext("map name", "Any")].concat(g_MapNames.map(mapName => translate(mapName)));
+    mapNameFilter.list_data = [""].concat(g_MapNames);
 
+    if(data && data.replayMenuData)
+        mapNameFilter.selected = mapNameFilter.list_data.indexOf(data.replayMenuData.selectedFilters.mapName);
+
     if (mapNameFilter.selected == -1 || mapNameFilter.selected >= mapNameFilter.list.length)
         mapNameFilter.selected = 0;
 }
@@ -76 +84 @@
 /**
  * Allow to filter by population capacity.
  */
-function initPopCapFilter()
+function initPopCapFilter(data)
 {
     var populationFilter = Engine.GetGUIObjectByName("populationFilter");
     populationFilter.list = [translateWithContext("population capacity", "Any")].concat(g_PopulationCapacities.Title);
     populationFilter.list_data = [""].concat(g_PopulationCapacities.Population);
 
+    if(data && data.replayMenuData)
+        populationFilter.selected = populationFilter.list_data.indexOf(data.replayMenuData.selectedFilters.popCap);
+
     if (populationFilter.selected == -1 || populationFilter.selected >= populationFilter.list.length)
         populationFilter.selected = 0;
 }
@@ -89 +100 @@
 /**
  * Allow to filter by game duration. Uses g_DurationFilterIntervals.
  */
-function initDurationFilter()
+function initDurationFilter(data)
 {
     var durationFilter = Engine.GetGUIObjectByName("durationFilter");
     durationFilter.list = g_DurationFilterIntervals.map((interval, index) => {
@@ -110 +121 @@
     });
     durationFilter.list_data = g_DurationFilterIntervals.map((interval, index) => index);
 
+    if(data && data.replayMenuData)
+        durationFilter.selected = durationFilter.list_data.indexOf(data.replayMenuData.selectedFilters.duration);
+
     if (durationFilter.selected == -1 || durationFilter.selected >= g_DurationFilterIntervals.length)
         durationFilter.selected = 0;
 }

binaries/data/mods/public/gui/replaymenu/replay_menu.js

@@ -36 +36 @@
 /**
  * Directory name of the currently selected replay. Used to restore the selection after changing filters.
  */
-var g_selectedReplayDirectory = "";
+var g_SelectedReplayDirectory = "";
 
 /**
  * Initializes globals, loads replays and displays the list.
  */
-function init()
+function init(data)
 {
+    if (data && data.replayMenuData)
+    {
+        g_SelectedReplayDirectory = data.replayMenuData.selectedDirectory;
+        Engine.GetGUIObjectByName("playersFilter").caption = data.replayMenuData.selectedFilters.playernames;
+        Engine.GetGUIObjectByName("replaySelection").selected_column = data.replayMenuData.selectedColumn;
+        Engine.GetGUIObjectByName("replaySelection").selected_column_order = data.replayMenuData.selectedColumnOrder;
+    }
+
     if (!g_Settings)
     {
         Engine.SwitchGuiPage("page_pregame.xml");
@@ -49 +57 @@
         return;
     }
 
-    loadReplays();
+    loadReplays(data);
 
     if (!g_Replays)
     {
@@ -64 +72 @@
  * Store the list of replays loaded in C++ in g_Replays.
  * Check timestamp and compatibility and extract g_Playernames, g_MapNames
  */
-function loadReplays()
+function loadReplays(data)
 {
     g_Replays = Engine.GetReplays();
 
@@ -105 +113 @@
     g_MapNames.sort();
 
     // Reload filters (since they depend on g_Replays and its derivatives)
-    initFilters();
+    initFilters(data);
 }
 
 /**
@@ -152 +160 @@
     // Remember previously selected replay
     var replaySelection = Engine.GetGUIObjectByName("replaySelection");
     if (replaySelection.selected != -1)
-        g_selectedReplayDirectory = g_ReplaysFiltered[replaySelection.selected].directory;
+        g_SelectedReplayDirectory = g_ReplaysFiltered[replaySelection.selected].directory;
 
     filterReplays();
 
@@ -188 +196 @@
     replaySelection.list_data = list.directories || [];
 
     // Restore selection
-    replaySelection.selected = replaySelection.list.findIndex(directory => directory == g_selectedReplayDirectory);
+    replaySelection.selected = replaySelection.list.findIndex(directory => directory == g_SelectedReplayDirectory);
 
     displayReplayDetails();
 }

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

@@ -61 +61 @@
 
 /**
  * Not constant as we add "gaia".
- **/
+ */
 var g_CivData = {};
 
+/**
+ * For restoring selection, order and filters when returning to the replay menu
+ */
+var g_ReplayMenuData;
+
 var g_PlayerAssignments = { "local": { "name": translate("You"), "player": 1 } };
 
 /**
@@ -213 +218 @@
         g_PlayerAssignments = initData.playerAssignments;
         g_MatchID = initData.attribs.matchID;
 
+        g_ReplayMenuData = initData.replayMenuData;
+
         // Cache the player data
         // (This may be updated at runtime by handleNetMessage)
         g_Players = getPlayerData(g_PlayerAssignments);
@@ -473 +480 @@
         Engine.SaveReplayMetadata(JSON.stringify(summary));
 
     summary.replayDirectory = Engine.GetCurrentReplayDirectory();
+    summary.replayMenuData = g_ReplayMenuData;
 
     Engine.EndGame();
 

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

@@ -134 +134 @@
     if (Engine.HasXmppClient())
         Engine.StopXmppClient();
 
-    Engine.StartVisualReplay(g_GameData.replayDirectory);
+    Engine.StartVisualReplay(g_GameData.replayMenuData.selectedDirectory);
     Engine.SwitchGuiPage("page_loading.xml", {
-        "attribs": Engine.GetReplayAttributes(g_GameData.replayDirectory),
-        "isNetworked" : false,
+        "attribs": Engine.GetReplayAttributes(g_GameData.replayMenuData.selectedDirectory),
+        "isNetworked": false,
         "playerAssignments": {
-            "local" : {
+            "local": {
                 "name": translate("You"),
                 "player": -1
             }
         },
         "savedGUIData": "",
-        "isReplay" : true
+        "isReplay": true,
+        "replayMenuData": g_GameData.replayMenuData
     });
 }
 
@@ -159 +160 @@
     Engine.GetGUIObjectByName("timeElapsed").caption = sprintf(translate("Game time elapsed: %(time)s"), { "time": timeToString(data.timeElapsed) });
     Engine.GetGUIObjectByName("summaryText").caption = data.gameResult;
     Engine.GetGUIObjectByName("mapName").caption = sprintf(translate("%(mapName)s - %(mapType)s"), { "mapName": translate(data.mapSettings.Name), "mapType": mapSize ? mapSize.LongName : (mapType ? mapType.Title : "") });
-    Engine.GetGUIObjectByName("replayButton").hidden = g_GameData.isInGame || !g_GameData.replayDirectory;
+    Engine.GetGUIObjectByName("replayButton").hidden = g_GameData.isInGame || !g_GameData.replayMenuData.selectedDirectory;
 
     // Panels
     g_PlayerCount = data.playerStates.length - 1;

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

@@ -187 +187 @@
                 }
                 else if (g_GameData.isReplay)
                 {
-                    Engine.SwitchGuiPage("page_replaymenu.xml");
+                    Engine.SwitchGuiPage("page_replaymenu.xml", { "replayMenuData": g_GameData.replayMenuData });
                 }
                 else if (!Engine.HasXmppClient())
                 {