Ticket #3355: t3355_move_starting_resources_v1.1.patch

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

@@ -17 +17 @@
 
 /**
  * An object containing all values given by setting name.
  * Used by lobby, gamesetup, session, summary screen and replay menu.
  */
-const g_Settings = loadAvailableSettings();
+const g_Settings = loadSettingsValues();
 
 /**
  * Loads and translates all values of all settings which
  * can be configured by dropdowns in the gamesetup.
  *
  * @returns {Object|undefined}
  */
-function loadAvailableSettings()
+function loadSettingsValues()
 {
-    var settings = {};
+    var settings = {
+        "Ceasefire": loadCeasefire(),
+        "StartingResources": loadSettingValuesFile("starting_resources.json")
+    };
 
-    settings.Ceasefire = loadCeasefire();
-    if (!settings.Ceasefire)
+    if (Object.keys(settings).some(key => settings[key] === undefined))
         return undefined;
 
     return settings;
 }
 
 /**
+ * Returns an array of objects reflecting all possible values for a given setting.
+ *
+ * @param {string} filename
+ * @see simulation/data/settings/
+ * @returns {Array|undefined}
+ */
+function loadSettingValuesFile(filename)
+{
+    var json = Engine.ReadJSONFile(g_SettingsDirectory + filename);
+
+    if (!json || !json.Data)
+    {
+        error("Could not load " + filename + "!");
+        return undefined;
+    }
+
+    if (json.TranslatedKeys)
+        translateObjectKeys(json, json.TranslatedKeys);
+
+    return json.Data;
+}
+
+/**
  * Loads available ceasefire settings.
  *
  * @returns {Array|undefined}
  */
 function loadCeasefire()

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;
 
+const g_StartingResources = prepareForDropdown(g_Settings ? g_Settings.StartingResources : undefined);
 const g_Ceasefire = prepareForDropdown(g_Settings ? g_Settings.Ceasefire : undefined);
 
 ////////////////////////////////////////////////////////////////////////////////////////////////
 
 // Is this is a networked game, or offline
@@ -211 +208 @@
 
             updateGameAttributes();
         }
 
         var startingResourcesL = Engine.GetGUIObjectByName("startingResources");
-        startingResourcesL.list = STARTING_RESOURCES;
-        startingResourcesL.list_data = STARTING_RESOURCES_DATA;
-        startingResourcesL.selected = STARTING_RESOURCES_DEFAULTIDX;
+        startingResourcesL.list = g_StartingResources.Title;
+        startingResourcesL.list_data = g_StartingResources.Resources;
+        startingResourcesL.selected = g_StartingResources.Default;
         startingResourcesL.onSelectionChange = function() {
             if (this.selected != -1)
-                g_GameAttributes.settings.StartingResources = STARTING_RESOURCES_DATA[this.selected];
+                g_GameAttributes.settings.StartingResources = g_StartingResources.Resources[this.selected];
 
             updateGameAttributes();
         }
 
         var ceasefireL = Engine.GetGUIObjectByName("ceasefire");
@@ -1253 +1250 @@
 
     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];
+    startingResources.selected = mapSettings.StartingResources !== undefined && g_StartingResources.Resources.indexOf(mapSettings.StartingResources) != -1 ? g_StartingResources.Resources.indexOf(mapSettings.StartingResources) : g_StartingResources.Default;
+    startingResourcesText.caption = g_StartingResources.Title[startingResources.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);

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

@@ -463 +463 @@
                 }
             },
             {
                 "extractor": "json",
                 "filemasks": [
+                    "simulation/data/settings/starting_resources.json"
+                ],
+                "options": {
+                    "keywords": ["Title"],
+                    "context": "startingResources"
+                 }
+             },
+            {
+                "extractor": "json",
+                "filemasks": [
                     "simulation/data/map_sizes.json"
                 ],
                 "options": {
                     "keywords": [
                         "Name",

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

@@ +1 @@
+{
+    "TranslatedKeys": { "Title": "startingResources" },
+    "Data":
+    [
+        {
+            "Resources": 100,
+            "Title": "Very Low"
+        },
+        {
+            "Resources": 300,
+            "Title": "Low",
+            "Default": true
+        },
+        {
+            "Resources": 500,
+            "Title": "Medium"
+        },
+        {
+            "Resources": 1000,
+            "Title": "High"
+        },
+        {
+            "Resources": 3000,
+            "Title": "Very High"
+        },
+        {
+            "Resources": 50000,
+            "Title": "Deathmatch"
+        }
+    ]
+}