Ticket #3234: wonderOptions_V2.3.patch

binaries/data/mods/public/simulation/components/EndGameManager.js

@@ -17 +17 @@
     this.gameType = "conquest";
     
     // Allied victory means allied players can win if victory conditions are met for each of them
     // Would be false for a "last man standing" game (when diplomacy is fully implemented)
     this.alliedVictory = true;
+
+    this.wonderDuration = 5;
 };
 
 EndGameManager.prototype.GetGameType = function()
 {
     return this.gameType;
@@ -35 +37 @@
 EndGameManager.prototype.CheckGameType = function(type)
 {
     return this.gameType == type;
 };
 
+EndGameManager.prototype.SetWonderDuration = function(wonderDuration)
+{
+    this.wonderDuration = wonderDuration;
+};
+
+EndGameManager.prototype.GetWonderDuration = function()
+{
+    return this.wonderDuration;
+};
+
 EndGameManager.prototype.MarkPlayerAsWon = function(playerID)
 {
     var cmpPlayerManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_PlayerManager);
     var numPlayers = cmpPlayerManager.GetNumPlayers();
     for (var i = 1; i < numPlayers; i++)

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

@@ -6 +6 @@
 const g_MapSizes = prepareForDropdown(g_Settings ? g_Settings.MapSizes : undefined);
 const g_MapTypes = prepareForDropdown(g_Settings ? g_Settings.MapTypes : undefined);
 const g_PopulationCapacities = prepareForDropdown(g_Settings ? g_Settings.PopulationCapacities : undefined);
 const g_StartingResources = prepareForDropdown(g_Settings ? g_Settings.StartingResources : undefined);
 const g_VictoryConditions = prepareForDropdown(g_Settings ? g_Settings.VictoryConditions : undefined);
+const g_WonderDurations = prepareForDropdown(g_Settings ? g_Settings.WonderDurations : undefined);
 
 /**
  * All selectable playercolors except gaia.
  */
 const g_PlayerColors = g_Settings ? g_Settings.PlayerDefaults.slice(1).map(pData => pData.Color) : undefined;
@@ -241 +242 @@
         initNumberOfPlayers();
         initGameSpeed();
         initPopulationCaps();
         initStartingResources();
         initCeasefire();
+        initWonderDurations();
         initVictoryConditions();
         initMapSizes();
         initRadioButtons();
     }
     else
@@ -300 +302 @@
 function resizeMoreOptionsWindow()
 {
     // For singleplayer reduce the size of more options dialog by two options (cheats, rated game = 60px)
     if (!g_IsNetworked)
     {
-        Engine.GetGUIObjectByName("moreOptions").size = "50%-200 50%-195 50%+200 50%+160";
-        Engine.GetGUIObjectByName("hideMoreOptions").size = "50%-70 310 50%+70 336";
+        Engine.GetGUIObjectByName("moreOptions").size = "50%-200 50%-195 50%+200 50%+190";
+        Engine.GetGUIObjectByName("hideMoreOptions").size = "50%-70 340 50%+70 366";
     }
     // For non-lobby multiplayergames reduce the size of the dialog by one option (rated game, 30px)
     else if (!Engine.HasXmppClient())
     {
         Engine.GetGUIObjectByName("moreOptions").size = "50%-200 50%-195 50%+200 50%+190";
-        Engine.GetGUIObjectByName("hideMoreOptions").size = "50%-70 340 50%+70 366";
+        Engine.GetGUIObjectByName("hideMoreOptions").size = "50%-70 370 50%+70 396";
     }
 }
 
 function initNumberOfPlayers()
 {
@@ -399 +401 @@
         updateGameAttributes();
     };
     victoryConditions.selected = g_VictoryConditions.Default;
 }
 
+function initWonderDurations()
+{
+    let wonderConditions = Engine.GetGUIObjectByName("wonderDuration");
+    wonderConditions.list = g_WonderDurations.Title;
+    wonderConditions.list_data = g_WonderDurations.Duration;
+    wonderConditions.selected = g_WonderDurations.Default;
+    wonderConditions.onSelectionChange = function()
+    {
+        if (this.selected != -1)
+            g_GameAttributes.settings.WonderDuration = g_WonderDurations.Duration[this.selected];
+
+        updateGameAttributes();
+    };
+}
+
 function initMapSizes()
 {
     let mapSize = Engine.GetGUIObjectByName("mapSize");
     mapSize.list = g_MapSizes.LongName;
     mapSize.list_data = g_MapSizes.Tiles;
@@ -1236 +1253 @@
     let gameSpeedIdx = g_GameAttributes.gameSpeed !== undefined ? g_GameSpeeds.Speed.indexOf(g_GameAttributes.gameSpeed) : g_GameSpeeds.Default;
 
     // These dropdowns might set the default (as they ignore g_IsInGuiUpdate)
     let mapSizeIdx = mapSettings.Size !== undefined ? g_MapSizes.Tiles.indexOf(mapSettings.Size) : g_MapSizes.Default;
     let victoryIdx = mapSettings.GameType !== undefined ? g_VictoryConditions.Name.indexOf(mapSettings.GameType) : g_VictoryConditions.Default;
+    let wonderDurationIdx = mapSettings.WonderDuration !== undefined ? g_WonderDurations.Duration.indexOf(mapSettings.WonderDuration) : g_WonderDurations.Default;
     let popIdx = mapSettings.PopulationCap !== undefined ? g_PopulationCapacities.Population.indexOf(mapSettings.PopulationCap) : g_PopulationCapacities.Default;
     let startingResIdx = mapSettings.StartingResources !== undefined ? g_StartingResources.Resources.indexOf(mapSettings.StartingResources) : g_StartingResources.Default;
     let ceasefireIdx = mapSettings.Ceasefire !== undefined ? g_Ceasefire.Duration.indexOf(mapSettings.Ceasefire) : g_Ceasefire.Default;
     let numPlayers = mapSettings.PlayerData ? mapSettings.PlayerData.length : g_MaxPlayers;
 
@@ -1252 +1270 @@
         Engine.GetGUIObjectByName("numPlayersSelection").selected = numPlayers - 1;
         Engine.GetGUIObjectByName("victoryCondition").selected = victoryIdx;
         Engine.GetGUIObjectByName("populationCap").selected = popIdx;
         Engine.GetGUIObjectByName("gameSpeed").selected = gameSpeedIdx;
         Engine.GetGUIObjectByName("ceasefire").selected = ceasefireIdx;
+        Engine.GetGUIObjectByName("wonderDuration").selected = wonderDurationIdx;
         Engine.GetGUIObjectByName("startingResources").selected = startingResIdx;
     }
     else
     {
         Engine.GetGUIObjectByName("mapTypeText").caption = g_MapTypes.Title[mapTypeIdx];
@@ -1266 +1285 @@
 
     // Can be visible to both host and clients
     Engine.GetGUIObjectByName("mapSizeText").caption = g_GameAttributes.mapType == "random" ? g_MapSizes.LongName[mapSizeIdx] : translate("Default");
     Engine.GetGUIObjectByName("numPlayersText").caption = numPlayers;
     Engine.GetGUIObjectByName("victoryConditionText").caption = g_VictoryConditions.Title[victoryIdx];
+    Engine.GetGUIObjectByName("wonderDurationText").caption = g_WonderDurations.Title[wonderDurationIdx];
     Engine.GetGUIObjectByName("populationCapText").caption = g_PopulationCapacities.Title[popIdx];
     Engine.GetGUIObjectByName("startingResourcesText").caption = g_StartingResources.Title[startingResIdx];
     Engine.GetGUIObjectByName("ceasefireText").caption = g_Ceasefire.Title[ceasefireIdx];
     Engine.GetGUIObjectByName("gameSpeedText").caption = g_GameSpeeds.Title[gameSpeedIdx];
 
@@ -1278 +1298 @@
     setGUIBoolean("exploreMap", "exploreMapText", !!mapSettings.ExploreMap);
     setGUIBoolean("revealMap", "revealMapText", !!mapSettings.RevealMap);
     setGUIBoolean("lockTeams", "lockTeamsText", !!mapSettings.LockTeams);
     setGUIBoolean("enableRating", "enableRatingText", !!mapSettings.RatingEnabled);
 
+    Engine.GetGUIObjectByName("optionWonderDuration").hidden =
+        g_GameAttributes.settings.GameType &&
+        g_GameAttributes.settings.GameType != "wonder";
+
     Engine.GetGUIObjectByName("cheatWarningText").hidden = !g_IsNetworked || !mapSettings.CheatsEnabled;
 
     Engine.GetGUIObjectByName("enableCheats").enabled = !mapSettings.RatingEnabled;
     Engine.GetGUIObjectByName("lockTeams").enabled = !mapSettings.RatingEnabled;
 
@@ -1292 +1316 @@
     Engine.GetGUIObjectByName("mapSizeText").hidden = !isRandom || g_IsController;
     hideControl("numPlayersSelection", "numPlayersText", isRandom && g_IsController);
 
     let notScenario = g_GameAttributes.mapType != "scenario" && g_IsController ;
     hideControl("victoryCondition", "victoryConditionText", notScenario);
+    hideControl("wonderDuration", "wonderDurationText", notScenario);
     hideControl("populationCap", "populationCapText", notScenario);
     hideControl("startingResources", "startingResourcesText", notScenario);
     hideControl("ceasefire", "ceasefireText", notScenario);
     hideControl("revealMap", "revealMapText", notScenario);
     hideControl("exploreMap", "exploreMapText", notScenario);
@@ -1349 +1374 @@
         pColorPickerHeading.hidden = !canChangeColors;
         if (canChangeColors)
             pColorPicker.selected = g_PlayerColors.findIndex(col => sameColor(col, color));
     }
 
+    resizeMoreOptionsWindow();
+
     g_IsInGuiUpdate = false;
 
     // Game attributes include AI settings, so update the player list
     updatePlayerList();
 
@@ -1367 +1394 @@
 {
     let numPlayers = g_GameAttributes.settings.PlayerData ? g_GameAttributes.settings.PlayerData.length : 0;
     let mapName = g_GameAttributes.map || "";
 
     let victoryIdx = Math.max(0, g_VictoryConditions.Name.indexOf(g_GameAttributes.settings.GameType || ""));
-    let victoryTitle = g_VictoryConditions.Title[victoryIdx];
+    let victoryTitle;
+
+    if (g_VictoryConditions.Name[victoryIdx] == "wonder")
+        victoryTitle = sprintf(
+                translatePluralWithContext(
+                    "victory condition",
+                    "Wonder (%(min)s minute)",
+                    "Wonder (%(min)s minutes)",
+                    g_GameAttributes.settings.WonderDuration
+                ),
+                { "min": g_GameAttributes.settings.WonderDuration }
+        );
+    else
+        victoryTitle = g_VictoryConditions.Title[victoryIdx];
+
     if (victoryIdx != g_VictoryConditions.Default)
         victoryTitle = "[color=\"" + g_VictoryColor + "\"]" + victoryTitle + "[/color]";
 
     let mapDescription = g_GameAttributes.settings.Description ? translate(g_GameAttributes.settings.Description) : translate("Sorry, no description available.");
     if (mapName == "random")

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

@@ -269 +269 @@
             <!-- End Options -->
             </object>
 
             <!-- More Options -->
             <object hidden="true" name="moreOptionsFade" type="image" z="60" sprite="ModernFade"/>
-            <object name="moreOptions" type="image" sprite="ModernDialog" size="50%-200 50%-195 50%+200 50%+220" z="70" hidden="true">
+            <object name="moreOptions" type="image" sprite="ModernDialog" size="50%-200 50%-120 50%+200 50%+220" z="70" hidden="true">
                 <object style="ModernLabelText" type="text" size="50%-128 -18 50%+128 14">
                     <translatableAttribute id="caption">More Options</translatableAttribute>
                 </object>
 
                 <object size="14 38 94% 66">
@@ -324 +324 @@
                     <object name="ceasefire" size="40%+10 0 100% 28" type="dropdown" style="ModernDropDown" hidden="true" tooltip_style="onscreenToolTip">
                         <translatableAttribute id="tooltip">Set time where no attacks are possible.</translatableAttribute>
                     </object>
                 </object>
 
-                <object size="14 188 94% 216">
+                <object name="optionWonderDuration" size="14 188 94% 216">
+                    <object size="0 0 40% 28" type="text" style="ModernRightLabelText">
+                        <translatableAttribute id="caption">Wonder:</translatableAttribute>
+                    </object>
+                    <object name="wonderDurationText" size="40% 0 100% 100%" type="text" style="ModernLeftLabelText"/>
+                    <object name="wonderDuration" size="40%+10 0 100% 28" type="dropdown" style="ModernDropDown" hidden="true" tooltip_style="onscreenToolTip">
+                        <translatableAttribute id="tooltip">Number of minutes that the player has to keep the wonder in order to win.</translatableAttribute>
+                    </object>
+                </object>
+
+                <object size="14 218 94% 246">
                     <object size="0 0 40% 28" type="text" style="ModernRightLabelText">
                         <translatableAttribute id="caption" comment="Make sure to differentiate between the revealed map and explored map options!">Revealed Map:</translatableAttribute>
                     </object>
                     <object name="revealMapText" size="40% 0 100% 28" type="text" style="ModernLeftLabelText"/>
                     <object name="revealMap" size="40%+10 5 40%+30 100%-5" type="checkbox" style="ModernTickBox" hidden="true" tooltip_style="onscreenToolTip">
                         <translatableAttribute id="tooltip" comment="Make sure to differentiate between the revealed map and explored map options!">Toggle revealed map (see everything).</translatableAttribute>
                     </object>
                 </object>
 
-                <object size="14 218 94% 246">
+                <object size="14 248 94% 276">
                     <object size="0 0 40% 28" type="text" style="ModernRightLabelText">
                         <translatableAttribute id="caption" comment="Make sure to differentiate between the revealed map and explored map options!">Explored Map:</translatableAttribute>
                     </object>
                     <object name="exploreMapText" size="40% 0 100% 28" type="text" style="ModernLeftLabelText"/>
                     <object name="exploreMap" size="40%+10 5 40%+30 100%-5" type="checkbox" style="ModernTickBox" hidden="true" tooltip_style="onscreenToolTip">
                         <translatableAttribute id="tooltip" comment="Make sure to differentiate between the revealed map and explored map options!">Toggle explored map (see initial map).</translatableAttribute>
                     </object>
                 </object>
 
-                <object size="14 248 94% 276">
+                <object size="14 278 94% 306">
                     <object size="0 0 40% 28" type="text" style="ModernRightLabelText">
                         <translatableAttribute id="caption">Disable Treasures:</translatableAttribute>
                     </object>
                     <object name="disableTreasuresText" size="40% 0 100% 28" type="text" style="ModernLeftLabelText"/>
                     <object name="disableTreasures" size="40%+10 5 40%+30 100%-5" type="checkbox" style="ModernTickBox" hidden="true" tooltip_style="onscreenToolTip">
                         <translatableAttribute id="tooltip">Disable all treasures on the map.</translatableAttribute>
                     </object>
                 </object>
 
-                <object size="14 278 94% 306">
+                <object size="14 308 94% 336">
                     <object size="0 0 40% 28" type="text" style="ModernRightLabelText">
                         <translatableAttribute id="caption">Teams Locked:</translatableAttribute>
                     </object>
                     <object name="lockTeamsText" size="40% 0 100% 28" type="text" style="ModernLeftLabelText"/>
                     <object name="lockTeams" size="40%+10 5 40%+30 100%-5" type="checkbox" style="ModernTickBox" hidden="true" tooltip_style="onscreenToolTip">
                         <translatableAttribute id="tooltip">Toggle locked teams.</translatableAttribute>
                     </object>
                 </object>
 
-                <object name="optionCheats" size="14 308 94% 336" hidden="true">
+                <object name="optionCheats" size="14 338 94% 366" hidden="true">
                     <object size="0 0 40% 28" type="text" style="ModernRightLabelText">
                         <translatableAttribute id="caption">Cheats:</translatableAttribute>
                     </object>
                     <object name="enableCheatsText" size="40% 0 100% 28" type="text" style="ModernLeftLabelText"/>
                     <object name="enableCheats" size="40%+10 5 40%+30 100%-5" type="checkbox" style="ModernTickBox" hidden="true" tooltip_style="onscreenToolTip">
                         <translatableAttribute id="tooltip">Toggle the usability of cheats.</translatableAttribute>
                     </object>
                 </object>
 
-                <object name="optionRating" size="14 338 94% 366" hidden="true">
+                <object name="optionRating" size="14 368 94% 396" hidden="true">
                     <object size="0 0 40% 28" hidden="false" type="text" style="ModernRightLabelText">
                         <translatableAttribute id="caption">Rated Game:</translatableAttribute>
                     </object>
                     <object name="enableRatingText" size="40% 0 100% 28" type="text" style="ModernLeftLabelText"/>
                     <object name="enableRating" size="40%+10 5 40%+30 100%-5" type="checkbox" style="ModernTickBox" hidden="true" tooltip_style="onscreenToolTip">

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

@@ -30 +30 @@
 {
     var settings = {
         "AIDescriptions": loadAIDescriptions(),
         "AIDifficulties": loadAIDifficulties(),
         "Ceasefire": loadCeasefire(),
+        "WonderDurations": loadWonderDuration(),
         "GameSpeeds": loadSettingValuesFile("game_speeds.json"),
         "MapTypes": loadMapTypes(),
         "MapSizes": loadSettingValuesFile("map_sizes.json"),
         "PlayerDefaults": loadPlayerDefaults(),
         "PopulationCapacities": loadPopulationCapacities(),
@@ -129 +130 @@
         }
     ];
 }
 
 /**
+ * Loads available wonder-victory times
+ */
+function loadWonderDuration()
+{
+    var jsonFile = "wonder_times.json";
+    var json = Engine.ReadJSONFile(g_SettingsDirectory + jsonFile);
+
+    if (!json || json.Default === undefined || !json.Times || !Array.isArray(json.Times))
+    {
+        error("Could not load " + jsonFile);
+        return undefined;
+    }
+
+    return json.Times.map(duration => ({
+        "Duration": duration,
+        "Default": duration == json.Default,
+        "Title": sprintf(translatePluralWithContext("wonder victory", "%(min)s minute", "%(min)s minutes", duration), { "min": duration })
+    }));
+}
+
+/**
  * Loads available ceasefire settings.
  *
  * @returns {Array|undefined}
  */
 function loadCeasefire()

binaries/data/mods/public/simulation/helpers/Setup.js

@@ -47 +47 @@
     }
 
     var cmpEndGameManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_EndGameManager);
     if (settings.GameType)
         cmpEndGameManager.SetGameType(settings.GameType);
+    if (settings.WonderDuration)
+        cmpEndGameManager.SetWonderDuration(settings.WonderDuration * 60 * 1000);
 
     if (settings.Garrison)
     {
         for (let holder in settings.Garrison)
         {

binaries/data/mods/public/simulation/templates/template_structure_wonder.xml

@@ -88 +88 @@
   </Vision>
   <VisualActor>
     <FoundationActor>structures/fndn_6x6.xml</FoundationActor>
   </VisualActor>
   <Wonder>
-    <TimeTillVictory>300</TimeTillVictory>
+    <DurationMultiplier>1</DurationMultiplier>
   </Wonder>
 </Entity>

binaries/data/mods/public/simulation/components/Wonder.js

@@ -1 +1 @@
 function Wonder() {}
 
 Wonder.prototype.Schema = 
-    "<element name='TimeTillVictory'>" +
-        "<data type='nonNegativeInteger'/>" +
+    "<element name='DurationMultiplier' a:help='A civ-specific time-bonus/handicap for the wonder-victory-condition.'>" +
+        "<ref name='nonNegativeDecimal'/>" +
     "</element>";
 
 Wonder.prototype.Init = function()
 {
 };
 
 Wonder.prototype.Serialize = null;
 
-Wonder.prototype.GetTimeTillVictory = function()
+/**
+ * Returns the number of minutes that a player has to keep the wonder in order to win.
+ */
+Wonder.prototype.GetVictoryDuration = function()
 {
-    return +this.template.TimeTillVictory;
+    var cmpEndGameManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_EndGameManager);
+    return cmpEndGameManager.GetWonderDuration() * this.template.DurationMultiplier;
 };
 
 Engine.RegisterComponentType(IID_Wonder, "Wonder", Wonder);

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

@@ +1 @@
+{
+    "Times": [1, 5, 10, 15, 20, 25, 30],
+    "Default": 15
+}

binaries/data/mods/public/maps/scripts/WonderVictory.js

@@ -29 +29 @@
     var players = [-1];
     for (var i = 1; i < numPlayers; i++)
         if (i != data.to)
             players.push(i);
 
-    var time = cmpWonder.GetTimeTillVictory()*1000;
+    var time = cmpWonder.GetVictoryDuration();
     messages.otherMessage = cmpGuiInterface.AddTimeNotification({
         "message": markForTranslation("%(player)s will have won in %(time)s"),
         "players": players,
         "parameters": {"player": cmpPlayer.GetName()},
         "translateMessage": true,