Ticket #4291: unitAI_isGarrisoned_v2.patch

binaries/data/mods/public/gui/session/utility_functions.js

@@ -110 +110 @@
  * Returns the entity itself except when garrisoned where it returns its garrisonHolder
  */
 function getEntityOrHolder(ent)
 {
     var entState = GetEntityState(ent);
-    if (entState && !entState.position && entState.unitAI && entState.unitAI.orders.length &&
-            (entState.unitAI.orders[0].type == "Garrison" || entState.unitAI.orders[0].type == "Autogarrison"))
-        return entState.unitAI.orders[0].data.target;
+    if (entState && !entState.position && entState.unitAI)
+        return entState.unitAI.isGarrisoned;
 
     return ent;
 }
 
 /**

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

@@ -251 +251 @@
 
     // Check if the unit is allowed to be garrisoned inside the building
     if(!this.AllowedToGarrison(entity))
         return false;
 
-    // check the capacity
+    // Check the capacity
     var extraCount = 0;
     var cmpGarrisonHolder = Engine.QueryInterface(entity, IID_GarrisonHolder);
     if (cmpGarrisonHolder)
         extraCount += cmpGarrisonHolder.GetGarrisonedEntitiesCount();
     if (this.GetGarrisonedEntitiesCount() + extraCount >= this.GetCapacity())
@@ -276 +276 @@
 
     var cmpAura = Engine.QueryInterface(entity, IID_Auras);
     if (cmpAura && cmpAura.HasGarrisonAura())
         cmpAura.ApplyGarrisonBonus(this.entity);
 
+    // Let entities recall their garrison holder
+    var cmpUnitAI = Engine.QueryInterface(entity, IID_UnitAI);
+    if (cmpUnitAI)
+        cmpUnitAI.SetGarrisoned(this.entity);
+
     Engine.PostMessage(this.entity, MT_GarrisonedUnitsChanged, { "added" : [entity], "removed": [] });
 
-    var cmpUnitAI = Engine.QueryInterface(entity, IID_UnitAI);
     if (cmpUnitAI && cmpUnitAI.IsUnderAlert())
         Engine.PostMessage(cmpUnitAI.GetAlertRaiser(), MT_UnitGarrisonedAfterAlert, {"holder": this.entity, "unit": entity});
 
     return true;
 };
@@ -735 +739 @@
         return;
 
     for (let ent of this.initGarrison)
     {
         let cmpUnitAI = Engine.QueryInterface(ent, IID_UnitAI);
-        if (cmpUnitAI && cmpUnitAI.CanGarrison(this.entity) && this.Garrison(ent))
-            cmpUnitAI.SetGarrisoned();
+        if (cmpUnitAI && cmpUnitAI.CanGarrison(this.entity))
+            this.Garrison(ent);
     }
     this.initGarrison = undefined;
 };
 
 Engine.RegisterComponentType(IID_GarrisonHolder, "GarrisonHolder", GarrisonHolder);

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

@@ -372 +372 @@
             "hasWorkOrders": cmpUnitAI.HasWorkOrders(),
             "canGuard": cmpUnitAI.CanGuard(),
             "isGuarding": cmpUnitAI.IsGuardOf(),
             "possibleStances": cmpUnitAI.GetPossibleStances(),
             "isIdle":cmpUnitAI.IsIdle(),
+            "isGarrisoned": cmpUnitAI.IsGarrisoned()
         };
         // Add some information needed for ungarrisoning
         if (cmpUnitAI.IsGarrisoned() && ret.player !== undefined)
             ret.template = "p" + ret.player + "&" + ret.template;
     }

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

@@ -81 +81 @@
         cmpPromotedUnitAI.SetHeldPosition(pos.x, pos.z);
     if (cmpCurrentUnitAI.GetStanceName())
         cmpPromotedUnitAI.SwitchToStance(cmpCurrentUnitAI.GetStanceName());
 
     var orders = cmpCurrentUnitAI.GetOrders();
-    if (cmpCurrentUnitAI.IsGarrisoned())
-        cmpPromotedUnitAI.SetGarrisoned();
+    cmpPromotedUnitAI.SetGarrisoned(cmpCurrentUnitAI.IsGarrisoned());
+
     if (cmpCurrentUnitPosition.IsInWorld()) // do not cheer if not visibly garrisoned
         cmpPromotedUnitAI.Cheer();  
     cmpPromotedUnitAI.AddOrders(orders);
 
     var workOrders = cmpCurrentUnitAI.GetWorkOrders();

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

@@ -2997 +2997 @@
                         {
                             var cmpGarrisonHolder = Engine.QueryInterface(target, IID_GarrisonHolder);
                             // Check that garrisoning succeeds
                             if (cmpGarrisonHolder.Garrison(this.entity))
                             {
-                                this.isGarrisoned = true;
-
                                 if (this.formationController)
                                 {
                                     var cmpFormation = Engine.QueryInterface(this.formationController, IID_Formation);
                                     if (cmpFormation)
                                     {
@@ -3078 +3076 @@
             },
         },
 
         "AUTOGARRISON": {
             "enter": function() {
-                this.isGarrisoned = true;
                 return false;
             },
 
             "leave": function() {
             }
@@ -3422 +3419 @@
 UnitAI.prototype.IsGarrisoned = function()
 {
     return this.isGarrisoned;
 };
 
-UnitAI.prototype.SetGarrisoned = function()
+UnitAI.prototype.SetGarrisoned = function(target)
 {
-    this.isGarrisoned = true;
+    this.isGarrisoned = target;
 };
 
 UnitAI.prototype.IsFleeing = function()
 {
     var state = this.GetCurrentState().split(".").pop();