Changeset 25040

Timestamp:

Mar 12, 2021, 9:45:39 AM (3 years ago)

Author:

Freagarach

Message:

Clean up RemoveBatch -> RemoveItem code in ProductionQueue.

• Rename RemoveBatch to RemoveItem.
• Refactor that function. (Don't clear the cached entities when *any* item is removed.)

Fixes the bug that the training is still blocked when a tech is the next in the queue and the blocking item is removed.

Based on a patch by: @Polakrity
Differential revision: D1843
Comments by: @Angen, @bb

Location:

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

Files:

• components/ProductionQueue.js (modified) (6 diffs)
• components/tests/test_ProductionQueue.js (modified) (4 diffs)
• helpers/Commands.js (modified) (1 diff)

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

@@ -118 +118 @@
         for (let item of queue)
             if (item.unitTemplate && item.unitTemplate === template)
-                this.RemoveBatch(item.id);
+                this.Remove(item.id);
     };
     let updateAllQueuedTemplate = (token, updateTo) => {
@@ -509 +509 @@
 
 /*
- * Removes an existing batch of units from the production queue.
+ * Removes an  queue.
  * Refunds resource costs and population reservations.
- */
-ProductionQueue.prototype.RemoveBatch = function(id)
-{
+ * item.player is used as this.entity's owner may have changed.
+ */
+ProductionQueue.prototype.RemoveItem = function(id)
+{
+    let itemIndex = this.queue.findIndex(item => item.id == id);
+    if (itemIndex == -1)
+        return;
+
     // Destroy any cached entities (those which didn't spawn for some reason).
-    for (let ent of this.entityCache)
-        Engine.DestroyEntity(ent);
-
-    this.entityCache = [];
-
-    for (let i = 0; i < this.queue.length; ++i)
-    {
-        // Find the item to remove.
-        let item = this.queue[i];
-        if (item.id != id)
-            continue;
-
-        // Update entity count in the EntityLimits component.
-        if (item.unitTemplate)
-        {
-            let cmpTemplateManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_TemplateManager);
-            let template = cmpTemplateManager.GetTemplate(item.unitTemplate);
-            if (template.TrainingRestrictions)
-            {
-                let cmpPlayerEntityLimits = QueryPlayerIDInterface(item.player, IID_EntityLimits);
-                if (cmpPlayerEntityLimits)
-                    cmpPlayerEntityLimits.ChangeCount(template.TrainingRestrictions.Category, -item.count);
-                if (template.TrainingRestrictions.MatchLimit)
-                    cmpPlayerEntityLimits.ChangeMatchCount(item.unitTemplate, -item.count);
-            }
-        }
-
-        // Refund the resource cost for this batch.
-        let totalCosts = {};
-        let cmpStatisticsTracker = QueryPlayerIDInterface(item.player, IID_StatisticsTracker);
-        for (let r in item.resources)
-        {
-            totalCosts[r] = Math.floor(item.count * item.resources[r]);
-            if (cmpStatisticsTracker)
-                cmpStatisticsTracker.IncreaseResourceUsedCounter(r, -totalCosts[r]);
-        }
-
-        let cmpPlayer = QueryPlayerIDInterface(item.player);
-        if (cmpPlayer)
-        {
-            cmpPlayer.AddResources(totalCosts);
-
-            // Remove reserved population slots if necessary.
-            if (item.productionStarted && item.unitTemplate)
-                cmpPlayer.UnReservePopulationSlots(item.population * item.count);
-        }
-
-        // Mark the research as stopped if we cancel it.
-        if (item.technologyTemplate)
-        {
-            // item.player is used as this.entity's owner may be invalid (deletion, etc.)
-            let cmpTechnologyManager = QueryPlayerIDInterface(item.player, IID_TechnologyManager);
-            if (cmpTechnologyManager)
-                cmpTechnologyManager.StoppedResearch(item.technologyTemplate, true);
-            this.SetAnimation("idle");
-        }
-
-        this.queue.splice(i, 1);
-        Engine.PostMessage(this.entity, MT_ProductionQueueChanged, null);
-
-        return;
-    }
+    if (itemIndex == 0 && this.entityCache.length)
+    {
+        for (let ent of this.entityCache)
+            Engine.DestroyEntity(ent);
+
+        this.entityCache = [];
+    }
+
+    let item = this.queue[itemIndex];
+
+    // Update entity count in the EntityLimits component.
+    if (item.unitTemplate)
+    {
+        let cmpTemplateManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_TemplateManager);
+        let template = cmpTemplateManager.GetTemplate(item.unitTemplate);
+        if (template.TrainingRestrictions)
+        {
+            let cmpPlayerEntityLimits = QueryPlayerIDInterface(item.player, IID_EntityLimits);
+            if (cmpPlayerEntityLimits)
+                cmpPlayerEntityLimits.ChangeCount(template.TrainingRestrictions.Category, -item.count);
+            if (template.TrainingRestrictions.MatchLimit)
+                cmpPlayerEntityLimits.ChangeMatchCount(item.unitTemplate, -item.count);
+        }
+    }
+
+    let totalCosts = {};
+    let cmpStatisticsTracker = QueryPlayerIDInterface(item.player, IID_StatisticsTracker);
+    for (let resource in item.resources)
+    {
+        totalCosts[resource] = Math.floor(item.count * item.resources[resource]);
+        if (cmpStatisticsTracker)
+            cmpStatisticsTracker.IncreaseResourceUsedCounter(resource, -totalCosts[resource]);
+    }
+
+    let cmpPlayer = QueryPlayerIDInterface(item.player);
+    if (cmpPlayer)
+    {
+        cmpPlayer.AddResources(totalCosts);
+        if (item.productionStarted && item.unitTemplate)
+            cmpPlayer.UnReservePopulationSlots(item.population * item.count);
+        if (itemIndex == 0)
+            cmpPlayer.UnBlockTraining();
+    }
+
+    if (item.technologyTemplate)
+    {
+        let cmpTechnologyManager = QueryPlayerIDInterface(item.player, IID_TechnologyManager);
+        if (cmpTechnologyManager)
+            cmpTechnologyManager.StoppedResearch(item.technologyTemplate, true);
+        this.SetAnimation("idle");
+    }
+
+    this.queue.splice(itemIndex, 1);
+    Engine.PostMessage(this.entity, MT_ProductionQueueChanged, null);
+
+    if (!this.queue.length)
+        this.StopTimer();
 };
 
@@ -613 +613 @@
 
     while (this.queue.length)
-        this.RemoveBatch(this.queue[0].id);
+        this.Remove(this.queue[0].id);
 };
 
@@ -630 +630 @@
 ProductionQueue.prototype.OnOwnershipChanged = function(msg)
 {
-    if (msg.from != INVALID_PLAYER)
-    {
-        // Unset flag that previous owner's training may be blocked.
-        let cmpPlayer = QueryPlayerIDInterface(msg.from);
-        if (cmpPlayer && this.queue.length)
-            cmpPlayer.UnBlockTraining();
-    }
     if (msg.to != INVALID_PLAYER)
         this.CalculateEntitiesMap();
@@ -657 +650 @@
     // Reset the queue to refund any resources.
     this.ResetQueue();
-    this.StopTimer();
 };
 
@@ -898 +890 @@
         time -= item.timeRemaining;
         this.queue.shift();
-        Engine.PostMessage(this.entity, MT_ProductionQueueChanged, {});
+        Engine.PostMessage(this.entity, MT_ProductionQueueChanged, );
     }
 
     if (!this.queue.length)
-    {
         this.StopTimer();
-
-        // Unset flag that training is blocked.
-        // (This might happen when the player unqueues all batches.)
-        cmpPlayer.UnBlockTraining();
-    }
 };
 

ps/trunk/binaries/data/mods/public/simulation/components/tests/test_ProductionQueue.js

@@ -299 +299 @@
 
     // Check that when the batch is removed the counts are subtracted again.
-    cmpProdQueue.RemoveBatch(cmpProdQueue.GetQueue()[0].id);
+    cmpProdQueue.Remove(cmpProdQueue.GetQueue()[0].id);
     TS_ASSERT_EQUALS(cmpEntLimits.GetCounts().some_limit, 3);
     TS_ASSERT_EQUALS(cmpEntLimits.GetMatchCounts().some_template, 3);
@@ -407 +407 @@
     });
 
-    ConstructComponent(SYSTEM_ENTITY, "Timer", null);
+    ConstructComponent(SYSTEM_ENTITY, "Timer", null);
 
     AddMock(SYSTEM_ENTITY, IID_TemplateManager, {
@@ -452 +452 @@
     cmpProdQueue.AddBatch("some_template", "unit", 3);
     TS_ASSERT_EQUALS(cmpProdQueue.GetQueue().length, 1);
-    cmpProdQueue.ProgressTimeout(null, 0);
+    cmp);
     TS_ASSERT_EQUALS(cmpPlayerBlockSpy._called, 1);
 
@@ -458 +458 @@
     TS_ASSERT_EQUALS(cmpProdQueue.GetQueue().length, 2);
 
-    cmpProdQueue.RemoveBatch(1);
+    cmpProdQueue.Remove(1);
     TS_ASSERT_EQUALS(cmpProdQueue.GetQueue().length, 1);
-    TS_ASSERT_EQUALS(cmpPlayerUnblockSpy._called, 0);
-
-    cmpProdQueue.RemoveBatch(2);
+    TS_ASSERT_EQUALS(cmpPlayerUnblockSpy._called, );
+
+    cmpProdQueue.Remove(2);
     TS_ASSERT_EQUALS(cmpProdQueue.GetQueue().length, 0);
-    cmpProdQueue.ProgressTimeout(null, 0);
-    TS_ASSERT_EQUALS(cmpPlayerUnblockSpy._called, 1);
+    cmp);
+    TS_ASSERT_EQUALS(cmpPlayerUnblockSpy._called, );
 
     cmpProdQueue.AddBatch("some_template", "unit", 3);
     cmpProdQueue.AddBatch("some_template", "unit", 3);
     cmpPlayer.TryReservePopulationSlots = () => false;
-    cmpProdQueue.RemoveBatch(3);
-    cmpProdQueue.ProgressTimeout(null, 0);
-    TS_ASSERT_EQUALS(cmpPlayerUnblockSpy._called, 2);
-
+    cmpProdQueue.Remove(3);
+    );
+    );
+    TS_ASSERT_EQUALS(cmpPlayerUnblockSpy._called, 4);
 }
 

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

@@ -376 +376 @@
     "stop-production": function(player, cmd, data)
     {
-        var queue = Engine.QueryInterface(cmd.entity, IID_ProductionQueue);
-        if (queue)
-            queue.RemoveBatch(cmd.id);
+        ueue = Engine.QueryInterface(cmd.entity, IID_ProductionQueue);
+        if (ueue)
+            (cmd.id);
     },