Dealing with a tooltip of zero time cost

[Langbart]

Obelix reported an issue in the forum about a side effect of the new civbonus (​mace_storehouse.json) for the Macedonians (added with [26627]).

• ​Alpha 26 Pre-release/Release Candidate Build Testing (10/Jul/22)

issue

The tech sets the time to zero

Line
10	"modifications": [
11	{
12	"value": "Researcher/TechCostMultiplier/time",
13	"replace": 0
14	}
15	],

the tooltip time is checked twice for its existence with an if statement.

Line
720	let totalCosts = multiplyEntityCosts(template, buildingsCountToTrainFullBatch * fullBatchSize + remainderBatch);
721	if (template.cost.time)
722	totalCosts.time = Math.ceil(template.cost.time * (entity ? Engine.GuiInterfaceCall("GetBatchTime", {
723	"entity": entity,
724	"batchSize": buildingsCountToTrainFullBatch > 0 ? fullBatchSize : remainderBatch
725	}) : 1));
726
727	let costs = [];
728	for (let type of getCostTypes())
729	if (totalCosts[type])
730	costs.push(sprintf(translate("%(component)s %(cost)s"), {

possible solutions

idea A

rework the JavaScript part for the tooltip. The result would display a time of 0.

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

@@ -718 +718 @@
     if (!template.cost)
         return [];
     let totalCosts = multiplyEntityCosts(template, buildingsCountToTrainFullBatch * fullBatchSize + remainderBatch);
-    if (template.cost.time)
+    if (typeof template.cost.time == "number")
         totalCosts.time = Math.ceil(template.cost.time * (entity ? Engine.GuiInterfaceCall("GetBatchTime", {
             "entity": entity,
             "batchSize": buildingsCountToTrainFullBatch > 0 ? fullBatchSize : remainderBatch
@@ -726 +726 @@
 
     let costs = [];
     for (let type of getCostTypes())
-        if (totalCosts[type])
+        if (typeof totalCosts[type] == "number")
             costs.push(sprintf(translate("%(component)s %(cost)s"), {
                 "component": resourceIcon(type),
                 "cost": totalCosts[type]

idea B

rework the tech, by doing a multiplication with a low value e.g. 0.01 (similar to the cheat code gift from the gods to get fast actions (​fastactions.js). The result would display a time of 1.

binaries/data/mods/public/simulation/data/technologies/civbonuses/mace_storehouse.json

@@ -4 +4 @@
     "description": "The Macedonian economy relied greatly on their vast natural resources.",
     "requirements": { "civ": "mace" },
     "icon": "wood_axe.png",
-    "tooltip": "Storehouse technologies −100% research time.",
+    "tooltip": "Research happens instantly.",
     "modifications": [
-        { "value": "Researcher/TechCostMultiplier/time", "replace": 0 }
+        { "value": "Researcher/TechCostMultiplier/time", "multiply": 0.01 }
     ],
     "affects": ["Storehouse"]
 }

additional nitpick

(just a point of polish that they could choose to ignore it)

The string Right-click (​tooltips.js) should get a color treatment,

Line
1210	// Translation: Appears in a tooltip to indicate that right-clicking the corresponding GUI element will open the Template Details GUI page.
1211	return translate("Right-click to view more information.");
1212	}

like its being done for the string Click in the getOrderTooltip function (​CounterManager.js).

Line
101	return "\n" + sprintf(translate("%(order)s: %(hotkey)s to change order."), {
102	"hotkey": setStringTags("\\[Click]", g_HotkeyTags),
103	"order":