Ticket #2160: regicide_garrison_option_v3.patch

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

@@ -498 +498 @@
         "ExploreMap": "exploreMap",
         "DisableTreasures": "disableTreasures",
         "LockTeams": "lockTeams",
-        "LastManStanding" : "lastManStanding",
+        "LastManStanding": "lastManStanding",
+        "RegicideGarrison": "regicideGarrison",
         "CheatsEnabled": "enableCheats"
     };
 
@@ -1183 +1184 @@
     {
         delete g_GameAttributes.settings.WonderDuration;
         delete g_GameAttributes.settings.LastManStanding;
+        delete g_GameAttributes.settings.RegicideGarrison;
     }
 
     if (mapSettings.PlayerData)
@@ -1380 +1382 @@
     setGUIBoolean("revealMap", "revealMapText", !!mapSettings.RevealMap);
     setGUIBoolean("lockTeams", "lockTeamsText", !!mapSettings.LockTeams);
     setGUIBoolean("lastManStanding", "lastManStandingText", !!mapSettings.LastManStanding);
+    setGUIBoolean("regicideGarrison", "regicideGarrisonText", !!mapSettings.RegicideGarrison);
     setGUIBoolean("enableRating", "enableRatingText", !!mapSettings.RatingEnabled);
 
     Engine.GetGUIObjectByName("optionWonderDuration").hidden =
@@ -1386 +1389 @@
         g_GameAttributes.settings.GameType &&
         g_GameAttributes.settings.GameType != "wonder";
     Engine.GetGUIObjectByName("optionLastManStanding").hidden = mapSettings.LockTeams;
+    Engine.GetGUIObjectByName("optionRegicideGarrison").hidden =
+        g_GameAttributes.settings.GameType &&
+        g_GameAttributes.settings.GameType != "regicide";
 
     Engine.GetGUIObjectByName("cheatWarningText").hidden = !g_IsNetworked || !mapSettings.CheatsEnabled;
 
@@ -1403 +1409 @@
 
     for (let ctrl of ["victoryCondition", "wonderDuration", "populationCap",
                       "startingResources", "ceasefire", "revealMap",
-                      "exploreMap", "disableTreasures", "lockTeams", "lastManStanding"])
+                      "exploreMap", "disableTreasures", "lockTeams",
+                      "lastManStanding", "regicideGarrison"])
         hideControl(ctrl, ctrl + "Text", notScenario);
 
     Engine.GetGUIObjectByName("civResetButton").hidden = !notScenario;

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

@@ -335 +335 @@
                     </object>
                 </object>
 
-                <object name="optionPopulationCap" size="14 98 94% 126">
+                <object name="optionRegicideGarrison" size="14 98 94% 126">
                     <object size="0 0 40% 28" type="text" style="ModernRightLabelText">
+                        <translatableAttribute id="caption">Hero Garrison:</translatableAttribute>
+                    </object>
+                    <object name="regicideGarrisonText" size="40% 0 100% 28" type="text" style="ModernLeftLabelText"/>
+                    <object name="regicideGarrison" size="40%+10 5 40%+30 100%-5" type="checkbox" style="ModernTickBox" hidden="true" tooltip_style="onscreenToolTip">
+                        <translatableAttribute id="tooltip">Toggle whether heroes can be garrisoned.</translatableAttribute>
+                    </object>
+                </object>
+
+                <object name="optionPopulationCap" size="14 128 94% 156">
+                    <object size="0 0 40% 28" type="text" style="ModernRightLabelText">
                         <translatableAttribute id="caption">Population Cap:</translatableAttribute>
                     </object>
                     <object name="populationCapText" size="40% 0 100% 100%" type="text" style="ModernLeftLabelText"/>
@@ -345 +355 @@
                     </object>
                 </object>
 
-                <object name="optionStartingResources" size="14 128 94% 156">
+                <object name="optionStartingResources" size="14 158 94% 186">
                     <object size="0 0 40% 28" type="text" style="ModernRightLabelText">
                         <translatableAttribute id="caption">Starting Resources:</translatableAttribute>
                     </object>
@@ -355 +365 @@
                     </object>
                 </object>
 
-                <object name="optionCeasefire" size="14 158 94% 186">
+                <object name="optionCeasefire" size="14 188 94% 216">
                     <object size="0 0 40% 28" type="text" style="ModernRightLabelText">
                         <translatableAttribute id="caption">Ceasefire:</translatableAttribute>
                     </object>
@@ -440 +450 @@
                     name="hideMoreOptions"
                     type="button"
                     style="StoneButton"
-                    size="50%-70 428 50%+70 456"
+                    size="50%-70 458 50%+70 486"
                     tooltip_style="onscreenToolTip"
                     hotkey="cancel"
                 >

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

@@ -6 +6 @@
 
 Trigger.prototype.InitRegicideGame = function(msg)
 {
+    let cmpEndGameManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_EndGameManager);
+    this.regicideGarrison = cmpEndGameManager.GetGameTypeSettings().regicideGarrison;
+
     let playersCivs = [];
     for (let playerID = 1; playerID < TriggerHelper.GetNumberOfPlayers(); ++playerID)
         playersCivs[playerID] = QueryPlayerIDInterface(playerID).GetCiv();
@@ -30 +33 @@
 
         if (heroTemplates[identity.Civ].indexOf(templateName) == -1)
             heroTemplates[identity.Civ].push({
-                "templateName": templateName,
+                "templateName": this.regicideGarrison ? templateName : "regicide_hero_ungarrisonable|" + templateName,
                 "classes": classes
             });
     }
@@ -104 +107 @@
 
 let cmpTrigger = Engine.QueryInterface(SYSTEM_ENTITY, IID_Trigger);
 cmpTrigger.regicideHeroes = [];
+cmpTrigger.regicideGarrison = false;
 cmpTrigger.DoAfterDelay(0, "InitRegicideGame", {});
 cmpTrigger.RegisterTrigger("OnOwnershipChanged", "CheckRegicideDefeat", { "enabled": true });

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

@@ -200 +200 @@
     if (!cmpIdentity)
         return false;
     var entityClasses = cmpIdentity.GetClassesList();
-    return MatchesClassList(entityClasses, this.template.List._string);
+    return MatchesClassList(entityClasses, this.template.List._string) && cmpIdentity.GetCanGarrison();
 };
 
 /**

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

@@ -91 +91 @@
         "<element name='RequiredTechnology' a:help='Optional name of a technology which must be researched before the entity can be produced'>" +
             "<text/>" +
         "</element>" +
+    "</optional>" +
+    "<optional>" +
+        "<element name='CanGarrison' a:help='If the entity can garrison'>" +
+            "<data type='boolean'/>" +
+        "</element>" +
     "</optional>";
 
 
@@ -168 +173 @@
     return this.template.GenericName;
 };
 
+Identity.prototype.GetCanGarrison = function()
+{
+    return this.template.CanGarrison == "true";
+};
+
 Engine.RegisterComponentType(IID_Identity, "Identity", Identity);

binaries/data/mods/public/simulation/components/tests/test_GarrisonHolder.js

@@ +1 @@
+Engine.LoadHelperScript("Player.js");
+Engine.LoadHelperScript("ValueModification.js");
+Engine.LoadComponentScript("interfaces/GarrisonHolder.js");
+Engine.LoadComponentScript("interfaces/Health.js");
+Engine.LoadComponentScript("interfaces/Trigger.js");
+Engine.LoadComponentScript("interfaces/Player.js");
+Engine.LoadComponentScript("GarrisonHolder.js");
+Engine.LoadComponentScript("Identity.js");
+Engine.LoadComponentScript("Player.js");
+Engine.LoadComponentScript("PlayerManager.js");
+
+let garrisonEnt = 15;
+let unitEnt = 33;
+let entHP = 1000;
+let playerEnt = 1;
+
+AddMock(SYSTEM_ENTITY, IID_PlayerManager, {
+    "GetPlayerByID": (id) => playerEnt,
+});
+
+AddMock(garrisonEnt, IID_Health, {
+    "GetHitpoints": () => entHP,
+    "Decrease": hp => {
+        entHP = Math.max(entHP - hp, 0);
+    },
+});
+
+AddMock(unitEnt, IID_Identity, {
+    "GetClassesList": () => ["Hero", "Infantry"],
+    "GetVisibleClassesList": () => ["Hero", "Infantry"],
+    "HasClass": () => true,
+    "GetCanGarrison": () => true,
+});
+
+AddMock(garrisonEnt, IID_Ownership, {
+    "GetOwner": () => playerEnt,
+});
+
+AddMock(playerEnt, IID_Ownership, {
+    "GetOwner": () => playerEnt,
+});
+
+let cmpGarrisonHolder = ConstructComponent(garrisonEnt, "GarrisonHolder", {
+    "LoadingRange": "2.0",
+    "Max": "20",
+    "List": { "_string": "Support Infantry Cavalry"},
+    "entity": garrisonEnt,
+});
+
+let cmpPlayer = ConstructComponent(playerEnt, "Player")
+
+TS_ASSERT_EQUALS(cmpGarrisonHolder.GetGarrisonedEntitiesCount(), 0);
+TS_ASSERT_EQUALS(cmpGarrisonHolder.entities.length, 0);
+TS_ASSERT_EQUALS(cmpGarrisonHolder.visibleGarrisonPoints.length, 0);
+TS_ASSERT_EQUALS(+cmpGarrisonHolder.template.Max, 20);
+TS_ASSERT_EQUALS(cmpGarrisonHolder.GetLoadingRange().max, 2.0);
+TS_ASSERT_EQUALS(cmpGarrisonHolder.IsGarrisoningAllowed(), true);
+TS_ASSERT_EQUALS(cmpGarrisonHolder.AllowedToGarrison(unitEnt), true);
+TS_ASSERT(cmpGarrisonHolder.GetAllowedClasses().indexOf("Infantry") != -1);

binaries/data/mods/public/simulation/components/tests/test_Identity.js

@@ +1 @@
+Engine.LoadHelperScript("Player.js");
+Engine.LoadHelperScript("ValueModification.js");
+Engine.LoadComponentScript("interfaces/Health.js");
+Engine.LoadComponentScript("interfaces/Trigger.js");
+Engine.LoadComponentScript("interfaces/Player.js");
+Engine.LoadComponentScript("Identity.js");
+Engine.LoadComponentScript("Player.js");
+Engine.LoadComponentScript("PlayerManager.js");
+
+let unitEnt = 33;
+let playerEnt = 1;
+
+AddMock(SYSTEM_ENTITY, IID_PlayerManager, {
+    "GetPlayerByID": (id) => playerEnt,
+});
+
+AddMock(playerEnt, IID_Ownership, {
+    "GetOwner": () => playerEnt,
+});
+
+let cmpIdentity = ConstructComponent(unitEnt, "Identity", {
+    "Classes": "Infantry Champion",
+    "VisibleClasses": "Champion",
+    "Civ": "athen",
+    "entity": unitEnt,
+    "CanGarrison": "true",
+});
+
+TS_ASSERT_EQUALS(cmpIdentity.GetCiv(), "athen");
+TS_ASSERT_EQUALS(cmpIdentity.GetGender(), "male");
+TS_ASSERT_EQUALS(cmpIdentity.GetLang(), "greek");
+TS_ASSERT_EQUALS(cmpIdentity.GetCanGarrison(), true);

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

@@ -47 +47 @@
     let gameTypeSettings = {};
     if (settings.WonderDuration)
         gameTypeSettings.wonderDuration = settings.WonderDuration * 60 * 1000;
+    if (settings.GameType == "regicide")
+        gameTypeSettings.regicideGarrison = settings.RegicideGarrison;
     if (settings.GameType)
         cmpEndGameManager.SetGameType(settings.GameType, gameTypeSettings);
 

binaries/data/mods/public/simulation/templates/special_filter/regicide_hero_ungarrisonable.xml

@@ +1 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Entity merge="">
+  <Identity merge="">
+    <CanGarrison>false</CanGarrison>
+  </Identity>
+</Entity>

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

@@ -36 +36 @@
     <Unhealable>false</Unhealable>
   </Health>
   <Identity>
+    <CanGarrison>true</CanGarrison>
     <GenericName>Unit</GenericName>
     <Classes datatype="tokens">Unit ConquestCritical</Classes>
     <Formations datatype="tokens">