Ticket #3355: t3355_move_ai_difficulties_v1.patch

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

@@ -1 @@
-var g_AIs; // [ {"id": ..., "data": {"name": ..., "description": ..., ...} }, ... ]
 var g_PlayerSlot;
 
+const g_AIDescriptions = [{
+    "id": "",
+    "data": {
+        "name": translateWithContext("ai", "None"),
+        "description": translate("AI will be disabled for this player.")
+    }
+}].concat(g_Settings.AIDescriptions);
+
 function init(settings)
 {
+    // Remember the player ID that we change the AI settings for
     g_PlayerSlot = settings.playerSlot;
 
-    translateObjectKeys(settings.ais, ["name", "description"]);
-    g_AIs = [
-        {id: "", data: {name: translateWithContext("ai", "None"), description: translate("AI will be disabled for this player.")}}
-    ].concat(settings.ais);
-
     var aiSelection = Engine.GetGUIObjectByName("aiSelection");
-    aiSelection.list = [ translate(ai.data.name) for each (ai in g_AIs) ];
-
-    var selected = 0;
-    for (var i = 0; i < g_AIs.length; ++i)
-    {
-        if (g_AIs[i].id == settings.id)
-        {
-            selected = i;
-            break;
-        }
-    }
-    aiSelection.selected = selected;
+    aiSelection.list = g_AIDescriptions.map(ai => ai.data.name);
+    aiSelection.selected = g_AIDescriptions.findIndex(ai => ai.id == settings.id);
 
     var aiDiff = Engine.GetGUIObjectByName("aiDifficulty");
-    // Translation: AI difficulty level.
-    aiDiff.list = [translateWithContext("aiDiff", "Sandbox"), translateWithContext("aiDiff", "Very Easy"), translateWithContext("aiDiff", "Easy"), translateWithContext("aiDiff", "Medium"), translateWithContext("aiDiff", "Hard"), translateWithContext("aiDiff", "Very Hard")];
+    aiDiff.list = prepareForDropdown(g_Settings.AIDifficulties).Title;
     aiDiff.selected = settings.difficulty;
 }
 
 function selectAI(idx)
 {
-    var id = g_AIs[idx].id;
-    var name = g_AIs[idx].data.name;
-    var description = g_AIs[idx].data.description;
-
-    Engine.GetGUIObjectByName("aiDescription").caption = description;
+    Engine.GetGUIObjectByName("aiDescription").caption = g_AIDescriptions[idx].data.description;
 }
 
 function returnAI()
 {
-    var aiSelection = Engine.GetGUIObjectByName("aiSelection");
-    var idx = aiSelection.selected;
-    var id = g_AIs[idx].id;
-    var name = g_AIs[idx].data.name;
+    var idx = Engine.GetGUIObjectByName("aiSelection").selected;
 
-    var difficulty = Engine.GetGUIObjectByName("aiDifficulty").selected;
-    
     // Pop the page before calling the callback, so the callback runs
     // in the parent GUI page's context
-    Engine.PopGuiPageCB({"id": id, "name": name, "difficulty" : difficulty, "playerSlot" : g_PlayerSlot });
+    Engine.PopGuiPageCB({
+        "id": g_AIDescriptions[idx].id,
+        "name": g_AIDescriptions[idx].data.name,
+        "difficulty": Engine.GetGUIObjectByName("aiDifficulty").selected,
+        "playerSlot": g_PlayerSlot
+    });
 }

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

@@ -1 +1 @@
 <?xml version="1.0" encoding="utf-8"?>
 
 <objects>
 
+    <script file="gui/common/settings.js"/>
     <script file="gui/aiconfig/aiconfig.js"/>
 
     <!-- Add a translucent black background to fade out the menu page -->
     <object type="image" sprite="ModernFade"/>
 

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

@@ -7 +7 @@
 /**
  * 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
-
+/**
+ * Directory containing all editable settings.
+ */
 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.
@@ -27 +26 @@
  *
  * @returns {Object|undefined}
  */
 function loadSettingsValues()
 {
+    // TODO: move PlayerDefaults and MapSizes from functions_utility.js here
     var settings = {
+        "AIDescriptions": loadAIDescriptions(),
+        "AIDifficulties": loadAIDifficulties(),
         "Ceasefire": loadCeasefire(),
         "GameSpeeds": loadSettingValuesFile("game_speeds.json"),
         "MapTypes": loadMapTypes(),
         "PopulationCapacities": loadPopulationCapacities(),
         "StartingResources": loadSettingValuesFile("starting_resources.json"),
@@ -66 +68 @@
 
     return json.Data;
 }
 
 /**
+ * Loads the descriptions as defined in simulation/ai/.../data.json and loaded by ICmpAIManager.cpp.
+ *
+ * @returns {Array}
+ */
+function loadAIDescriptions()
+{
+    var ais = Engine.GetAIs();
+    translateObjectKeys(ais, ["name", "description"]);
+    return ais.sort((a, b) => a.data.name.localeCompare(b.data.name));
+}
+
+/**
+ * Hardcoded, as modding is not supported without major changes.
+ * Notice the AI code parses the difficulty level by the index, not by name.
+ *
+ * @returns {Array}
+ */
+function loadAIDifficulties()
+{
+    return [
+        {
+            "Name": "sandbox",
+            "Title": translateWithContext("aiDiff", "Sandbox")
+        },
+        {
+            "Name": "very easy",
+            "Title": translateWithContext("aiDiff", "Very Easy")
+        },
+        {
+            "Name": "easy",
+            "Title": translateWithContext("aiDiff", "Easy")
+        },
+        {
+            "Name": "medium",
+            "Title": translateWithContext("aiDiff", "Medium"),
+            "Default": true
+        },
+        {
+            "Name": "hard",
+            "Title": translateWithContext("aiDiff", "Hard")
+        },
+        {
+            "Name": "very hard",
+            "Title": translateWithContext("aiDiff", "Very Hard")
+        }
+    ];
+}
+
+/**
  * Loads available ceasefire settings.
  *
  * @returns {Array|undefined}
  */
 function loadCeasefire()

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

@@ -46 +46 @@
     settings: {}
 };
 
 var g_MapSizes = {};
 
-var g_AIs = [];
-
 var g_ChatMessages = [];
 
 // Data caches
 var g_MapData = {};
 var g_CivData = {};
@@ -106 +104 @@
 }
 
 // Called after the map data is loaded and cached
 function initMain()
 {
-    // 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
     g_DefaultPlayerData = initPlayerDefaults();
     g_DefaultPlayerData.shift();
     for (var i = 0; i < g_DefaultPlayerData.length; ++i)
         g_DefaultPlayerData[i].Civ = "random";
@@ -708 +698 @@
 
     // Ensure that cheats are enabled in singleplayer
     if (!g_IsNetworked)
         mapSettings.CheatsEnabled = true;
 
-    var aiCodes = [ ai.id for each (ai in g_AIs) ];
     var civListCodes = [ civ.Code for each (civ in g_CivData) if (civ.SelectableInGameSetup !== false) ];
     civListCodes.push("random");
 
     var playerData = mapSettings.PlayerData;
 
@@ -1534 +1523 @@
 
     // Only enable start button if we have enough assigned players
     if (g_IsController)
         Engine.GetGUIObjectByName("startGame").enabled = (g_AssignedCount > 0);
 
-    for each (var ai in g_AIs)
+    for (let ai of g_Settings.AIDescriptions)
     {
         if (ai.data.hidden)
         {
             // If the map uses a hidden AI then don't hide it
             var usedByMap = false;
@@ -1600 +1589 @@
             if (g_IsController)
             {
                 configButton.hidden = false;
                 configButton.onpress = function() {
                     Engine.PushGuiPage("page_aiconfig.xml", {
-                        "ais": g_AIs,
                         "id": g_GameAttributes.settings.PlayerData[playerSlot].AI,
                         "difficulty": g_GameAttributes.settings.PlayerData[playerSlot].AIDiff,
                         "callback": "AIConfigCallback",
                         "playerSlot": playerSlot // required by the callback function
                     });