Ticket #2160: regicide_garrison_option_v2.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();
@@ -89 +92 @@
 
             hero = hero[0];
 
+            if (!this.regicideGarrison && !isShip)
+                QueryPlayerIDInterface(playerID).AddDisabledGarrisonClass("Hero");
+
             if (isShip)
             {
                 let cmpUnitAI = Engine.QueryInterface(hero, IID_UnitAI);
@@ -102 +108 @@
     return undefined;
 };
 
+Trigger.prototype.CheckRegicideHeroGarrison = function(data)
+{
+    if (!data.removed.length)
+        return;
+
+    if (this.regicideHeroes.indexOf(data.removed[0]) == -1 || this.regicideGarrison)
+        return;
+
+    QueryOwnerInterface(data.removed[0]).AddDisabledGarrisonClass("Hero");
+};
+
 let cmpTrigger = Engine.QueryInterface(SYSTEM_ENTITY, IID_Trigger);
 cmpTrigger.regicideHeroes = [];
+cmpTrigger.regicideGarrison = false;
 cmpTrigger.DoAfterDelay(0, "InitRegicideGame", {});
 cmpTrigger.RegisterTrigger("OnOwnershipChanged", "CheckRegicideDefeat", { "enabled": true });
+cmpTrigger.RegisterTrigger("OnGarrisonedUnitsChanged", "CheckRegicideHeroGarrison", { "enabled": true });

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

@@ -111 +111 @@
 
 /**
  * Returns an array of unit classes which can be garrisoned inside this
- * particualar entity. Obtained from the entity's template
+ * particualar entity.
  */
 GarrisonHolder.prototype.GetAllowedClasses = function()
 {
-    return this.template.List._string;
+    let allowedClasses = this.template.List._string.split(/\s+/);
+    let disabledClasses = QueryOwnerInterface(this.entity).GetDisabledGarrisonClasses();
+    let classes = [];
+
+    for (let className of allowedClasses)
+    {
+        for (let disabled of disabledClasses)
+            className += "+!" + disabled;
+        classes.push(className);
+    }
+
+    return classes;
 };
 
 /**
@@ -200 +211 @@
     if (!cmpIdentity)
         return false;
     var entityClasses = cmpIdentity.GetClassesList();
+    let cmpPlayer = QueryOwnerInterface(entity);
+    if (cmpPlayer && entityClasses.some(className => cmpPlayer.GetDisabledGarrisonClasses().indexOf(className) != -1))
+        return false;
+
     return MatchesClassList(entityClasses, this.template.List._string);
 };
 

binaries/data/mods/public/simulation/components/interfaces/Trigger.js

@@ -11 +11 @@
  * sent from Player component.
  */
 Engine.RegisterMessageType("DisabledTechnologiesChanged");
+
+/**
+ * Message of the form {}
+ * sent from Player component.
+ */
+Engine.RegisterMessageType("DisabledGarrisonClassesChanged");

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

@@ -53 +53 @@
     this.disabledTemplates = {};
     this.disabledTechnologies = {};
     this.startingTechnologies = [];
+    this.disabledGarrisonClasses = [];
 };
 
 Player.prototype.SetPlayerID = function(id)
@@ -853 +854 @@
     this.startingTechnologies = techs;
 };
 
+Player.prototype.AddDisabledGarrisonClass = function(className)
+{
+    if (this.disabledGarrisonClasses.indexOf(className) != -1)
+        return;
+    this.disabledGarrisonClasses.push(className);
+    Engine.BroadcastMessage(MT_DisabledGarrisonClassesChanged, {});
+};
+
+Player.prototype.RemoveDisabledGarrisonClass = function(className)
+{
+    this.disabledGarrisonClasses.splice(this.disabledGarrisonClasses.indexOf(className), 1);
+    Engine.BroadcastMessage(MT_DisabledGarrisonClassesChanged, {});
+};
+
+Player.prototype.SetDisabledGarrisonClasses = function(classes)
+{
+    this.disabledGarrisonClasses = classes;
+    Engine.BroadcastMessage(MT_DisabledGarrisonClassesChanged, {});
+};
+
+Player.prototype.GetDisabledGarrisonClasses = function()
+{
+    return this.disabledGarrisonClasses;
+};
+
 Engine.RegisterComponentType(IID_Player, "Player", Player);

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(playerEnt, IID_Player, {
+    "IsAlly": (id) =>  id == 1,
+    "IsEnemy": (id) =>  id != 1,
+    "GetPlayerID": () =>  1,
+    "GetDisabledGarrisonClasses": () => [],
+    "QueryOwnerInterface": (unitEnt) => playerEnt,
+});
+
+AddMock(unitEnt, IID_Identity, {
+    "GetClassesList": () => ["Hero", "Infantry"],
+    "GetVisibleClassesList": () => ["Hero", "Infantry"],
+    "HasClass": () => 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_EQUALS(cmpGarrisonHolder.GetAllowedClasses().length, 3);
+
+cmpPlayer.AddDisabledGarrisonClass("Hero");
+TS_ASSERT(cmpGarrisonHolder.GetAllowedClasses(unitEnt)[0].indexOf("!Hero") != 1);

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

@@ -1 +1 @@
 Engine.LoadHelperScript("ValueModification.js");
-Engine.LoadComponentScript("interfaces/EndGameManager.js")
-Engine.LoadComponentScript("interfaces/TechnologyManager.js")
-Engine.LoadComponentScript("interfaces/Timer.js")
-Engine.LoadComponentScript("EndGameManager.js")
+Engine.LoadComponentScript("interfaces/EndGameManager.js");
+Engine.LoadComponentScript("interfaces/TechnologyManager.js");
+Engine.LoadComponentScript("interfaces/Timer.js");
+Engine.LoadComponentScript("interfaces/Trigger.js");
+Engine.LoadComponentScript("interfaces/Player.js");
+Engine.LoadComponentScript("EndGameManager.js");
 Engine.LoadComponentScript("Player.js");
-Engine.LoadComponentScript("Timer.js")
+Engine.LoadComponentScript("Timer.js");
 
 ConstructComponent(SYSTEM_ENTITY, "EndGameManager");
 ConstructComponent(SYSTEM_ENTITY, "Timer");
 
-var cmpPlayer = ConstructComponent(10, "Player");
+let playerEntity = 1;
+let cmpPlayer = ConstructComponent(playerEntity, "Player");
 
 TS_ASSERT_EQUALS(cmpPlayer.GetPopulationCount(), 0);
 TS_ASSERT_EQUALS(cmpPlayer.GetPopulationLimit(), 0);
+TS_ASSERT_EQUALS(cmpPlayer.GetDisabledGarrisonClasses().length, 0);
+
+cmpPlayer.AddDisabledGarrisonClass("Champion");
+TS_ASSERT_EQUALS(cmpPlayer.GetDisabledGarrisonClasses().length, 1);
+TS_ASSERT_EQUALS(cmpPlayer.GetDisabledGarrisonClasses()[0], "Champion");
+
+cmpPlayer.AddDisabledGarrisonClass("Hero");
+TS_ASSERT_EQUALS(cmpPlayer.GetDisabledGarrisonClasses().length, 2);
+TS_ASSERT_EQUALS(cmpPlayer.GetDisabledGarrisonClasses()[1], "Hero");
+
+cmpPlayer.RemoveDisabledGarrisonClass("Champion");
+TS_ASSERT_EQUALS(cmpPlayer.GetDisabledGarrisonClasses().length, 1);
+TS_ASSERT_EQUALS(cmpPlayer.GetDisabledGarrisonClasses()[0], "Hero");
+TS_ASSERT_EQUALS(cmpPlayer.GetDisabledGarrisonClasses().length, 1);
+
+cmpPlayer.SetDisabledGarrisonClasses(["Champion", "Elephant"]);
+TS_ASSERT_EQUALS(cmpPlayer.GetDisabledGarrisonClasses().indexOf("Hero"), -1);
+TS_ASSERT_EQUALS(cmpPlayer.GetDisabledGarrisonClasses().length, 2);
+TS_ASSERT_EQUALS(cmpPlayer.GetDisabledGarrisonClasses()[1], "Elephant");

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

@@ -11 +11 @@
     "CinemaPathEnded",
     "CinemaQueueEnded",
     "ConstructionStarted",
+    "GarrisonedUnitsChanged",
     "Interval",
     "OwnershipChanged",
     "PlayerCommand",
@@ -265 +266 @@
     this.CallEvent("PlayerWon", msg);
 };
 
+Trigger.prototype.OnGlobalGarrisonedUnitsChanged = function(msg)
+{
+    this.CallEvent("GarrisonedUnitsChanged", msg);
+};
+
 /**
  * Execute a function after a certain delay.
  *

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);