Ticket #3586: petra_headquarters_template.patch

binaries/data/mods/public/simulation/ai/petra/headquarters.js

@@ -17 +17 @@
 m.HQ = function(Config)
 {
     this.Config = Config;
-    
+
     this.econState = "growth";  // existing values: growth, townPhasing.
     this.currentPhase = undefined;
 
     // cache the rates.
-    this.turnCache = {};    
+    this.turnCache = {};
     this.wantedRates = { "food": 0, "wood": 0, "stone":0, "metal": 0 };
     this.currentRates = { "food": 0, "wood": 0, "stone":0, "metal": 0 };
-    this.lastFailedGather = { "wood": undefined, "stone": undefined, "metal": undefined }; 
+    this.lastFailedGather = { "wood": undefined, "stone": undefined, "metal": undefined };
 
     // workers configuration
     this.targetNumWorkers = this.Config.Economy.targetNumWorkers;
@@ -123 +123 @@
         let ent = gameState.getEntityById(evt.entity);
         if (!ent || !ent.isOwn(PlayerID))
             continue;
-            
+
         if (ent.getMetadata(PlayerID, "base") == -1)
         {
             // Okay so let's try to create a new base around this.
@@ -211 +211 @@
             ent.setMetadata(PlayerID, "role", undefined);
             ent.setMetadata(PlayerID, "subrole", undefined);
             ent.setMetadata(PlayerID, "plan", undefined);
-            ent.setMetadata(PlayerID, "PartOfArmy", undefined);         
+            ent.setMetadata(PlayerID, "PartOfArmy", undefined);
             if (ent.hasClass("Trader"))
             {
                 ent.setMetadata(PlayerID, "role", "trader");
                 ent.setMetadata(PlayerID, "route", undefined);
             }
-            if (ent.hasClass("Female") || ent.hasClass("CitizenSoldier"))
+            if (ent.hasClass("Support") || ent.hasClass("CitizenSoldier"))
             {
                 ent.setMetadata(PlayerID, "role", "worker");
                 ent.setMetadata(PlayerID, "subrole", "idle");
@@ -335 +335 @@
                 this.decayingStructures.add(evt.entity);
         }
         else if (ent.isGarrisonHolder())
-            this.garrisonManager.removeDecayingStructure(evt.entity);       
+            this.garrisonManager.removeDecayingStructure(evt.entity);
     }
 
     // then deals with decaying structures
@@ -381 +381 @@
 {
     if (this.Config.difficulty > 2 && this.femaleRatio > 0.4)
         this.femaleRatio = 0.4;
-        
-    var phaseName = gameState.getTemplate(gameState.townPhase()).name(); 
-    m.chatNewPhase(gameState, phaseName, true); 
+
+    var phaseName = gameState.getTemplate(gameState.townPhase()).name();
+    m.chatNewPhase(gameState, phaseName, true);
 };
 
 // Called by the "city phase" research plan once it's started
@@ -394 +394 @@
 
     // increase the priority of defense buildings to free this queue for our first fortress
     gameState.ai.queueManager.changePriority("defenseBuilding", 2*this.Config.priorities.defenseBuilding);
-    
-    var phaseName = gameState.getTemplate(gameState.cityPhase()).name();   
-    m.chatNewPhase(gameState, phaseName, true); 
+
+    var phaseName = gameState.getTemplate(gameState.cityPhase()).name();
+    m.chatNewPhase(gameState, phaseName, true);
 };
 
 // This code trains females and citizen workers, trying to keep close to a ratio of females/CS
-// TODO: this should choose a base depending on which base need workers
-// TODO: also there are several things that could be greatly improved here.
 m.HQ.prototype.trainMoreWorkers = function(gameState, queues)
 {
-    // Count the workers in the world and in progress
-    var numFemales = gameState.countEntitiesAndQueuedByType(gameState.applyCiv("units/{civ}_support_female_citizen"), true);
+    // default template
+    var requirementsDef = [["cost", 1], ["costsResource", 1, "food"]];
+    var classesDef = ["Support"];
+    var templateDef = this.findBestTrainableUnit(gameState, classesDef, requirementsDef);
 
+    // Count the workers in the world and in progress
+    var numFemales = gameState.countEntitiesAndQueuedByType(templateDef);
+
     // counting the workers that aren't part of a plan
     var numWorkers = 0;
     gameState.getOwnUnits().forEach (function (ent) {
@@ -453 +456 @@
     if (numQueued > 50 || (numQueuedF > 20 && numQueuedS > 20) || numInTraining > 15)
         return;
 
-    // default template
-    var templateDef = gameState.applyCiv("units/{civ}_support_female_citizen");
     // Choose whether we want soldiers instead.
     let femaleRatio = (gameState.isDisabledTemplates(gameState.applyCiv("structures/{civ}_field")) ? Math.min(this.femaleRatio, 0.2) : this.femaleRatio);
     let template;
-    if (!gameState.templates[templateDef] || ((numFemales+numQueuedF) > 8 && (numFemales+numQueuedF)/numTotal > femaleRatio))
+    if ((numFemales+numQueuedF) > 8 && (numFemales+numQueuedF)/numTotal > femaleRatio)
     {
         let requirements;
         if (numTotal < 45)
@@ -466 +467 @@
         else
             requirements = [ ["strength", 1] ];
 
-        let proba = Math.random();
-        if (proba < 0.6)
-        {   // we require at least 30% ranged and 30% melee
-            let classes = proba < 0.3 ? ["CitizenSoldier", "Infantry", "Ranged"] : ["CitizenSoldier", "Infantry", "Melee"];
-            template = this.findBestTrainableUnit(gameState, classes, requirements);
-        }
-        if (!template)
-            template = this.findBestTrainableUnit(gameState, ["CitizenSoldier", "Infantry"], requirements);
+        var classes = ["CitizenSoldier", "Infantry"];
+        let proba = Math.random();
+        //  we require at least 30% ranged and 30% melee
+        if ( proba < 0.3 )
+        {
+            classes.push("Ranged")
+        }
+        else if ( proba < 0.6 )
+        {
+            classes.push("Melee");
+        }
+        template = this.findBestTrainableUnit(gameState, classes, requirements);
     }
-    if (!template && gameState.templates[templateDef])
-        template = templateDef;
 
-    // base "0" means "auto"
-    if (template === gameState.applyCiv("units/{civ}_support_female_citizen"))
-        queues.villager.addPlan(new m.TrainingPlan(gameState, template, { "role": "worker", "base": 0 }, size, size));
-    else if (template)
-        queues.citizenSoldier.addPlan(new m.TrainingPlan(gameState, template, { "role": "worker", "base": 0 }, size, size));
+    // If the template variable is empty, the default unit (Support unit)
+    // would be used in the next turn
+    //
+    // base "0" means "auto"
+    if (!template && gameState.templates[templateDef])
+    {
+        queues.villager.addPlan(new m.TrainingPlan(gameState, templateDef, { "role": "worker", "base": 0 }, size, size));
+    }
+    else if (template)
+    {
+        queues.citizenSoldier.addPlan(new m.TrainingPlan(gameState, template, { "role": "worker", "base": 0 }, size, size));
+    }
 };
 
 // picks the best template based on parameters and classes
@@ -495 +505 @@
         units = gameState.findTrainableUnits(classes, ["SiegeTower"]);
     else                        // We do not want hero when not explicitely specified
         units = gameState.findTrainableUnits(classes, ["Hero"]);
-    
+
     if (units.length == 0)
         return undefined;
 
@@ -504 +514 @@
     var availableResources = gameState.ai.queueManager.getAvailableResources(gameState); // available (gathered) resources
     for (let type in remainingResources)
     {
-        if (type === "food")
-            continue;
         if (availableResources[type] > 800)
             continue;
         if (remainingResources[type] > 800)
@@ -515 +523 @@
         for (let param of parameters)
         {
             if (param[0] !== "costsResource" || param[2] !== type)
-                continue;           
+                continue;
             param[1] = Math.min( param[1], costsResource );
             toAdd = false;
             break;
@@ -547 +555 @@
                 aTopParam += a[1].walkSpeed() * param[1];
                 bTopParam += b[1].walkSpeed() * param[1];
             }
-            
+
             if (param[0] == "cost") {
                 aDivParam += a[1].costSum() * param[1];
                 bDivParam += b[1].costSum() * param[1];
@@ -638 +646 @@
         }
         this.turnCache.gatherRates = true;
     }
-        
+
     return this.currentRates;
 };
 
@@ -662 +670 @@
     needed.sort(function(a, b) {
         var va = (Math.max(0, a.wanted - a.current))/ (a.current+1);
         var vb = (Math.max(0, b.wanted - b.current))/ (b.current+1);
-        
+
         // If they happen to be equal (generally this means "0" aka no need), make it fair.
         if (va === vb)
             return (a.current - b.current);
@@ -674 +682 @@
 // Returns the best position to build a new Civil Centre
 // Whose primary function would be to reach new resources of type "resource".
 m.HQ.prototype.findEconomicCCLocation = function(gameState, template, resource, proximity, fromStrategic)
-{   
+{
     // This builds a map. The procedure is fairly simple. It adds the resource maps
     //  (which are dynamically updated and are made so that they will facilitate DP placement)
     // Then checks for a good spot in the territory. If none, and town/city phase, checks outside
@@ -721 +729 @@
     var cellSize = this.territoryMap.cellSize;
 
     for (let j = 0; j < this.territoryMap.length; ++j)
-    {   
+    {
         if (this.territoryMap.getOwnerIndex(j) != 0)
             continue;
         // with enough room around to build the cc
@@ -739 +747 @@
         // checking distance to other cc
         let pos = [cellSize * (j%width+0.5), cellSize * (Math.floor(j/width)+0.5)];
 
-        if (proximity)  // this is our first cc, let's do it near our units 
+        if (proximity)  // this is our first cc, let's do it near our units
         {
             let dist = API3.SquareVectorDistance(proximity, pos);
             norm /= (1 + dist/scale);
@@ -806 +814 @@
 
         if (this.borderMap.map[j] > 0)  // disfavor the borders of the map
             norm *= 0.5;
-        
+
         let val = 2*gameState.sharedScript.CCResourceMaps[resource].map[j] +
                 gameState.sharedScript.CCResourceMaps.wood.map[j] +
                 gameState.sharedScript.CCResourceMaps.stone.map[j] +
@@ -852 +860 @@
 // Returns the best position to build a new Civil Centre
 // Whose primary function would be to assure territorial continuity with our allies
 m.HQ.prototype.findStrategicCCLocation = function(gameState, template)
-{   
+{
     // This builds a map. The procedure is fairly simple.
     // We minimize the Sum((dist-300)**2) where the sum is on the three nearest allied CC
     // with the constraints that all CC have dist > 200 and at least one have dist < 400
@@ -954 +962 @@
         }
         // disfavor border of the map
         if (this.borderMap.map[j] > 0)
-            currentVal += 10000;        
+            currentVal += 10000;
 
         if (bestVal !== undefined && currentVal > bestVal)
             continue;
@@ -965 +973 @@
     }
 
     if (this.Config.debug > 1)
-        API3.warn("We've found a strategic base with bestVal = " + bestVal);    
+        API3.warn("We've found a strategic base with bestVal = " + bestVal);
 
     Engine.ProfileStop();
 
@@ -1061 +1069 @@
     }
 
     if (this.Config.debug > 1)
-        API3.warn("We found a market position with bestVal = " + bestVal);  
+        API3.warn("We found a market position with bestVal = " + bestVal);
 
     if (bestVal === undefined)  // no constraints. For the time being, place it arbitrarily by the ConstructionPlan
         return [-1, -1, -1, 0];
@@ -1069 +1077 @@
     var expectedGain = Math.round(bestVal / this.Config.distUnitGain);
     if (this.Config.debug > 1)
         API3.warn("this would give a trading gain of " + expectedGain);
-    // do not keep it if gain is too small, except if this is our first BarterMarket 
+    // do not keep it if gain is too small, except if this is our first BarterMarket
     if (expectedGain < this.tradeManager.minimalGain ||
         (expectedGain < 8 && (!template.hasClass("BarterMarket") || gameState.getOwnEntitiesByClass("BarterMarket", true).length > 0)))
         return false;
@@ -1082 +1090 @@
 // Returns the best position to build defensive buildings (fortress and towers)
 // Whose primary function is to defend our borders
 m.HQ.prototype.findDefensiveLocation = function(gameState, template)
-{   
+{
     // We take the point in our territory which is the nearest to any enemy cc
     // but requiring a minimal distance with our other defensive structures
     // and not in range of any enemy defensive structure to avoid building under fire.
@@ -1160 +1168 @@
             if (!strPos)
                 continue;
             let dist = API3.SquareVectorDistance(strPos, pos);
-            if (dist < 6400) //  TODO check on true attack range instead of this 80*80 
+            if (dist < 6400) //  TODO check on true attack range instead of this 80*80
             {
                 minDist = -1;
                 break;
@@ -1332 +1340 @@
         if (gameState.getOwnStructures().filter(API3.Filters.byClass(requirements["class"])).length >= requirements.number)
             this.requireHouses = undefined;
     }
-    
+
     // When population limit too tight
     //    - if no room to build, try to improve with technology
     //    - otherwise increase temporarily the priority of houses
@@ -1451 +1459 @@
     }
 
     if (gameState.currentPhase() < 2 || !this.canBuild(gameState, "structures/{civ}_defense_tower"))
-        return; 
+        return;
 
     let numTowers = gameState.getOwnEntitiesByClass("DefenseTower", true).filter(API3.Filters.byClass("Town")).length;
     if ((!numTowers || gameState.ai.elapsedTime > (1 + 0.10*numTowers)*this.towerLapseTime + this.towerStartTime) &&
@@ -1578 +1586 @@
 /**
  * train with highest priority ranged infantry in the nearest civil centre from a given set of positions
  * and garrison them there for defense
- */  
+ */
 m.HQ.prototype.trainEmergencyUnits = function(gameState, positions)
 {
     if (gameState.ai.queues.emergency.hasQueuedUnits())
@@ -1685 +1693 @@
 
 m.HQ.prototype.canBuild = function(gameState, structure)
 {
-    var type = gameState.applyCiv(structure); 
+    var type = gameState.applyCiv(structure);
     // available room to build it
     if (this.stopBuilding.has(type))
     {
@@ -1913 +1921 @@
     if (this.turnCache.resourceGatherer && this.turnCache.resourceGatherer[supplyID] !== undefined)
         ++this.turnCache.resourceGatherer[supplyID];
     else
-    { 
+    {
         if (!this.turnCache.resourceGatherer)
             this.turnCache.resourceGatherer = {};
         this.turnCache.resourceGatherer[supplyID] = 1;
@@ -1986 +1994 @@
         this.currentPhase = gameState.currentPhase();
         let phaseName = "Unknown Phase";
         if (this.currentPhase == 2)
-            phaseName = gameState.getTemplate(gameState.townPhase()).name(); 
+            phaseName = gameState.getTemplate(gameState.townPhase()).name();
         else if (this.currentPhase == 3)
             phaseName = gameState.getTemplate(gameState.cityPhase()).name();
-            
-        m.chatNewPhase(gameState, phaseName, false); 
+
+        m.chatNewPhase(gameState, phaseName, false);
         this.updateTerritories(gameState);
     }
     else if (gameState.ai.playedTurn - this.lastTerritoryUpdate > 100)