Ticket #3355: t3355_move_ceasefire_v2.1.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
+
+const g_SettingsDirectory = "simulation/data/settings/";
+
+/**
+ * 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|undefined}
+ */
+function loadAvailableSettings()
+{
+    var settings = {};
+
+    settings.Ceasefire = loadCeasefire();
+    if (!settings.Ceasefire)
+        return undefined;
+
+    return settings;
+}
+
+/**
+ * Loads available ceasefire settings.
+ *
+ * @returns {Array|undefined}
+ */
+function loadCeasefire()
+{
+    var json = Engine.ReadJSONFile(g_SettingsDirectory + "Ceasefire.json");
+
+    if (!json || json.Default === undefined || !json.Times || !Array.isArray(json.Times))
+    {
+        error("Could not load Ceasefire.json");
+        return undefined;
+    }
+
+    return json.Times.map(timeout => { return {
+        "Duration": timeout,
+        "Default": timeout == json.Default,
+        "Title": timeout == 0 ? translateWithContext("ceasefire", "No ceasefire") :
+            sprintf(translatePluralWithContext("ceasefire", "%(minutes)s minute", "%(minutes)s minutes", timeout), { "minutes": timeout })
+    }});
+}
+
+/**
+ * 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 settingValues {Array}
+ * @returns {Object|undefined}
+ */
+function prepareForDropdown(settingValues)
+{
+    if (!settingValues)
+        return undefined;
+
+    var settings = { "Default": 0 };
+    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;
+
+const g_Ceasefire = prepareForDropdown(g_Settings ? g_Settings.Ceasefire : undefined);
 
 ////////////////////////////////////////////////////////////////////////////////////////////////
 
 // 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;
 
@@ -77 +75 @@
 var g_LoadingState = 0; // 0 = not started, 1 = loading, 2 = loaded
 
 // Filled by scripts in victory_conditions/
 var g_VictoryConditions = {};
 
 ////////////////////////////////////////////////////////////////////////////////////////////////
 
 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;
@@ -214 +218 @@
         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() {
@@ -423 +427 @@
     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 +810 @@
 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()
 {
+    if (!g_Settings)
+        return;
+
     // First tick happens before first render, so don't load yet
     if (g_LoadingState == 0)
     {
         g_LoadingState++;
     }
     else if (g_LoadingState == 1)
     {
         Engine.GetGUIObjectByName("loadingWindow").hidden = true;
         Engine.GetGUIObjectByName("setupWindow").hidden = false;
@@ -1246 +1251 @@
     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

@@ -1 +1 @@
 <?xml version="1.0" encoding="utf-8"?>
 
 <objects>
 
     <script file="gui/common/functions_civinfo.js"/>
     <script file="gui/common/functions_global_object.js"/>
     <script file="gui/common/functions_utility.js"/>
     <script file="gui/common/network.js"/>
     <script file="gui/common/settings.js"/>
+
+    <!-- After settings.js, which defines g_Settings -->
     <script file="gui/gamesetup/gamesetup.js"/>
+
     <!-- After gamesetup.js which defines g_VictoryConditions -->
     <script directory="gui/gamesetup/victory_conditions/"/>
 
     <!-- Add a translucent black background to fade out the menu page -->
     <object type="image" style="ModernWindow" size="0 0 100% 100%">
 
         <object style="TitleText" type="text" size="50%-128 4 50%+128 36">
             <translatableAttribute id="caption">Match Setup</translatableAttribute>
         </object>
@@ -234 +237 @@
             <!-- 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/simulation/data/settings/Ceasefire.json

@@ +1 @@
+{
+    "Default": 0,
+    "Times": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30, 45, 60]
+}