Ticket #3355: t3355_move_ceasefire_v1.2.patch

binaries/data/mods/public/gui/common/settings.js

@@ -6 +6 @@
 
 /**
  * The maximum number of teams allowed.
  */
 const g_MaxTeams = 4;
 
 // The following settings will be loaded here:
 // AIDifficulties, Ceasefire, GameSpeeds, GameTypes, MapTypes,
 // MapSizes, PlayerDefaults, PopulationCapacity, StartingResources
+
+/**
+ * An object containing all values given by setting name.
+ * Used by lobby, gamesetup, session, summary screen and replay menu.
+ */
+const g_Settings = loadAvailableSettings();
+
+/**
+ * Loads and translates all values of all settings which
+ * can be configured by dropdowns in the gamesetup.
+ *
+ * @returns {Object|false}
+ */
+function loadAvailableSettings()
+{
+    const rootDir = "simulation/data/settings/";
+    const settingNames = ["Ceasefire"];
+
+    var settings = {};
+    for (let settingName of settingNames)
+    {
+        settings[settingName] = loadAvailableSettingsFile(settingName, rootDir + settingName + ".json");
+        if (!settings[settingName])
+            return false;
+    }
+
+    return settings;
+}
+
+/**
+ * Returns all possible values for a given setting.
+ * Each item of the returned array is an object.
+ *
+ * @param {string} settingName
+ * @param {string} filename
+ * @see simulation/data/settings/
+ * @returns {Array|false}
+ */
+function loadAvailableSettingsFile(settingName, filename)
+{
+    var json = Engine.ReadJSONFile(filename);
+
+    if (!json || !json.Data)
+    {
+        error("Couldn't load " + settingName + " settings!");
+        return false;
+    }
+
+    if (json.TranslatedKeys)
+        translateObjectKeys(json, json.TranslatedKeys);
+
+    return json.Data;
+}
+
+/**
+ * Creates an array with all values of that property of the given setting and
+ * finds the index of the default value.
+ *
+ * This allows easy copying of setting values to dropdown lists.
+ *
+ * @param settingsName {string}
+ * @returns {Object}
+ */
+function prepareForDropdown(settingsName)
+{
+    var settings = {};
+    var settingValues = g_Settings[settingsName];
+
+    for (let index in settingValues)
+    {
+        for (let property in settingValues[index])
+        {
+            if (property == "Default")
+                continue;
+
+            if (index == 0)
+                settings[property] = [];
+
+            // Switch property and index
+            settings[property][index] = settingValues[index][property];
+        }
+
+        // Copy default value
+        if (settingValues[index].Default)
+            settings.Default = +index;
+    }
+
+    return settings;
+}

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

@@ -8 +8 @@
 // TODO: Move these somewhere like simulation\data\game_types.json, Atlas needs them too
 // Translation: Type of victory condition.
 const POPULATION_CAP = ["50", "100", "150", "200", "250", "300", translate("Unlimited")];
 const POPULATION_CAP_DATA = [50, 100, 150, 200, 250, 300, 10000];
 const POPULATION_CAP_DEFAULTIDX = 5;
 // Translation: Amount of starting resources.
 const STARTING_RESOURCES = [translateWithContext("startingResources", "Very Low"), translateWithContext("startingResources", "Low"), translateWithContext("startingResources", "Medium"), translateWithContext("startingResources", "High"), translateWithContext("startingResources", "Very High"), translateWithContext("startingResources", "Deathmatch")];
 const STARTING_RESOURCES_DATA = [100, 300, 500, 1000, 3000, 50000];
 const STARTING_RESOURCES_DEFAULTIDX = 1;
-// Translation: Ceasefire.
-const CEASEFIRE = [translateWithContext("ceasefire", "No ceasefire"), translateWithContext("ceasefire", "5 minutes"), translateWithContext("ceasefire", "10 minutes"), translateWithContext("ceasefire", "15 minutes"), translateWithContext("ceasefire", "20 minutes"), translateWithContext("ceasefire", "30 minutes"), translateWithContext("ceasefire", "45 minutes"), translateWithContext("ceasefire", "60 minutes")];
-const CEASEFIRE_DATA = [0, 5, 10, 15, 20, 30, 45, 60];
-const CEASEFIRE_DEFAULTIDX = 0;
 
 ////////////////////////////////////////////////////////////////////////////////////////////////
 
 // Is this is a networked game, or offline
 var g_IsNetworked;
 
 // Is this user in control of game settings (i.e. is a network server, or offline player)
 var g_IsController;
 
@@ -73 +69 @@
 
 // To prevent the display locking up while we load the map metadata,
 // we'll start with a 'loading' message and switch to the main screen in the
 // tick handler
 var g_LoadingState = 0; // 0 = not started, 1 = loading, 2 = loaded
 
 // Filled by scripts in victory_conditions/
 var g_VictoryConditions = {};
 
+// Contains setting values transformed for the dropdown list
+var g_Ceasefire = {};
+
 ////////////////////////////////////////////////////////////////////////////////////////////////
 
 function init(attribs)
 {
+    if (!g_Settings)
+    {
+        cancelSetup();
+        return;
+    }
+
     switch (attribs.type)
     {
     case "offline":
         g_IsNetworked = false;
         g_IsController = true;
         break;
     case "server":
         g_IsNetworked = true;
         g_IsController = true;
@@ -109 +114 @@
     if (!Engine.HasXmppClient())
         cancelButton.tooltip = translate("Return to the main menu.");
     else
         cancelButton.tooltip = translate("Return to the lobby.");
 }
 
 // Called after the map data is loaded and cached
 function initMain()
 {
+
+    if (!g_Settings)
+        return;
+
+    // Transform setting arrays for usage in dropdown list
+    g_Ceasefire = prepareForDropdown("Ceasefire");
+
     // Load AI list
     g_AIs = Engine.GetAIs();
 
     // Sort AIs by displayed name
     g_AIs.sort(function (a, b) {
         return a.data.name < b.data.name ? -1 : b.data.name < a.data.name ? +1 : 0;
     });
 
     // Get default player data - remove gaia
@@ -214 +226 @@
         startingResourcesL.selected = STARTING_RESOURCES_DEFAULTIDX;
         startingResourcesL.onSelectionChange = function() {
             if (this.selected != -1)
                 g_GameAttributes.settings.StartingResources = STARTING_RESOURCES_DATA[this.selected];
 
             updateGameAttributes();
         }
 
         var ceasefireL = Engine.GetGUIObjectByName("ceasefire");
-        ceasefireL.list = CEASEFIRE;
-        ceasefireL.list_data = CEASEFIRE_DATA;
-        ceasefireL.selected = CEASEFIRE_DEFAULTIDX;
+        ceasefireL.list = g_Ceasefire.Title;
+        ceasefireL.list_data = g_Ceasefire.Duration;
+        ceasefireL.selected = g_Ceasefire.Default;
         ceasefireL.onSelectionChange = function() {
             if (this.selected != -1)
-                g_GameAttributes.settings.Ceasefire = CEASEFIRE_DATA[this.selected];
+                g_GameAttributes.settings.Ceasefire = g_Ceasefire.Duration[this.selected];
 
             updateGameAttributes();
         }
 
         var victoryConditions = Engine.GetGUIObjectByName("victoryCondition");
         var victories = getVictoryConditions();
         victoryConditions.list = victories.text;
         victoryConditions.list_data = victories.data;
         victoryConditions.onSelectionChange = function() {
@@ -414 +426 @@
         if (g_IsInGuiUpdate)
             warn("initMain() called while in GUI update");
 
         updateGameAttributes();
     }
 }
 
 function handleNetMessage(message)
 {
+    if (!g_Settings)
+        return;
+
     log("Net message: " + uneval(message));
 
     switch (message.type)
     {
     case "netstatus":
         switch (message.status)
         {
         case "disconnected":
             cancelSetup();
-            if (Engine.HasXmppClient())
-                Engine.SwitchGuiPage("page_lobby.xml");
-            else
-                Engine.SwitchGuiPage("page_pregame.xml");
             reportDisconnect(message.reason);
             break;
 
         default:
             error("Unrecognised netstatus type " + message.status);
             break;
         }
         break;
 
@@ -810 +821 @@
 function cancelSetup()
 {
     if (g_IsController)
         saveGameAttributes();
 
     Engine.DisconnectNetworkGame();
 
     if (Engine.HasXmppClient())
     {
-        // Set player presence
         Engine.LobbySetPlayerPresence("available");
 
-        // Unregister the game
         if (g_IsController)
             Engine.SendUnregisterGame();
+
+        Engine.SwitchGuiPage("page_lobby.xml");
     }
+    else
+        Engine.SwitchGuiPage("page_pregame.xml");
 }
 
 function onTick()
 {
     // First tick happens before first render, so don't load yet
     if (g_LoadingState == 0)
     {
         g_LoadingState++;
     }
@@ -1246 +1259 @@
     observerLateJoin.checked = g_GameAttributes.settings.ObserverLateJoin;
     observerLateJoinText.caption = observerLateJoin.checked ? translate("Yes") : translate("No");
 
     gameSpeedText.caption = g_GameSpeeds.names[speedIdx];
     gameSpeedBox.selected = speedIdx;
     populationCap.selected = (mapSettings.PopulationCap !== undefined && POPULATION_CAP_DATA.indexOf(mapSettings.PopulationCap) != -1 ? POPULATION_CAP_DATA.indexOf(mapSettings.PopulationCap) : POPULATION_CAP_DEFAULTIDX);
     populationCapText.caption = POPULATION_CAP[populationCap.selected];
     startingResources.selected = (mapSettings.StartingResources !== undefined && STARTING_RESOURCES_DATA.indexOf(mapSettings.StartingResources) != -1 ? STARTING_RESOURCES_DATA.indexOf(mapSettings.StartingResources) : STARTING_RESOURCES_DEFAULTIDX);
     startingResourcesText.caption = STARTING_RESOURCES[startingResources.selected];
-    ceasefire.selected = (mapSettings.Ceasefire !== undefined && CEASEFIRE_DATA.indexOf(mapSettings.Ceasefire) != -1 ? CEASEFIRE_DATA.indexOf(mapSettings.Ceasefire) : CEASEFIRE_DEFAULTIDX);
-    ceasefireText.caption = CEASEFIRE[ceasefire.selected];
+    ceasefire.selected = mapSettings.Ceasefire !== undefined && g_Ceasefire.Duration.indexOf(mapSettings.Ceasefire) != -1 ? g_Ceasefire.Duration.indexOf(mapSettings.Ceasefire) : g_Ceasefire.Default;
+    ceasefireText.caption = g_Ceasefire.Title[ceasefire.selected];
 
     // Update map preview
     Engine.GetGUIObjectByName("mapPreview").sprite = "cropped:(0.78125,0.5859375)session/icons/mappreview/" + getMapPreview(mapName);
 
     // Hide/show settings depending on whether we can change them or not
     var updateDisplay = function(guiObjChg, guiObjDsp, chg) {
         guiObjChg.hidden = !chg;
         guiObjDsp.hidden = chg;
     };

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

@@ -234 +234 @@
             <!-- Cancel Button -->
             <object
                 name="cancelGame"
                 type="button"
                 style="StoneButton"
                 size="100%-308 100%-52 100%-168 100%-24"
                 tooltip_style="onscreenToolTip"
             >
                 <translatableAttribute id="caption">Back</translatableAttribute>
-                <action on="Press">
-                    <![CDATA[
-                        cancelSetup();
-                        if(!Engine.HasXmppClient())
-                            Engine.SwitchGuiPage("page_pregame.xml");
-                        else
-                            Engine.SwitchGuiPage("page_lobby.xml");
-                    ]]>
-                </action>
+                <action on="Press">cancelSetup();</action>
             </object>
 
             <!-- Options -->
             <object name="gameOptionsBox" size="100%-425 529 100%-25 525">
                 <!-- More Options Button -->
                 <object
                     name="showMoreOptions"
                     type="button"
                     style="StoneButton"

binaries/data/mods/public/l10n/messages.json

@@ -447 +447 @@
                     },
                     "commentTags": [
                         "Translation:"
                     ]
                 }
             },
             {
                 "extractor": "json",
                 "filemasks": [
+                    "simulation/data/settings/Ceasefire.json"
+                ],
+                "options": {
+                    "keywords": ["Title"],
+                    "context": "ceasefire"
+                }
+            },
+            {
+                "extractor": "json",
+                "filemasks": [
                     "simulation/data/game_speeds.json",
                     "simulation/data/player_defaults.json"
                 ],
                 "options": {
                     "keywords": [
                         "Name"
                     ]
                 }
             },

binaries/data/mods/public/simulation/data/settings/Ceasefire.json

@@ +1 @@
+{
+    "TranslatedKeys": { "Title": "ceasefire" },
+    "Data":
+    [
+        {
+            "Duration": 0,
+            "Title": "No ceasefire",
+            "Default": true
+        },
+        {
+            "Duration": 1,
+            "Title": "1 minute"
+        },
+        {
+            "Duration": 2,
+            "Title": "2 minutes"
+        },
+        {
+            "Duration": 3,
+            "Title": "3 minutes"
+        },
+        {
+            "Duration": 4,
+            "Title": "4 minutes"
+        },
+        {
+            "Duration": 5,
+            "Title": "5 minutes"
+        },
+        {
+            "Duration": 10,
+            "Title": "10 minutes"
+        },
+        {
+            "Duration": 15,
+            "Title": "15 minutes"
+        },
+        {
+            "Duration": 20,
+            "Title": "20 minutes"
+        },
+        {
+            "Duration": 30,
+            "Title": "30 minutes"
+        },
+        {
+            "Duration": 45,
+            "Title": "45 minutes"
+        },
+        {
+            "Duration": 60,
+            "Title": "60 minutes"
+        }
+    ]
+}