Ticket #3488: 3488.3.diff

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

@@ -45 +45 @@
                         "<element name='Z'>" +
                             "<data type='decimal'/>" +
                         "</element>" +
+                        "<optional>" +
+                            "<element name='VisibleGarrisonAllowedClasses'>" +
+                                "<attribute name='datatype'>" +
+                                    "<value>tokens</value>" +
+                                "</attribute>" +
+                                "<text/>" +
+                            "</element>" +
+                        "</optional>" +
                     "</interleave>" +
                 "</element>" +
             "</zeroOrMore>" +
@@ -72 +80 @@
             o.x = +offset.X;
             o.y = +offset.Y;
             o.z = +offset.Z;
-            this.visibleGarrisonPoints.push({"offset":o, "entity": null});
+            this.visibleGarrisonPoints.push({"offset":o, "entity": null,"allowedClass" : offset.VisibleGarrisonAllowedClasses});
         }
     }
 };
@@ -100 +108 @@
     return IsOwnedByPlayer(player, ent);
 };
 
-
 /**
  * Return the list of entities garrisoned inside
  */
@@ -203 +210 @@
     return MatchesClassList(entityClasses, this.template.List._string);
 };
 
+
 /**
+ * Returns true if the unit is allowed be visible on that garrison point, false otherwise.
+ */
+GarrisonHolder.prototype.AllowedToVisibleGarrisoning = function(visibleGarrisonPoint)
+{
+    var allowedClassesList = visibleGarrisonPoint.allowedClass._string; 
+    //If classlist is empty, everybody can garrison.
+    if (!allowedClassesList) 
+        return true; 
+    
+    return MatchesClassList((Engine.QueryInterface(visibleGarrisonPoint.entity, IID_Identity)).GetClassesList(), allowedClassesList);
+}
+
+/**
  * Garrison a unit inside.
  * Returns true if successful, false if not
  * The timer for AutoHeal is started here
@@ -229 +250 @@
             break;
         }
     }
-
     if (visibleGarrisonPoint)
     {
         visibleGarrisonPoint.entity = entity;
-        cmpPosition.SetTurretParent(this.entity, visibleGarrisonPoint.offset);
-        let cmpUnitAI = Engine.QueryInterface(entity, IID_UnitAI);
-        if (cmpUnitAI)
-            cmpUnitAI.SetTurretStance();
+    
+        if (this.AllowedToVisibleGarrisoning(visibleGarrisonPoint))
+        {
+            cmpPosition.SetTurretParent(this.entity, visibleGarrisonPoint.offset);
+            let cmpUnitAI = Engine.QueryInterface(entity, IID_UnitAI);
+            if (cmpUnitAI)
+                cmpUnitAI.SetTurretStance();
+        }
+        else
+        {
+            cmpPosition.MoveOutOfWorld();
+        }
     }
     else
         cmpPosition.MoveOutOfWorld();
-
     return true;
 };
 
@@ -634 +661 @@
 
 /**
  * Update list of garrisoned entities if one gets renamed (e.g. by promotion)
+ * vgpEntity is only defined in some peculiar case where we want to reuse the same visibleGarrisonPoint,
+ * in case of promotion for example, and thus should always be allowed. 
  */
 GarrisonHolder.prototype.OnGlobalEntityRenamed = function(msg)
 {
@@ -670 +699 @@
     }
 };
 
-
 /**
  * Eject all foreign garrisoned entities which are no more allied
  */