Ticket #3355: t3355_move_gametypes_v2.patch

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

@@ -31 +31 @@
 {
     var settings = {
         "Ceasefire": loadCeasefire(),
         "GameSpeeds": loadSettingValuesFile("game_speeds.json"),
         "PopulationCapacities": loadPopulationCapacities(),
-        "StartingResources": loadSettingValuesFile("starting_resources.json")
+        "StartingResources": loadSettingValuesFile("starting_resources.json"),
+        "VictoryConditions": loadVictoryConditions()
     };
 
     if (Object.keys(settings).some(key => settings[key] === undefined))
         return undefined;
 
@@ -87 +88 @@
             sprintf(translatePluralWithContext("ceasefire", "%(minutes)s minute", "%(minutes)s minutes", timeout), { "minutes": timeout })
     }));
 }
 
 /**
+ * Loads available gametypes.
+ *
+ * @returns {Array|undefined}
+ */
+function loadVictoryConditions()
+{
+    const subdir = "victory_conditions/"
+
+    const files = Engine.BuildDirEntList(g_SettingsDirectory + subdir, "*.json", false).map(
+        file => file.substr(g_SettingsDirectory.length));
+
+    var victoryConditions = files.map(file => {
+        let vc = loadSettingValuesFile(file);
+        if (vc)
+            vc.Name = file.substr(subdir.length, file.length - (subdir + ".json").length);
+        return vc;
+    });
+
+    if (victoryConditions.some(vc => vc == undefined))
+        return undefined;
+
+    // TODO: We might support enabling victory conditions separately sometime.
+    // Until then, we supplement the endless gametype here.
+    victoryConditions.push({
+        "Name": "endless",
+        "Title": translate("None"),
+        "Description": translate("Endless Game"),
+        "Scripts": []
+    });
+
+    return victoryConditions;
+}
+
+/**
  * Loads available population capacities.
  *
  * @returns {Array|undefined}
  */
 function loadPopulationCapacities()

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

@@ -1 +1 @@
 ////////////////////////////////////////////////////////////////////////////////////////////////
 // Constants
 const DEFAULT_NETWORKED_MAP = "Acropolis 01";
 const DEFAULT_OFFLINE_MAP = "Acropolis 01";
 
-const VICTORY_DEFAULTIDX = 1;
-
 const g_Ceasefire = prepareForDropdown(g_Settings ? g_Settings.Ceasefire : undefined);
 const g_GameSpeeds = prepareForDropdown(g_Settings ? g_Settings.GameSpeeds.filter(speed => !speed.ReplayOnly) : undefined);
+const g_VictoryConditions = prepareForDropdown(g_Settings ? g_Settings.VictoryConditions : undefined);
 const g_PopulationCapacities = prepareForDropdown(g_Settings ? g_Settings.PopulationCapacities : undefined);
 const g_StartingResources = prepareForDropdown(g_Settings ? g_Settings.StartingResources : undefined);
 
 ////////////////////////////////////////////////////////////////////////////////////////////////
 
@@ -64 +63 @@
 // 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 = {};
-
 ////////////////////////////////////////////////////////////////////////////////////////////////
 
 function init(attribs)
 {
     if (!g_Settings)
@@ -224 +220 @@
 
             updateGameAttributes();
         }
 
         var victoryConditions = Engine.GetGUIObjectByName("victoryCondition");
-        var victories = getVictoryConditions();
-        victoryConditions.list = victories.text;
-        victoryConditions.list_data = victories.data;
+        victoryConditions.list = g_VictoryConditions.Title;
+        victoryConditions.list_data = g_VictoryConditions.Name;
         victoryConditions.onSelectionChange = function() {
             if (this.selected != -1)
             {
-                g_GameAttributes.settings.GameType = victories.data[this.selected];
-                g_GameAttributes.settings.VictoryScripts = victories.scripts[this.selected];
+                g_GameAttributes.settings.GameType = g_VictoryConditions.Name[this.selected];
+                g_GameAttributes.settings.VictoryScripts = g_VictoryConditions.Scripts[this.selected];
             }
 
             updateGameAttributes();
         };
-        victoryConditions.selected = VICTORY_DEFAULTIDX;
+        victoryConditions.selected = g_VictoryConditions.Default;
 
         var mapSize = Engine.GetGUIObjectByName("mapSize");
         mapSize.list = g_MapSizes.names;
         mapSize.list_data = g_MapSizes.tiles;
         mapSize.onSelectionChange = function() {
@@ -1221 +1216 @@
     var gameSpeedText = Engine.GetGUIObjectByName("gameSpeedText");
     var gameSpeedBox = Engine.GetGUIObjectByName("gameSpeed");
 
     // We have to check for undefined on these properties as not all maps define them.
     var sizeIdx = (mapSettings.Size !== undefined && g_MapSizes.tiles.indexOf(mapSettings.Size) != -1 ? g_MapSizes.tiles.indexOf(mapSettings.Size) : g_MapSizes["default"]);
-    var victories = getVictoryConditions();
-    var victoryIdx = (mapSettings.GameType !== undefined && victories.data.indexOf(mapSettings.GameType) != -1 ? victories.data.indexOf(mapSettings.GameType) : VICTORY_DEFAULTIDX);
+    var victoryIdx = mapSettings.GameType !== undefined && g_VictoryConditions.Name.indexOf(mapSettings.GameType) != -1 ? g_VictoryConditions.Name.indexOf(mapSettings.GameType) : g_VictoryConditions.Default;
     enableCheats.checked = (mapSettings.CheatsEnabled === undefined || !mapSettings.CheatsEnabled ? false : true);
     enableCheatsText.caption = (enableCheats.checked ? translate("Yes") : translate("No"));
     if (mapSettings.RatingEnabled !== undefined)
     {
         enableRating.checked = mapSettings.RatingEnabled;
@@ -1295 +1289 @@
             numPlayersText.caption = numPlayers;
             mapSizeText.caption = g_MapSizes.names[sizeIdx];
             revealMapText.caption = (mapSettings.RevealMap ? translate("Yes") : translate("No"));
             exploreMapText.caption = (mapSettings.ExporeMap ? translate("Yes") : translate("No"));
             disableTreasuresText.caption = (mapSettings.DisableTreasures ? translate("Yes") : translate("No"));
-            victoryConditionText.caption = victories.text[victoryIdx];
+            victoryConditionText.caption = g_VictoryConditions.Title[victoryIdx];
             lockTeamsText.caption = (mapSettings.LockTeams ? translate("Yes") : translate("No"));
         }
 
         break;
 
@@ -1334 +1328 @@
         {
             // Client
             revealMapText.caption = (mapSettings.RevealMap ? translate("Yes") : translate("No"));
             exploreMapText.caption = (mapSettings.ExploreMap ? translate("Yes") : translate("No"));
             disableTreasuresText.caption = (mapSettings.DisableTreasures ? translate("Yes") : translate("No"));
-            victoryConditionText.caption = victories.text[victoryIdx];
+            victoryConditionText.caption = g_VictoryConditions.Title[victoryIdx];
             lockTeamsText.caption = (mapSettings.LockTeams ? translate("Yes") : translate("No"));
         }
 
         break;
 
@@ -1370 +1364 @@
         numPlayersText.caption = numPlayers;
         mapSizeText.caption = translate("Default");
         revealMapText.caption = (mapSettings.RevealMap ? translate("Yes") : translate("No"));
         exploreMapText.caption = (mapSettings.ExploreMap ? translate("Yes") : translate("No"));
         disableTreasuresText.caption = translate("No");
-        victoryConditionText.caption = victories.text[victoryIdx];
+        victoryConditionText.caption = g_VictoryConditions.Title[victoryIdx];
         lockTeamsText.caption = (mapSettings.LockTeams ? translate("Yes") : translate("No"));
 
         startingResourcesText.caption = translate("Determined by scenario");
         populationCapText.caption = translate("Determined by scenario");
         ceasefireText.caption = translate("Determined by scenario");
@@ -1398 +1392 @@
     // Load the description from the map file, if there is one
     var description = mapSettings.Description ? translate(mapSettings.Description) : translate("Sorry, no description available.");
 
     // Describe the number of players and the victory conditions
     var playerString = sprintf(translatePlural("%(number)s player. ", "%(number)s players. ", numPlayers), { "number": numPlayers });
-    let victory = translate(victories.text[victoryIdx]);
-    if (victoryIdx != VICTORY_DEFAULTIDX)
+    let victory = g_VictoryConditions.Title[victoryIdx];
+    if (victoryIdx != g_VictoryConditions.Default)
         victory = "[color=\"orange\"]" + victory + "[/color]";
     playerString += translate("Victory Condition:") + " " + victory + ".\n\n" + description;
 
     for (let i = 0; i < g_MaxPlayers; ++i)
     {
@@ -1989 +1983 @@
         "tnbp": tnbp,
         "players": players
     };
     Engine.SendRegisterGame(gameData);
 }
-
-function getVictoryConditions()
-{
-    var r = {};
-    r.text = [translate("None")];
-    r.data = ["endless"];
-    r.scripts = [[]];
-    for (var vc in g_VictoryConditions)
-    {
-        r.data.push(vc);
-        r.text.push(g_VictoryConditions[vc].name);
-        r.scripts.push(g_VictoryConditions[vc].scripts);
-    }
-    return r;
-}

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

@@ -9 +9 @@
     <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>

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

@@ -1 @@
-g_VictoryConditions.conquest = {
-    "name" : translate("Conquest"),
-    "description" : translate("Defeat all opponents"),
-    "scripts" : ["scripts/ConquestCommon.js", "scripts/TriggerHelper.js", "scripts/Conquest.js"]
-};

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

@@ -1 @@
-g_VictoryConditions.conquestStructure = {
-    "name" : translate("Conquest Structures"),
-    "description" : translate("Destroy all structures of enemies"),
-    "scripts" : ["scripts/ConquestCommon.js", "scripts/TriggerHelper.js", "scripts/ConquestStructures.js"]
-};

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

@@ -1 @@
-g_VictoryConditions.conquestUnits = {
-    "name" : translate("Conquest Units"),
-    "description" : translate("Destroy all units of enemies"),
-    "scripts" : ["scripts/ConquestCommon.js", "scripts/TriggerHelper.js", "scripts/ConquestUnits.js"]
-};

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

@@ -1 @@
-g_VictoryConditions.wonder = {
-    "name" : translate("Wonder"),
-    "description" : translate("Build a wonder to win"),
-    "scripts" : ["scripts/ConquestCommon.js", "scripts/TriggerHelper.js", "scripts/Conquest.js", "scripts/WonderVictory.js"]
-};

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

@@ -471 +471 @@
                 }
             },
             {
                 "extractor": "json",
                 "filemasks": [
+                    "simulation/data/settings/victory_conditions/*.json"
+                ],
+                "options": {
+                    "keywords": ["Title", "Description"]
+                }
+            },
+            {
+                "extractor": "json",
+                "filemasks": [
                     "simulation/data/settings/starting_resources.json"
                 ],
                 "options": {
                     "keywords": ["Title"],
                     "context": "startingResources"

binaries/data/mods/public/simulation/data/settings/victory_conditions/conquest.json

@@ +1 @@
+{
+    "TranslatedKeys": ["Title", "Description"],
+    "Data":
+    {
+        "Title": "Conquest",
+        "Description": "Defeat all opponents",
+        "Scripts":
+        [
+            "scripts/TriggerHelper.js",
+            "scripts/ConquestCommon.js",
+            "scripts/Conquest.js"
+        ],
+        "Default": true
+    }
+}

binaries/data/mods/public/simulation/data/settings/victory_conditions/conquest_structures.json

@@ +1 @@
+{
+    "TranslatedKeys": ["Title", "Description"],
+    "Data":
+    {
+        "Title": "Conquest Structures",
+        "Description": "Destroy all structures of enemies",
+        "Scripts":
+        [
+            "scripts/TriggerHelper.js",
+            "scripts/ConquestCommon.js",
+            "scripts/ConquestStructures.js"
+        ]
+    }
+}

binaries/data/mods/public/simulation/data/settings/victory_conditions/conquest_units.json

@@ +1 @@
+{
+    "TranslatedKeys": ["Title", "Description"],
+    "Data":
+    {
+        "Title": "Conquest Units",
+        "Description": "Kill all enemy units",
+        "Scripts":
+        [
+            "scripts/TriggerHelper.js",
+            "scripts/ConquestCommon.js",
+            "scripts/ConquestUnits.js"
+        ]
+    }
+}

binaries/data/mods/public/simulation/data/settings/victory_conditions/wonder.json

@@ +1 @@
+{
+    "TranslatedKeys": ["Title", "Description"],
+    "Data":
+    {
+        "Title": "Wonder",
+        "Description": "Build and protect a wonder to win",
+        "Scripts":
+        [
+            "scripts/TriggerHelper.js",
+            "scripts/ConquestCommon.js",
+            "scripts/Conquest.js",
+            "scripts/WonderVictory.js"
+        ]
+    }
+}

source/tools/atlas/AtlasUI/ScenarioEditor/Sections/Map/Map.cpp

@@ -139 +139 @@
     sizer->Add(Tooltipped(new wxTextCtrl(this, ID_MapDescription, wxEmptyString, wxDefaultPosition, wxSize(-1, 100), wxTE_MULTILINE),
             _("Short description used on the map selection screen")), wxSizerFlags().Expand());
 
     sizer->AddSpacer(5);
 
+    // TODO: load from binaries/data/mods/public/simulation/data/settings/victory_conditions/
     wxArrayString gameTypes;
     gameTypes.Add(_T("conquest"));
+    gameTypes.Add(_T("conquestStructures"));
+    gameTypes.Add(_T("conquestUnits"));
     gameTypes.Add(_T("wonder"));
     gameTypes.Add(_T("endless"));
 
     wxFlexGridSizer* gridSizer = new wxFlexGridSizer(2, 5, 5);
     gridSizer->AddGrowableCol(1);