Ticket #3488: 3488.patch

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

@@ -45 +45 @@
                         "<element name='Z'>" +
                             "<data type='decimal'/>" +
                         "</element>" +
+                        "<optional>" +
+                            "<element name='VisibleGarrisonRestrictedClasses'>" +
+                                "<text/>" +
+                            "</element>" +
+                        "</optional>" +
                     "</interleave>" +
                 "</element>" +
             "</zeroOrMore>" +
@@ -72 +77 @@
             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,"restrictedClass" : offset.VisibleGarrisonRestrictedClasses});
         }
     }
 };
 
 /**
+ * Returns an array of restricted classes from the original string.
+ */
+GarrisonHolder.prototype.GetVisibleGarrisonRestrictedClasses = function(classList)
+{
+    if (classList)
+        return classList.split(/\s+/);
+    return [];
+};
+
+/**
  * Return range at which entities can garrison here
  */
 GarrisonHolder.prototype.GetLoadingRange = function()
@@ -100 +115 @@
     return IsOwnedByPlayer(player, ent);
 };
 
-
 /**
  * Return the list of entities garrisoned inside
  */
@@ -221 +235 @@
 };
 
 /**
+ * Returns true if the unit is allowed be visible on that garrison point, false otherwise.
+ */
+GarrisonHolder.prototype.AllowedToVisibleGarrisoning = function(visibleGarrisonPoint)
+{
+    var restrictedClassesList = this.GetVisibleGarrisonRestrictedClasses(visibleGarrisonPoint.restrictedClass);
+    if (!allowedClasses)
+        return false;
+    
+    for (let entityClasses of (Engine.QueryInterface(visibleGarrisonPoint.entity, IID_Identity)).GetClassesList())
+        for (let restrictedClasses of restrictedClassesList)
+            if (entityClasses == restrictedClasses)
+                return false;
+            
+    return true;
+}
+
+/**
  * Garrison a unit inside.
  * Returns true if successful, false if not
  * The timer for AutoHeal is started here
@@ -249 +280 @@
 
     if (visibleGarrisonPoint)
     {
+        let IsAllowed = this.AllowedToVisibleGarrisoning(visibleGarrisonPoint);
         visibleGarrisonPoint.entity = entity;
-        cmpPosition.SetTurretParent(this.entity, visibleGarrisonPoint.offset);
-        let cmpUnitAI = Engine.QueryInterface(entity, IID_UnitAI);
-        if (cmpUnitAI)
-            cmpUnitAI.SetTurretStance();
+        
+        if (IsAllowed)
+        {
+            cmpPosition.SetTurretParent(this.entity, visibleGarrisonPoint.offset);
+            let cmpUnitAI = Engine.QueryInterface(entity, IID_UnitAI);
+            if (cmpUnitAI)
+                cmpUnitAI.SetTurretStance();
+        }
+        else
+        {
+            cmpPosition.MoveOutOfWorld();
+        }
     }
     else
         cmpPosition.MoveOutOfWorld();
@@ -713 +753 @@
     }
 };
 
-
 /**
  * Eject all foreign garrisoned entities which are no more allied
  */