Ticket #1184: garrisonfix-03042012.patch

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

@@ -1 +1 @@
 function GarrisonHolder() {}
 
 GarrisonHolder.prototype.Schema =
-    "<element name='Max'>" +
+    "<element name='Max' a:help='Maximum number of entities which can be garrisoned inside this holder'>" +
         "<data type='positiveInteger'/>" +
     "</element>" +
-    "<element name='List'>" +
+    "<element name='List' a:help='Classes of entities which are allowed to garrison inside this holder (from Identity)'>" +
         "<attribute name='datatype'>" +
             "<value>tokens</value>" +
         "</attribute>" +
         "<text/>" +
     "</element>" +
-    "<element name='EjectHealth'>" +
+    "<element name='EjectHealth' a:help='Percentage of maximum health below which point this entity no longer allows garrisoning'>" +
         "<ref name='nonNegativeDecimal'/>" +
     "</element>" + 
-    "<element name='BuffHeal'>" +
+    "<element name='BuffHeal' a:help='How many hit points will be restored every second'>" +
         "<data type='positiveInteger'/>" +
-    "</element>";
+    "</element>" +
+    "<optional>" +
+        "<element name='LoadingRange' a:help='The maximum distance from this garrison holder at which entities are allowed to garrison (should be at least 2 since entities cannot move directly onto the garrison holder)'>" +
+            "<ref name='nonNegativeDecimal'/>" +
+        "</element>" +
+    "</optional>";
 
 /**
  * Initialize GarrisonHolder Component
@@ -30 +35 @@
 };
 
 /**
+ * Return range at which entities can garrison here
+ */
+GarrisonHolder.prototype.GetLoadingRange = function()
+{
+    var max = +(this.template.LoadingRange || 2);
+    return { "max": max, "min": 0 };
+};
+
+/**
  * Return the list of entities garrisoned inside
  */
 GarrisonHolder.prototype.GetEntities = function()

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

@@ -366 +366 @@
         }
         else
         {
-            // TODO: this is probably bogus if the unit was
-            // unable to move at all - we need to do some range checks
-            // before actually garrisoning
+            // We do a range check before actually garrisoning
             this.StopMoving();
             this.SetNextState("INDIVIDUAL.GARRISON.GARRISONED");
         }
@@ -1198 +1196 @@
                     var target = this.order.data.target;
                     // Check that we can still garrison here and that garrisoning succeeds
                     var cmpGarrisonHolder = Engine.QueryInterface(target, IID_GarrisonHolder);
-                    if (this.CanGarrison(target) && cmpGarrisonHolder.Garrison(this.entity))
+                    if (this.CanGarrison(target) && this.CheckGarrisonRange(target) && cmpGarrisonHolder.Garrison(this.entity))
                     {
                         this.isGarrisoned = true;
                     }
@@ -1972 +1970 @@
     return cmpUnitMotion.IsInTargetRange(target, range.min, range.max);
 };
 
+UnitAI.prototype.CheckGarrisonRange = function(target)
+{
+    var cmpGarrisonHolder = Engine.QueryInterface(target, IID_GarrisonHolder);
+    var range = cmpGarrisonHolder.GetLoadingRange();
+
+    var cmpUnitMotion = Engine.QueryInterface(this.entity, IID_UnitMotion);
+    return cmpUnitMotion.IsInTargetRange(target, range.min, range.max);
+}
+
 /**
  * Returns true if the target entity is visible through the FoW/SoD.
  */
@@ -2407 +2414 @@
     this.SetHeldPosition(pos.x, pos.z);
 
     this.SetStance(stance);
-    if (stance == "stand" || stance == "defensive" || stance == "passive")
+    // Stop moving if switching to stand ground
+    // TODO: Also stop existing orders in a sensible way
+    if (stance == "stand")
         this.StopMoving();
 
     // Reset the range query, since the range depends on stance

binaries/data/mods/public/simulation/templates/template_unit_mechanical_ship_bireme.xml

@@ -33 +33 @@
     <EjectHealth>0</EjectHealth>
     <List datatype="tokens">Support Infantry Cavalry</List>
     <BuffHeal>1</BuffHeal>
+    <LoadingRange>10</LoadingRange>
   </GarrisonHolder>
   <Health>
     <Max>800</Max>

binaries/data/mods/public/simulation/templates/template_unit_mechanical_ship_fishing.xml

@@ -23 +23 @@
     <EjectHealth>0</EjectHealth>
     <List datatype="tokens">Support Infantry</List>
     <BuffHeal>1</BuffHeal>
+    <LoadingRange>10</LoadingRange>
   </GarrisonHolder>
   <Identity>
     <GenericName>Fishing Boat</GenericName>

binaries/data/mods/public/simulation/templates/template_unit_mechanical_ship_merchant.xml

@@ -16 +16 @@
     <EjectHealth>0</EjectHealth>
     <List datatype="tokens">Support Infantry Cavalry</List>
     <BuffHeal>1</BuffHeal>
+    <LoadingRange>10</LoadingRange>
   </GarrisonHolder>
   <Health>
     <Max>400</Max>

binaries/data/mods/public/simulation/templates/template_unit_mechanical_ship_quinquereme.xml

@@ -33 +33 @@
     <EjectHealth>0</EjectHealth>
     <List datatype="tokens">Support Infantry Cavalry Siege</List>
     <BuffHeal>1</BuffHeal>
+    <LoadingRange>10</LoadingRange>
   </GarrisonHolder>
   <Health>
     <Max>2000</Max>

binaries/data/mods/public/simulation/templates/template_unit_mechanical_ship_trireme.xml

@@ -37 +37 @@
     <EjectHealth>0</EjectHealth>
     <List datatype="tokens">Support Infantry Cavalry Siege</List>
     <BuffHeal>1</BuffHeal>
+    <LoadingRange>10</LoadingRange>
   </GarrisonHolder>
   <Health>
     <Max>1400</Max>