Ticket #3412: ship-template.diff

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

@@ -367 +367 @@
         {
             if (!hasClass(entState, "Unit") || !targetState.garrisonHolder)
                 return false;
+            if (!entState.unitAI || !entState.unitAI.canGarrison)
+                return false;
             if (!playerCheck(entState, targetState, ["Player", "Ally"]))
                 return false;
             var tooltip = sprintf(translate("Current garrison: %(garrisoned)s/%(capacity)s"), {
@@ -749 +751 @@
      "garrison": {
         "getInfo": function(entState)
         {
-            if (!entState.unitAI || entState.turretParent)
+            if (!entState.unitAI || !entState.unitAI.canGarrison || entState.turretParent)
                 return false;
             return {
                 "tooltip": translate("Garrison"),

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

@@ -351 +351 @@
             "orders": cmpUnitAI.GetOrders(),
             "hasWorkOrders": cmpUnitAI.HasWorkOrders(),
             "canGuard": cmpUnitAI.CanGuard(),
+            "canGarrison": cmpUnitAI.IsGarrisonable(),
             "isGuarding": cmpUnitAI.IsGuardOf(),
             "possibleStances": cmpUnitAI.GetPossibleStances(),
             "isIdle":cmpUnitAI.IsIdle(),

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

@@ -24 +24 @@
     "<element name='CanGuard'>" +
         "<data type='boolean'/>" +
     "</element>" +
+    "<element name='CanGarrison'>" +
+        "<data type='boolean'/>" +
+    "</element>" +
     "<optional>" +
         "<interleave>" +
             "<element name='NaturalBehaviour' a:help='Behaviour of the unit in the absence of player commands (intended for animals)'>" +
@@ -5625 +5628 @@
     return false;
 };
 
+UnitAI.prototype.IsGarrisonable = function() {
+    return (this.template.CanGarrison == "true");
+}
+
 UnitAI.prototype.CanGarrison = function(target)
 {
     // Formation controllers should always respond to commands
     // (then the individual units can make up their own minds)
     if (this.IsFormationController())
         return true;
-
-    var cmpGarrisonHolder = Engine.QueryInterface(target, IID_GarrisonHolder);
-    if (!cmpGarrisonHolder)
-        return false;
-
-    // Verify that the target is owned by this entity's player or a mutual ally of this player
-    var cmpOwnership = Engine.QueryInterface(this.entity, IID_Ownership);
-    if (!cmpOwnership || !(IsOwnedByPlayer(cmpOwnership.GetOwner(), target) || IsOwnedByMutualAllyOfPlayer(cmpOwnership.GetOwner(), target)))
-        return false;
-
-    // Don't let animals garrison for now
-    // (If we want to support that, we'll need to change Order.Garrison so it
-    // doesn't move the animal into an INVIDIDUAL.* state)
-    if (this.IsAnimal())
-        return false;
+    
+    // Check if the unit is able to Garrison based on their template
+    if (!this.isGarrisonable())
+        return false;
+
+    var cmpGarrisonHolder = Engine.QueryInterface(target, IID_GarrisonHolder);
+    if (!cmpGarrisonHolder)
+        return false;
+
+    // Verify that the target is owned by this entity's player or a mutual ally of this player
+    var cmpOwnership = Engine.QueryInterface(this.entity, IID_Ownership);
+    if (!cmpOwnership || !(IsOwnedByPlayer(cmpOwnership.GetOwner(), target) || IsOwnedByMutualAllyOfPlayer(cmpOwnership.GetOwner(), target)))
+        return false;
 
     return true;
 };

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

@@ -34 +34 @@
     <FleeDistance>12.0</FleeDistance>
     <FormationController>true</FormationController>
     <CanGuard>true</CanGuard>
+    <CanGarrison>true</CanGarrison>
   </UnitAI>
   <UnitMotion>
     <FormationController>true</FormationController>

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

@@ -101 +101 @@
     <FleeDistance>12.0</FleeDistance>
     <FormationController>false</FormationController>
     <CanGuard>true</CanGuard>
+    <CanGarrison>true</CanGarrison>
   </UnitAI>
   <Guard/>
   <UnitMotion>

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

@@ -28 +28 @@
     <RoamTimeMax>8000</RoamTimeMax>
     <FeedTimeMin>15000</FeedTimeMin>
     <FeedTimeMax>60000</FeedTimeMax>
+    <CanGarrison>false</CanGarrison>
   </UnitAI>
   <Guard disable=""/>
   <UnitMotion>

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

@@ -31 +31 @@
     <RoamTimeMax>100000</RoamTimeMax>
     <FeedTimeMin>1</FeedTimeMin>
     <FeedTimeMax>2</FeedTimeMax>
+    <CanGarrison>false</CanGarrison>
   </UnitAI>
   <UnitMotion>
     <FormationController>false</FormationController>

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

@@ -70 +70 @@
   <Vision>
     <Range>90</Range>
   </Vision>
+  <UnitAI>
+    <CanGarrison>false</CanGarrison>
+  </UnitAI>
 </Entity>