Changeset 10020 for ps

Timestamp:

08/17/11 03:43:23 (13 years ago)

Author:

ben

Message:

Fixes garrison behavior for ships - they no longer unload units underwater. See #893.
Fixes behavior when ships are destroyed (garrisoned units at the time will also be killed).
Updates ship templates accordingly.

Location:

ps/trunk/binaries/data/mods/public/simulation

Files:

• components/GarrisonHolder.js (modified) (7 diffs)
• helpers/Commands.js (modified) (2 diffs)
• templates/template_unit_mechanical_ship.xml (modified) (1 diff)
• templates/template_unit_mechanical_ship_bireme.xml (modified) (2 diffs)
• templates/template_unit_mechanical_ship_fishing.xml (modified) (1 diff)
• templates/template_unit_mechanical_ship_merchant.xml (modified) (1 diff)
• templates/template_unit_mechanical_ship_quinquereme.xml (modified) (2 diffs)
• templates/template_unit_mechanical_ship_trireme.xml (modified) (2 diffs)

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

@@ -12 +12 @@
     "</element>" +
     "<element name='EjectHealth'>" +
-        "<ref name='positiveDecimal'/>" +
+        "<ref name='nonNegativeDecimal'/>" +
     "</element>" + 
     "<element name='BuffHeal'>" +
@@ -134 +134 @@
  * Simply eject the unit from the garrisoning entity without
  * moving it
- */
-GarrisonHolder.prototype.Eject = function(entity)
+ * Returns true if successful, false if not
+ */
+GarrisonHolder.prototype.Eject = function(entity, forced)
 {
     var entityIndex = this.entities.indexOf(entity);
-    this.spaceOccupied -= 1;
-    this.entities.splice(entityIndex, 1);
-    
-    var cmpUnitAI = Engine.QueryInterface(entity, IID_UnitAI);
-    if (cmpUnitAI)
-    {
-        cmpUnitAI.Ungarrison();
-    }
-    
+    
+    // Find spawning location
     var cmpFootprint = Engine.QueryInterface(this.entity, IID_Footprint);
     var pos = cmpFootprint.PickSpawnPoint(entity);
     if (pos.y < 0)
     {
-        // Whoops, something went wrong (maybe there wasn't any space to place the unit).
-        // What should we do here?
-        // For now, just move the unit into the middle of the building where it'll probably get stuck
-        var cmpPosition = Engine.QueryInterface(this.entity, IID_Position);
-        pos = cmpPosition.GetPosition();
-        
-        var cmpPlayer = QueryOwnerInterface(this.entity, IID_Player);
-        var notification = {"player": cmpPlayer.GetPlayerID(), "message": "Can't find free space to ungarrison unit"};
-        var cmpGUIInterface = Engine.QueryInterface(SYSTEM_ENTITY, IID_GuiInterface);
-        cmpGUIInterface.PushNotification(notification);
-    }
-
+        // Error: couldn't find space satisfying the unit's passability criteria
+        if (forced)
+        {   // If ejection is forced, we need to continue, so use center of the building
+            var cmpPosition = Engine.QueryInterface(this.entity, IID_Position);
+            pos = cmpPosition.GetPosition();
+        }
+        else
+        {   // Fail
+            return false;
+        }
+    }
+    
+    this.spaceOccupied -= 1;
+    this.entities.splice(entityIndex, 1);
+    
+    var cmpUnitAI = Engine.QueryInterface(entity, IID_UnitAI);
+    if (cmpUnitAI)
+    {
+        cmpUnitAI.Ungarrison();
+    }
+    
     var cmpNewPosition = Engine.QueryInterface(entity, IID_Position);
     cmpNewPosition.JumpTo(pos.x, pos.z);
     // TODO: what direction should they face in?
+    
+    return true;
 };
 
@@ -194 +199 @@
  * Unload units from the garrisoning entity and order them
  * to move to the Rally Point
- */
-GarrisonHolder.prototype.Unload = function(entity)
-{
-    this.Eject(entity);
-    this.OrderWalkToRallyPoint([entity]);
+ * Returns true if successful, false if not
+ */
+GarrisonHolder.prototype.Unload = function(entity, forced)
+{
+    if (this.Eject(entity, forced))
+    {
+        this.OrderWalkToRallyPoint([entity]);
+        this.UpdateGarrisonFlag();
+        return true;
+    }
+    
+    return false;
+};
+
+/**
+ * Unload all units from the entity
+ * Returns true if all successful, false if not
+ */
+GarrisonHolder.prototype.UnloadAll = function(forced)
+{
+    // Make copy of entity list
+    var entities = [];
+    for each (var entity in this.entities)
+    {
+        entities.push(entity);
+    }
+    
+    var ejectedEntities = [];
+    var success = true;
+    for each (var entity in entities)
+    {
+        if (this.Eject(entity, forced))
+        {
+            ejectedEntities.push(entity);
+        }
+        else
+        {
+            success = false;
+        }
+    }
+    
+    this.OrderWalkToRallyPoint(ejectedEntities);
     this.UpdateGarrisonFlag();
-};
-
-/**
- * Unload all units from the entity
- */
-GarrisonHolder.prototype.UnloadAll = function()
-{
-    // The entities list is saved to a temporary variable
-    // because during each loop an element is removed
-    // from the list
-    var entities = this.entities.splice(0);
-    for each (var entity in entities)
-    {
-        this.Eject(entity);
-    }
-    this.OrderWalkToRallyPoint(entities);
-    this.UpdateGarrisonFlag();
+    
+    return success;
 };
 
@@ -227 +254 @@
     if (!this.HasEnoughHealth())
     {
-        this.UnloadAll();
+        // We have to be careful of our passability
+        //  ships: not land passable, so assume units have drowned in a shipwreck
+        //  building: land passable, so units can be ejected freely
+        var classes = (Engine.QueryInterface(this.entity, IID_Identity)).GetClassesList();
+        if (classes.indexOf("Ship") != -1)
+        {   // Ship - kill all units
+            for each (var entity in this.entities)
+            {
+                var cmpHealth = Engine.QueryInterface(entity, IID_Health);
+                if (cmpHealth)
+                {
+                    cmpHealth.Kill();
+                }
+            }
+            this.entities = [];
+        }
+        else
+        {   // Building - force ejection
+            this.UnloadAll(true);
+        }
     }
 };
@@ -303 +349 @@
 GarrisonHolder.prototype.OnGlobalOwnershipChanged = function(msg)
 {
-    if (this.entities.indexOf(msg.entity) != -1)
+    var entityIndex = this.entities.indexOf(msg.entity);
+    if (entityIndex != -1)
     {
         // If the entity is dead, remove it directly instead of ejecting the corpse
@@ -309 +356 @@
         if (cmpHealth && cmpHealth.GetHitpoints() == 0)
         {
-            this.entities.splice(this.entities.indexOf(msg.entity), 1);
+            this.entities.splice(entityIndex, 1);
         }
         else
         {
-            // Otherwise the unit probably got captured somehow and we don't want it
-            // any more, so eject it
-            this.Eject(msg.entity);
+            // We have to be careful of our passability
+            //  ships: not land passable, assume unit was thrown overboard or something
+            //  building: land passable, unit can be ejected freely
+            var classes = (Engine.QueryInterface(this.entity, IID_Identity)).GetClassesList();
+            if (classes.indexOf("Ship") != -1)
+            {   // Ship - kill unit
+                var cmpHealth = Engine.QueryInterface(msg.entity, IID_Health);
+                if (cmpHealth)
+                {
+                    cmpHealth.Kill();
+                }
+                this.entities.splice(entityIndex, 1);
+            }
+            else
+            {   // Building - force ejection
+                this.Eject(msg.entity, true);
+            }
         }
     }
@@ -325 +386 @@
 GarrisonHolder.prototype.OnGlobalEntityRenamed = function(msg)
 {
-    if (this.entities.indexOf(msg.entity) != -1)
-    {
-        this.entities[this.entities.indexOf(msg.entity)] = msg.newentity;
+    var entityIndex = this.entities.indexOf(msg.entity);
+    if (entityIndex != -1)
+    {
+        this.entities[entityIndex] = msg.newentity;
     }
 };

ps/trunk/binaries/data/mods/public/simulation/helpers/Commands.js

@@ -263 +263 @@
         {
             var cmpGarrisonHolder = Engine.QueryInterface(cmd.garrisonHolder, IID_GarrisonHolder);
-            if (cmpGarrisonHolder)
-                cmpGarrisonHolder.Unload(cmd.entity);
+            if (!cmpGarrisonHolder || !cmpGarrisonHolder.Unload(cmd.entity))
+            {
+                var cmpPlayer = QueryPlayerIDInterface(player, IID_Player);
+                var notification = {"player": cmpPlayer.GetPlayerID(), "message": "Unable to ungarrison unit"};
+                var cmpGUIInterface = Engine.QueryInterface(SYSTEM_ENTITY, IID_GuiInterface);
+                cmpGUIInterface.PushNotification(notification);
+            }   
         }
         break;
@@ -272 +277 @@
         {
             var cmpGarrisonHolder = Engine.QueryInterface(cmd.garrisonHolder, IID_GarrisonHolder);
-            cmpGarrisonHolder.UnloadAll();
+            if (!cmpGarrisonHolder || !cmpGarrisonHolder.UnloadAll())
+            {
+                var cmpPlayer = QueryPlayerIDInterface(player, IID_Player);
+                var notification = {"player": cmpPlayer.GetPlayerID(), "message": "Unable to ungarrison all units"};
+                var cmpGUIInterface = Engine.QueryInterface(SYSTEM_ENTITY, IID_GuiInterface);
+                cmpGUIInterface.PushNotification(notification);
+            }
         }
         break;

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

@@ -26 +26 @@
   <Identity>
     <GenericName>Ship</GenericName>
+    <Classes datatype="tokens">Ship</Classes>
   </Identity>
   <Obstruction>

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

@@ -31 +31 @@
   <GarrisonHolder>
     <Max>20</Max>
-    <EjectHealth>0.1</EjectHealth>
-    <List datatype="tokens">Support Infantry Cavalry</List>
-    <BuffHeal>1</BuffHeal>
+    <EjectHealth>0</EjectHealth>
+    <List datatype="tokens">Support Infantry Cavalry</List>
+    <BuffHeal>1</BuffHeal>
   </GarrisonHolder>
   <Health>
@@ -41 +41 @@
     <GenericName>Light Warship</GenericName>
     <Tooltip>Light Warship.</Tooltip>
-    <Classes datatype="tokens">Warship</Classes>
+    <Classes datatype="tokens">Warship</Classes>
   </Identity>
   <ResourceGatherer disable=""/>

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

@@ -12 +12 @@
   <GarrisonHolder>
     <Max>1</Max>
-    <EjectHealth>0.1</EjectHealth>
-    <List datatype="tokens">Support Infantry</List>
-    <BuffHeal>1</BuffHeal>
+    <EjectHealth>0</EjectHealth>
+    <List datatype="tokens">Support Infantry</List>
+    <BuffHeal>1</BuffHeal>
   </GarrisonHolder>
   <Identity>

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

@@ -14 +14 @@
   <GarrisonHolder>
     <Max>15</Max>
-    <EjectHealth>0.1</EjectHealth>
-    <List datatype="tokens">Support Infantry Cavalry</List>
-    <BuffHeal>1</BuffHeal>
+    <EjectHealth>0</EjectHealth>
+    <List datatype="tokens">Support Infantry Cavalry</List>
+    <BuffHeal>1</BuffHeal>
   </GarrisonHolder>
   <Health>

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

@@ -27 +27 @@
   <GarrisonHolder>
     <Max>50</Max>
-    <EjectHealth>0.1</EjectHealth>
-    <List datatype="tokens">Support Infantry Cavalry Siege</List>
-    <BuffHeal>1</BuffHeal>
+    <EjectHealth>0</EjectHealth>
+    <List datatype="tokens">Support Infantry Cavalry Siege</List>
+    <BuffHeal>1</BuffHeal>
   </GarrisonHolder>
   <Health>
@@ -37 +37 @@
     <GenericName>Heavy Warship</GenericName>
     <Tooltip>Heavy Warship.</Tooltip>
-    <Classes datatype="tokens">Warship</Classes>
+    <Classes datatype="tokens">Warship</Classes>
   </Identity>
   <ResourceGatherer disable=""/>

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

@@ -31 +31 @@
   <GarrisonHolder>
     <Max>30</Max>
-    <EjectHealth>0.1</EjectHealth>
-    <List datatype="tokens">Support Infantry Cavalry Siege</List>
-    <BuffHeal>1</BuffHeal>
+    <EjectHealth>0</EjectHealth>
+    <List datatype="tokens">Support Infantry Cavalry Siege</List>
+    <BuffHeal>1</BuffHeal>
   </GarrisonHolder>
   <Health>
@@ -41 +41 @@
     <GenericName>Medium Warship</GenericName>
     <Tooltip>Medium Warship.</Tooltip>
-    <Classes datatype="tokens">Warship</Classes>
+    <Classes datatype="tokens">Warship</Classes>
   </Identity>
   <ResourceGatherer disable=""/>