Ticket #2242: swimmer.diff

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

@@ -16 +16 @@
     "<element name='EjectEntitiesOnDestroy' a:help='Whether the entity should eject or kill all garrisoned entities on destroy'>" +
         "<data type='boolean'/>" +
     "</element>" +
+    "<optional>" +
+        "<element name='EjectSwimmingEntitiesOnDestroy' a:help='Whether the entity should eject garrisoned entities which can swim on destroy'>" +
+            "<data type='boolean'/>" +
+        "</element>" +
+    "</optional>" +
     "<element name='BuffHeal' a:help='Number of hit points that will be restored to this holder&apos;s garrisoned units each second'>" +
         "<ref name='nonNegativeDecimal'/>" +
     "</element>" +
@@ -82 +87 @@
     return this.template.EjectEntitiesOnDestroy == "true";
 };
 
+GarrisonHolder.prototype.EjectSwimmingEntitiesOnDestroy = function()
+{
+    return (this.template.EjectSwimmingEntitiesOnDestroy ? (this.template.EjectSwimmingEntitiesOnDestroy == "true") : false);
+};
+
 /**
  * Set this entity to allow or disallow garrisoning in
  * Every component calling this function should do it with its own ID, and as long as one
@@ -537 +547 @@
     var cmpPosition = Engine.QueryInterface(this.entity, IID_Position);
     // Eject the units which can be ejected (if not in world, it generally means this holder
     // is inside a holder which kills its entities, so do not eject)
-    if (cmpPosition.IsInWorld() && this.EjectEntitiesOnDestroy())
-        this.PerformEject(entities, true);
+    if (cmpPosition.IsInWorld())
+    {
+        if( this.EjectEntitiesOnDestroy())
+            this.PerformEject(entities, true);
+        else if( this.EjectSwimmingEntitiesOnDestroy())
+        {
+            for each (var entity in entities)
+            {
+                var cmpUnitAI = Engine.QueryInterface(entity, IID_UnitAI);
+                if (cmpUnitAI && cmpUnitAI.CanSwim())
+                    this.PerformEject([entity], false);  // not force in case no spawn point possible
+            }
 
+        }
+    }
+
     // And destroy all remaining entities
     for each (var entity in entities)
     {

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

@@ -2610 +2610 @@
     return true;
 };
 
+UnitAI.prototype.CanSwim = function()
+{
+    var cmpIdentity = Engine.QueryInterface(this.entity, IID_Identity);
+    if (!cmpIdentity)
+        return false;
+    return cmpIdentity.HasClass("Female") || cmpIdentity.HasClass("Infantry");
+};
+
 UnitAI.prototype.OnCreate = function()
 {
     if (this.IsAnimal())

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

@@ -34 +34 @@
     <Max>20</Max>
     <EjectHealth>0</EjectHealth>
     <EjectEntitiesOnDestroy>false</EjectEntitiesOnDestroy>
+    <EjectSwimmingEntitiesOnDestroy>true</EjectSwimmingEntitiesOnDestroy>
     <List datatype="tokens">Support Infantry Cavalry</List>
     <BuffHeal>1</BuffHeal>
     <LoadingRange>10</LoadingRange>

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

@@ -23 +23 @@
     <Max>1</Max>
     <EjectHealth>0</EjectHealth>
     <EjectEntitiesOnDestroy>false</EjectEntitiesOnDestroy>
+    <EjectSwimmingEntitiesOnDestroy>true</EjectSwimmingEntitiesOnDestroy>
     <List datatype="tokens">Support Infantry</List>
     <BuffHeal>1</BuffHeal>
     <LoadingRange>10</LoadingRange>

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

@@ -15 +15 @@
     <Max>15</Max>
     <EjectHealth>0</EjectHealth>
     <EjectEntitiesOnDestroy>false</EjectEntitiesOnDestroy>
+    <EjectSwimmingEntitiesOnDestroy>true</EjectSwimmingEntitiesOnDestroy>
     <List datatype="tokens">Support Infantry Cavalry</List>
     <BuffHeal>1</BuffHeal>
     <LoadingRange>10</LoadingRange>

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

@@ -42 +42 @@
     <Max>50</Max>
     <EjectHealth>0</EjectHealth>
     <EjectEntitiesOnDestroy>false</EjectEntitiesOnDestroy>
+    <EjectSwimmingEntitiesOnDestroy>true</EjectSwimmingEntitiesOnDestroy>
     <List datatype="tokens">Support Infantry Cavalry Siege</List>
     <BuffHeal>1</BuffHeal>
     <LoadingRange>10</LoadingRange>

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

@@ -34 +34 @@
     <Max>30</Max>
     <EjectHealth>0</EjectHealth>
     <EjectEntitiesOnDestroy>false</EjectEntitiesOnDestroy>
+    <EjectSwimmingEntitiesOnDestroy>true</EjectSwimmingEntitiesOnDestroy>
     <List datatype="tokens">Support Infantry Cavalry Siege</List>
     <BuffHeal>1</BuffHeal>
     <LoadingRange>10</LoadingRange>