Ticket #3488: 3488.2.patch

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
  */
@@ -221 +228 @@
 };
 
 /**
+ * Returns an array of restricted classes from the original string.
+ */
+GarrisonHolder.prototype.GetVisibleGarrisonAllowedClasses = function(classList)
+{
+    if (classList)
+    return classList._string.split(/\s+/);
+
+    return [];
+};
+
+/**
+ * Returns true if the unit is allowed be visible on that garrison point, false otherwise.
+ */
+GarrisonHolder.prototype.AllowedToVisibleGarrisoning = function(visibleGarrisonPoint)
+{
+    var allowedClassesList = this.GetVisibleGarrisonAllowedClasses(visibleGarrisonPoint.allowedClass); 
+    //If classlist is empty, everybody can garrison.
+    if (!allowedClassesList) 
+        return true; 
+
+    var entityClasses = (Engine.QueryInterface(visibleGarrisonPoint.entity, IID_Identity)).GetClassesList(); 
+        for (let allowedClasses of allowedClassesList)       
+            if(entityClasses.indexOf(allowedClasses) == -1)
+                return false
+           
+    return true; 
+}
+
+/**
  * Garrison a unit inside.
  * Returns true if successful, false if not
  * The timer for AutoHeal is started here
@@ -246 +282 @@
             break;
         }
     }
-
     if (visibleGarrisonPoint)
     {
         visibleGarrisonPoint.entity = entity;
-        cmpPosition.SetTurretParent(this.entity, visibleGarrisonPoint.offset);
-        let cmpUnitAI = Engine.QueryInterface(entity, IID_UnitAI);
-        if (cmpUnitAI)
-            cmpUnitAI.SetTurretStance();
+        let IsAllowed = this.AllowedToVisibleGarrisoning(visibleGarrisonPoint);
+    
+        if (IsAllowed)
+        {
+            cmpPosition.SetTurretParent(this.entity, visibleGarrisonPoint.offset);
+            let cmpUnitAI = Engine.QueryInterface(entity, IID_UnitAI);
+            if (cmpUnitAI)
+                cmpUnitAI.SetTurretStance();
+        }
+        else
+        {
+      visibleGarrisonPoint.entity = undefined; // We have to undefine the garrison point else it's marked as used.
+            cmpPosition.MoveOutOfWorld();
+        }
     }
     else
         cmpPosition.MoveOutOfWorld();
-
     return true;
 };
 
@@ -713 +757 @@
     }
 };
 
-
 /**
  * Eject all foreign garrisoned entities which are no more allied
  */