Ticket #4193: 4193-loot-tooltip.8.patch

binaries/data/mods/public/globalscripts/Templates.js

@@ -244 +244 @@
             "rate": getEntityValue("Heal/Rate")
         };
 
+    if (template.Loot)
+    {
+        ret.loot = {};
+        for (let type in template.Loot)
+            ret.loot[type] = getEntityValue("Loot/"+ type);
+    }
+
     if (template.Obstruction)
     {
         ret.obstruction = {
@@ -381 +388 @@
 
     return ret;
 }
+
+/**
+ * Helper to calculate the loot used by gui and simulation. 
+ * @param carriedResources resources carried by the looted worker
+ * @param trader the looted trader
+ * @return the sum of carried resources and goods
+ */
+function calculateResourcesAndGoodsCarried(carriedResources, trader)
+{
+    var resources = {};
+    // Loot resources workers carried
+    if (carriedResources)
+        for (let resource of carriedResources)
+            resources[resource.type] = (resources[resource.type] || 0) + resource.amount;
+
+    // Loot resources traders carried
+    if (trader)
+        resources[trader.goods.type] =
+            (resources[trader.goods.type] || 0) +
+            (trader.goods.amount.traderGain || 0) +
+            (trader.goods.amount.market1Gain || 0) +
+            (trader.goods.amount.market2Gain || 0);
+
+    return resources;
+}

binaries/data/mods/public/gui/common/setup_resources.xml

@@ -25 +25 @@
         sprite="stretched:session/icons/resources/time_small.png"
         size="16 16"
     />
+    <icon name="icon_xp"
+        sprite="stretched:session/icons/resources/xp_small.png"
+        size="16 16"
+    />
 </setup>

binaries/data/mods/public/gui/common/tooltips.js

@@ -575 +575 @@
     return headerFont(translate("Classes:")) + ' ' +
         bodyFont(template.visibleIdentityClasses.map(c => translate(c)).join(translate(", ")));
 }
+
+function getLootTooltip(template)
+{
+    if (!template.loot) //TODO: what if a worker/trader is carring resources but do not have base loot defined?
+        return "";
+
+    let loots = [];
+    let resourcesCarried = [];
+    const lootTypes = ["xp", "food", "wood", "stone", "metal"];
+
+    if ("resourceCarrying" in template)
+        resourcesCarried = calculateResourcesAndGoodsCarried(template.resourceCarrying, template.trader);
+
+    for (let type of lootTypes)
+    {
+        let loot = (loots[type] || 0) + (template.loot[type] || 0) + (resourcesCarried[type] || 0);
+        if (loot > 0)
+            loots[type] = loot;
+    }
+
+    for (let type of Object.keys(loots))
+        loots.push(sprintf(translate("%(component)s %(loot)s"), {
+            "component": costIcon(type),
+            "loot": loots[type]
+    }));
+
+    return sprintf(translate("%(label)s %(details)s"), {
+        "label": headerFont(translate("Loot:")),
+        "details": loots.join("  ")
+    });
+}

binaries/data/mods/public/gui/session/selection_details.js

@@ -291 +291 @@
         getBuildRateTooltip,
         getSpeedTooltip,
         getGarrisonTooltip,
-        getProjectilesTooltip
+        getProjectilesTooltip,
+        getLootTooltip
     ].map(func => func(entState)).filter(tip => tip).join("\n");
 
     let iconTooltips = [];
@@ -319 +320 @@
     let maxCapturePoints = 0;
     let capturePoints = (new Array(g_MaxPlayers + 1)).fill(0);
     let playerID = 0;
-    let totalResourcesCarried = {};
+    let totalResourcesAndGoodsCarried = {};
+    let totalLoot = {};
 
     for (let i = 0; i < selection.length; ++i)
     {
-        let entState = GetEntityState(selection[i]);
+        let entState = GetExtendedEntityState(selection[i]);
         if (!entState)
             continue;
         playerID = entState.player; // trust that all selected entities have the same owner
@@ -338 +340 @@
             capturePoints = entState.capturePoints.map((v, i) => v + capturePoints[i]);
         }
 
-        if (entState.resourceCarrying && entState.resourceCarrying.length)
+        let resourcesAndGoodsCarried = calculateResourcesAndGoodsCarried(entState.resourceCarrying, entState.trader);
+
+        const lootTypes = ["xp", "food", "wood", "stone", "metal"];
+
+        for (let type of lootTypes)
         {
-            let carrying = entState.resourceCarrying[0];
-            totalResourcesCarried[carrying.type] = (totalResourcesCarried[carrying.type] || 0) + carrying.amount;
+            let loot = (totalLoot[type] || 0) + (entState.loot[type] || 0) + (resourcesAndGoodsCarried[type] || 0);
+            if (loot > 0)
+                totalLoot[type] = loot;
         }
+
+        for (let type in resourcesAndGoodsCarried)
+            totalResourcesAndGoodsCarried[type] = (totalResourcesAndGoodsCarried[type] || 0) + resourcesAndGoodsCarried[type];
     }
 
     Engine.GetGUIObjectByName("healthMultiple").hidden = averageHealth <= 0;
@@ -394 +404 @@
 
     let numberOfUnits = Engine.GetGUIObjectByName("numberOfUnits");
     numberOfUnits.caption = selection.length;
-    numberOfUnits.tooltip = Object.keys(totalResourcesCarried).map(res =>
-        costIcon(res) + totalResourcesCarried[res]
-    ).join(" ");
 
+    numberOfUnits.tooltip = "";
+
+    if (Object.keys(totalResourcesAndGoodsCarried).length)
+        numberOfUnits.tooltip = sprintf(translate("%(label)s %(details)s\n"), {
+            "label": headerFont(translate("Carrying:")),
+            "details": bodyFont(Object.keys(totalResourcesAndGoodsCarried).map(
+                res => sprintf(translate("%(type)s %(amount)s"),
+                    {"type" : costIcon(res), "amount" : totalResourcesAndGoodsCarried[res]})).join("  "))
+        });
+
+    if (Object.keys(totalLoot).length)
+        numberOfUnits.tooltip += sprintf(translate("%(label)s %(details)s"), {
+            "label": headerFont(translate("Loot:")),
+            "details": bodyFont(Object.keys(totalLoot).map(
+                res => sprintf(translate("%(type)s %(amount)s"),
+                    {"type" : costIcon(res), "amount" : totalLoot[res]})).join("  "))
+        });
+
     // Unhide Details Area
     Engine.GetGUIObjectByName("detailsAreaMultiple").hidden = false;
     Engine.GetGUIObjectByName("detailsAreaSingle").hidden = true;

binaries/data/mods/public/gui/structree/draw.js

@@ -14 +14 @@
     getProjectilesTooltip,
     getSpeedTooltip,
     getGatherTooltip,
-    getPopulationBonusTooltip
+    getPopulationBonusTooltip,
+    getLootTooltip
 ];
 
 /**

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

@@ -421 +421 @@
         "barterMarket": null,
         "buildingAI": null,
         "heal": null,
+        "loot": null,
         "obstruction": null,
         "turretParent":null,
         "promotion": null,
@@ -568 +569 @@
             "healableClasses": cmpHeal.GetHealableClasses(),
         };
 
+    let cmpLoot = Engine.QueryInterface(ent, IID_Loot);
+    if (cmpLoot)
+    {
+        let resources = cmpLoot.GetResources();
+        ret.loot = {
+            "xp": cmpLoot.GetXp(),
+            "food": resources.food,
+            "wood": resources.wood,
+            "stone": resources.stone,
+            "metal": resources.metal
+        };
+    }
+
     let cmpUnitMotion = Engine.QueryInterface(ent, IID_UnitMotion);
     if (cmpUnitMotion)
         ret.speed = {

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

@@ -14 +14 @@
     if (!cmpLoot)
         return;
 
+    // Collect resources carried by workers and traders
+    var cmpResourceGatherer = Engine.QueryInterface(targetEntity, IID_ResourceGatherer);
+    var cmpTrader = Engine.QueryInterface(targetEntity, IID_Trader);
+
+    let resourcesCarried = calculateResourcesAndGoodsCarried(
+        cmpResourceGatherer.GetCarryingStatus() || null,
+        cmpTrader
+    );
+
     // Loot resources as defined in the templates
     var resources = cmpLoot.GetResources();
     for (let type in resources)
-        resources[type] = ApplyValueModificationsToEntity("Looter/Resource/"+type, resources[type], this.entity);
+        resources[type] = ApplyValueModificationsToEntity("Looter/Resource/"+type, resources[type], this.entity)
+            + (resourcesCarried[type] || 0);
 
     // TODO: stop assuming that cmpLoot.GetResources() delivers all resource types (by defining them in a central location)
 
-    // Loot resources that killed enemies carried
-    var cmpResourceGatherer = Engine.QueryInterface(targetEntity, IID_ResourceGatherer);
-    if (cmpResourceGatherer)
-        for (let resource of cmpResourceGatherer.GetCarryingStatus())
-            resources[resource.type] += resource.amount;
-
-    // Loot resources traders carry
-    var cmpTrader = Engine.QueryInterface(targetEntity, IID_Trader);
-    if (cmpTrader)
-    {
-        let carriedGoods = cmpTrader.GetGoods();
-        if (carriedGoods.amount)
-        {
-            resources[carriedGoods.type] +=
-                + (carriedGoods.amount.traderGain || 0)
-                + (carriedGoods.amount.market1Gain || 0)
-                + (carriedGoods.amount.market2Gain || 0);
-        }
-    }
-
     // Transfer resources
     var cmpPlayer = QueryOwnerInterface(this.entity);
     cmpPlayer.AddResources(resources);

binaries/data/mods/public/simulation/components/tests/test_GuiInterface.js

@@ -15 +15 @@
 Engine.LoadComponentScript("interfaces/Guard.js");
 Engine.LoadComponentScript("interfaces/Heal.js");
 Engine.LoadComponentScript("interfaces/Health.js");
+Engine.LoadComponentScript("interfaces/Loot.js");
 Engine.LoadComponentScript("interfaces/Market.js");
 Engine.LoadComponentScript("interfaces/Pack.js");
 Engine.LoadComponentScript("interfaces/ProductionQueue.js");
@@ -535 +536 @@
     },
     buildingAI: null,
     heal: null,
+    loot: null,
     obstruction: null,
     turretParent: null,
     promotion: null,