Ticket #4217: specificNames.patch

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

@@ -336 +336 @@
 
 /**
  * Get information about a technology template.
+ *
  * @param template A valid template as obtained by loading the tech JSON file.
- * @param civ Civilization for which the specific name should be returned.
  */
-function GetTechnologyDataHelper(template, civ)
+function GetTechnologyDataHelper(template)
 {
     var ret = {};
 
-    // Get specific name for this civ or else the generic specific name
-    var specific;
-    if (template.specificName)
-    {
-        if (template.specificName[civ])
-            specific = template.specificName[civ];
-        else
-            specific = template.specificName['generic'];
-    }
-
     ret.name = {
-        "specific": specific,
+        "specific": template.specificName || undefined,
         "generic": template.genericName,
     };
 

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

@@ -412 +412 @@
 /**
  * Returns the cost information to display in the specified entity's construction button tooltip.
  */
-function getEntityCostTooltip(template, trainNum, entity)
+function getEntityCostTooltip(template, civ, trainNum, entity)
 {
     // Entities with a wallset component are proxies for initiating wall placement and as such do not have a cost of
     // their own; the individual wall pieces within it do.
@@ -538 +538 @@
     return tooltips.join("\n");
 }
 
-function getEntityNames(template)
+function getCivSpecificEntityName(template, civ)
 {
     if (!template.name.specific)
-        return template.name.generic;
+        return false;
+
+    if (typeof template.name.specific == "string")
+        if (template.name.specific != template.name.generic)
+            return template.name.specific;
+        else
+            return false;
+
+    if (template.name.specific[civ])
+        return template.name.specific[civ];
 
-    if (template.name.specific == template.name.generic)
-        return template.name.specific;
+    if (template.name.specific.generic)
+        return template.name.specific.generic;
+
+    return false;
+}
+
+function getEntityNames(template, civ)
+{
+    let specific = getCivSpecificEntityName(template, civ);
+    if (!specific)
+        return template.name.generic;
 
     return sprintf(translate("%(specificName)s (%(genericName)s)"), {
-        "specificName": template.name.specific,
+        "specificName": specific,
         "genericName": template.name.generic
     });
 
 }
-function getEntityNamesFormatted(template)
+function getEntityNamesFormatted(template, civ)
 {
-    if (!template.name.specific)
+    let specific = getCivSpecificEntityName(template, civ);
+    if (!specific)
         return '[font="sans-bold-16"]' + template.name.generic + "[/font]";
 
     return sprintf(translate("%(specificName)s %(fontStart)s(%(genericName)s)%(fontEnd)s"), {
         "specificName":
-            '[font="sans-bold-16"]' + template.name.specific[0] + '[/font]' +
-            '[font="sans-bold-12"]' + template.name.specific.slice(1).toUpperCase() + '[/font]',
+            '[font="sans-bold-16"]' + specific[0] + '[/font]' +
+            '[font="sans-bold-12"]' + specific.slice(1).toUpperCase() + '[/font]',
         "genericName": template.name.generic,
         "fontStart": '[font="sans-bold-16"]',
         "fontEnd": '[/font]'

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

@@ -316 +316 @@
             getGarrisonTooltip,
             getProjectilesTooltip,
             getPopulationBonusTooltip
-        ].map(func => func(template));
+        ].map(func => func(template, data.playerState.civ));
 
         let limits = getEntityLimitAndCount(data.playerState, data.item);
         tooltips.push(formatLimitString(limits.entLimit, limits.entCount, limits.entLimitChangers));
 
         if (!technologyEnabled)
             tooltips.push(sprintf(translate("Requires %(technology)s"), {
-                "technology": getEntityNames(GetTechnologyData(template.requiredTechnology))
+                "technology": getEntityNames(GetTechnologyData(template.requiredTechnology), data.playerState.civ)
             }));
 
         tooltips.push(getNeededResourcesTooltip(neededResources));
@@ -441 +441 @@
 
         let tooltip = canUngarrison || g_IsObserver ?
             sprintf(translate("Unload %(name)s"),
-            { "name": getEntityNames(template) }) + "\n" +
+            { "name": getEntityNames(template, data.playerState.civ) }) + "\n" +
             translate("Single-click to unload 1. Shift-click to unload all of this type.") :
-            getEntityNames(template);
+            getEntityNames(template, data.playerState.civ);
 
         tooltip += "\n" + sprintf(translate("Player: %(playername)s"), {
             "playername": g_Players[garrisonedUnitOwner].name
@@ -645 +645 @@
 
         data.button.onPress = function() { removeFromProductionQueue(data.item.producingEnt, data.item.id); };
 
-        let tooltip = getEntityNames(template);
+        let tooltip = getEntityNames(template, data.playerState.civ);
         if (data.item.neededSlots)
         {
             tooltip += "\n[color=\"red\"]" + translate("Insufficient population capacity:") + "\n[/color]";
@@ -758 +758 @@
                 getEntityNamesFormatted,
                 getEntityTooltip,
                 getEntityCostTooltip
-            ].map(func => func(template));
+            ].map(func => func(template, data.playerState.civ));
 
             if (!requirementsPassed)
             {
@@ -874 +874 @@
             }
         }
 
-        let tooltip = getEntityNames(template);
+        let tooltip = getEntityNames(template, data.playerState.civ);
         if (data.carried)
             tooltip += "\n" + Object.keys(data.carried).map(res =>
                 costIcon(res) + data.carried[res]
@@ -965 +965 @@
         let tooltips = [
             "[font=\"sans-bold-16\"]" +
                 colorizeHotkey("%(hotkey)s", "session.queueunit." + (data.i + 1)) +
-                "[/font]" + " " + getEntityNamesFormatted(template),
+                "[/font]" + " " + getEntityNamesFormatted(template, data.playerState.civ),
             getVisibleEntityClassesFormatted(template),
             getAurasTooltip(template),
             getEntityTooltip(template),
-            getEntityCostTooltip(template, trainNum, data.unitEntState.id)
+            getEntityCostTooltip(template, null, trainNum, data.unitEntState.id)
         ];
 
         let limits = getEntityLimitAndCount(data.playerState, data.item);
@@ -994 +994 @@
 
         if (!technologyEnabled)
             tooltips.push(sprintf(translate("Requires %(technology)s"), {
-                "technology": getEntityNames(GetTechnologyData(template.requiredTechnology))
+                "technology": getEntityNames(GetTechnologyData(template.requiredTechnology), data.playerState.civ)
             }));
 
         if (neededResources)
@@ -1084 +1084 @@
             tooltip += formatLimitString(limits.entLimit, limits.entCount, limits.entLimitChangers);
             if (!technologyEnabled)
                 tooltip += "\n" + sprintf(translate("Requires %(technology)s"), {
-                    "technology": getEntityNames(GetTechnologyData(data.item.requiredTechnology))
+                    "technology": getEntityNames(GetTechnologyData(data.item.requiredTechnology), data.playerState.civ)
                 });
 
             tooltip += getNeededResourcesTooltip(neededResources);

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

@@ -1000 +1000 @@
         let template = GetTechnologyData(tech);
         let button = Engine.GetGUIObjectByName("researchStartedButton[" + numButtons + "]");
         button.hidden = false;
-        button.tooltip = getEntityNames(template);
+        button.tooltip = getEntityNames(template, g_Players[g_ViewedPlayer].civ);
         button.onpress = (function(e) { return function() { selectAndMoveTo(e); }; })(researchStarted[tech].researcher);
 
         let icon = "stretched:session/portraits/" + template.icon;

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

@@ -384 +384 @@
  */
 function assembleTooltip(template)
 {
-    return g_TooltipFunctions.map(func => func(template)).filter(tip => tip).join("\n");
+    return g_TooltipFunctions.map(func => func(template, g_SelectedCiv)).filter(tip => tip).join("\n");
 }

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

@@ -97 +97 @@
         let realcode = depath(techcode);
 
         if (realcode.slice(0,4) == "pair" || realcode.indexOf("_pair") > -1)
-            techPairs[techcode] = loadTechnologyPair(techcode);
+        {
+            if (!techPairs[techcode])
+                techPairs[techcode] = loadTechnologyPair(techcode);
+        }
         else if (realcode.slice(0,5) == "phase")
-            g_ParsedData.phases[techcode] = loadPhase(techcode);
+        {
+            if (!g_ParsedData.phases[techcode])
+                g_ParsedData.phases[techcode] = loadPhase(techcode);
+        }
         else
-            g_ParsedData.techs[techcode] = loadTechnology(techcode);
+            if (!g_ParsedData.techs[techcode])
+                g_ParsedData.techs[techcode] = loadTechnology(techcode);
     }
 
     // Expand tech pairs

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

@@ -645 +645 @@
     }
 
     let cmpPlayer = QueryPlayerIDInterface(player, IID_Player);
-    return GetTechnologyDataHelper(template, cmpPlayer.GetCiv());
+    return GetTechnologyDataHelper(template);
 };
 
 GuiInterface.prototype.IsTechnologyResearched = function(player, data)