Ticket #2531: default_formations.diff

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

@@ -57 +57 @@
         "</element>" +
     "</optional>" +
     "<optional>" +
-        "<element name='Formations' a:help='Optional list of space-separated formations this unit is allowed to use. Choices include: Scatter, Box, ColumnClosed, LineClosed, ColumnOpen, LineOpen, Flank, Skirmish, Wedge, Testudo, Phalanx, Syntagma, BattleLine'>" +
+        "<element name='Formations' a:help='Optional list of space-separated formations templates (see simulation/templates/formations for possible templates)'>" +
             "<attribute name='datatype'>" +
                 "<value>tokens</value>" +
             "</attribute>" +
@@ -65 +65 @@
         "</element>" +
     "</optional>" +
     "<optional>" +
+            "<element name='DefaultFormation'>" +
+                "<text/>" +
+            "</element>" +
+    "</optional>" +
+    "<optional>" +
         "<element name='Icon'>" +
             "<text/>" +
         "</element>" +
@@ -106 +111 @@
     return this.GetClassesList().indexOf(name) != -1;
 };
 
+Identity.prototype.GetDefaultFormation = function()
+{
+    if (this.template.DefaultFormation)
+        return this.template.DefaultFormation;
+    return "formations/line_closed";
+};
+
+
 Identity.prototype.GetFormationsList = function()
 {
     if (this.template.Formations && "_string" in this.template.Formations)

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

@@ -1157 +1157 @@
 }
 
 /**
+ * Get an alternative formation for this list of entities
+ * If the entities had a prior formation, this will be preferred,
+ * if they don't the default formation will be preferred
+ */
+function GetAlternativeFormation(ents)
+{
+    var r = "formations/line_closed";
+    var cmpTemplateManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_TemplateManager);
+    // object in the form
+    // {"formations/line_closed": 5, "formations/testudo": 10}
+    var defaultFormations = {};
+    // count the default formations of the members
+    for each (var ent in ents)
+    {
+        var cmpUnitAI = Engine.QueryInterface(ent, IID_UnitAI);
+        if (!cmpUnitAI)
+            continue;
+        var formation = cmpUnitAI.GetLastFormationTemplate();
+        if (formation)
+        {
+            if (defaultFormations[formation])
+                defaultFormations[formation]++;
+            else
+                defaultFormations[formation] = 1;
+            continue;
+        }
+        var cmpIdentity = Engine.QueryInterface(ent, IID_Identity);
+        if (!cmpIdentity)
+            continue;
+        var formation = cmpIdentity.GetDefaultFormation();
+        if (formation)
+        {
+            if (defaultFormations[formation])
+                defaultFormations[formation]++;
+            else
+                defaultFormations[formation] = 1;
+        }
+    }
+    var mostWantedFormationCount = 0;
+    for (let formation in defaultFormations)
+    {
+        if (defaultFormations[formation] > mostWantedFormationCount)
+        {
+            r = formation;
+            mostWantedFormationCount = defaultFormations[formation];
+        }
+    }
+    return r;
+}
+
+/**
  * Returns a list of UnitAI components, each belonging either to a
  * selected unit or to a formation entity for groups of the selected units.
  */
@@ -1176 +1227 @@
         return [ cmpUnitAI ];
     }
 
+    var defaultFormationTemplate = GetAlternativeFormation(ents);
     // Separate out the units that don't support the chosen formation
     var formedEnts = [];
     var nonformedUnitAIs = [];
@@ -1190 +1242 @@
         // TODO: We only check if the formation is usable by some units
         // if we move them to it. We should check if we can use formations
         // for the other cases.
-        if (cmpIdentity && cmpIdentity.CanUseFormation(formationTemplate || "formations/line_closed"))
+        if (cmpIdentity && cmpIdentity.CanUseFormation(formationTemplate || defaultFormationTemplate))
             formedEnts.push(ent);
         else
             nonformedUnitAIs.push(cmpUnitAI);
@@ -1242 +1294 @@
         {
             if (!formationTemplate || !CanMoveEntsIntoFormation(cluster, formationTemplate))
             {
-                // get the most recently used formation, or default to line closed
-                var lastFormationTemplate = undefined;
-                for each (var ent in cluster)
-                {
-                    var cmpUnitAI = Engine.QueryInterface(ent, IID_UnitAI);
-                    if (cmpUnitAI)
-                    {
-                        var template = cmpUnitAI.GetLastFormationTemplate();
-                        if (lastFormationTemplate === undefined)
-                        {
-                            lastFormationTemplate = template;
-                        }
-                        else if (lastFormationTemplate != template)
-                        {
-                            lastFormationTemplate = undefined;
-                            break;
-                        }
-                    }
-                }
-                if (lastFormationTemplate && CanMoveEntsIntoFormation(cluster, lastFormationTemplate))
-                    formationTemplate = lastFormationTemplate;
+                // get the most recently used formation
+                if (defaultFormationTemplate && CanMoveEntsIntoFormation(cluster, defaultFormationTemplate))
+                    formationTemplate = defaultFormationTemplate;
                 else
                     formationTemplate = "formations/line_closed";
             }

binaries/data/mods/public/simulation/templates/units/rome_infantry_spearman_b.xml

@@ -16 +16 @@
     <Icon>units/rome_infantry_spearman.png</Icon>
     <History>The Triarii were the third line of heavy infantry in the Republican Roman army. Made up of the veterans from previous campaigns, they often possessed the most fashionable arms and armor. Armed with a spear and gladius, the Triarii usually did not fight unless the battle was going poorly or enemy forces required the use of a spear to fend them off. In many cases the Triarii were left at the camp instead of marching out with the rest of the army.</History>
     <RequiredTechnology>phase_town</RequiredTechnology>
+    <DefaultFormation>formations/testudo</DefaultFormation>
   </Identity>
   <Promotion>
     <Entity>units/rome_infantry_spearman_a</Entity>

binaries/data/mods/public/simulation/templates/units/rome_infantry_swordsman_b.xml

@@ -28 +28 @@
     <SpecificName>Hastatus</SpecificName>
     <Icon>units/rome_infantry_swordsman.png</Icon>
     <History>The hastati were the first line of heavy infantry in the early Republican Roman army. They used pila and gladii as their main weapons, throwing the former into the enemy formation and then closing with the sword. For defense they used a large shield called a scutum and wore the best armor they could afford. Hastati were recruited from the young men of Rome, a small part of the 700,000 troops Rome could bring to bear against its opponents.</History>
+    <DefaultFormation>formations/testudo</DefaultFormation>
   </Identity>
   <Promotion>
     <Entity>units/rome_infantry_swordsman_a</Entity>