Ticket #3258: t3258_move_map_description_v1.patch

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

@@ -129 +129 @@
     }
 
     return sizes;
 }
 
+/**
+ * Returns title or placeholder. Requires g_mapSizes.
+ *
+ * @param mapSize {Number} - tilecount
+ */
+function translateMapSize(tiles)
+{
+    var idx = g_mapSizes.tiles.findIndex(tileCount => tileCount == tiles);
+    return (idx == -1) ? translateWithContext("map size", "Default") : g_mapSizes.shortNames[idx];
+}
+
+/**
+ * Returns map description and preview image or placeholder.
+ */
+function getMapDescriptionAndPreview(mapType, mapName)
+{
+    var mapData;
+    if (mapType == "random" && mapName == "random")
+        mapData = { "settings": { "Description": translate("A randomly selected map.") } };
+    else if (mapType == "random" && Engine.FileExists(mapName + ".json"))
+        mapData = Engine.ReadJSONFile(mapName + ".json");
+    else if (Engine.FileExists(mapName + ".xml"))
+        mapData = Engine.LoadMapSettings(mapName + ".xml");
+    else
+        warn(sprintf("Map '%(mapName)s' not found locally.", { "mapName": mapName }));
+
+    return {
+        "description": mapData && mapData.settings.Description ? translate(mapData.settings.Description) : translate("Sorry, no description available."),
+        "preview": mapData && mapData.settings.Preview ? mapData.settings.Preview : "nopreview.png"
+    };
+}
+
 // ====================================================================
 
 // Convert integer color values to string (for use in GUI objects)
 function rgbToGuiColor(color, alpha)
 {

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

@@ -483 +483 @@
             else
                 name = '[color="255 0 0"]' + name + '[/color]';
             list_name.push(name);
             list_ip.push(g.ip);
             list_mapName.push(translate(g.niceMapName));
-            list_mapSize.push(translatedMapSize(g.mapSize));
+            list_mapSize.push(translateMapSize(g.mapSize));
             let mapTypeIdx = g_MapTypes.Name.indexOf(g.mapType);
             list_mapType.push(mapTypeIdx != -1 ? g_MapTypes.Title[mapTypeIdx] : "");
             list_nPlayers.push(g.nbp + "/" +g.tnbp);
             list.push(name);
             list_data.push(c);
@@ -561 +561 @@
     // Push this player's name and status onto the list
     return [formattedName, formattedStatus, formattedRating];
 }
 
 /**
- * Given a map size, returns that map size translated into the current
- * language.
- */
-function translatedMapSize(mapSize)
-{
-    if (+mapSize !== +mapSize) // NaN
-        return translate(mapSize);
-    else
-        return g_mapSizes.shortNames[g_mapSizes.tiles.indexOf(+mapSize)];
-}
-
-/**
  * Populate the game info area with information on the current game selection.
  */
 function updateGameSelection()
 {
     var selected = Engine.GetGUIObjectByName("gamesBox").selected;
@@ -587 +575 @@
         Engine.GetGUIObjectByName("joinGameButton").hidden = true;
         Engine.GetGUIObjectByName("gameInfoEmpty").hidden = false;
         return;
     }
 
-    var mapData;
     var g = Engine.GetGUIObjectByName("gamesBox").list_data[selected];
 
-    // Load map data
-    if (g_GameList[g].mapType == "random" && g_GameList[g].mapName == "random")
-        mapData = {"settings": {"Description": translate("A randomly selected map.")}};
-    else if (g_GameList[g].mapType == "random" && Engine.FileExists(g_GameList[g].mapName + ".json"))
-        mapData = Engine.ReadJSONFile(g_GameList[g].mapName + ".json");
-    else if (Engine.FileExists(g_GameList[g].mapName + ".xml"))
-        mapData = Engine.LoadMapSettings(g_GameList[g].mapName + ".xml");
-    else
-        // Warn the player if we can't find the map. 
-        warn(sprintf("Map '%(mapName)s' not found locally.", { mapName: g_GameList[g].mapName }));
-
     // Show the game info panel and join button.
     Engine.GetGUIObjectByName("gameInfo").hidden = false;
     Engine.GetGUIObjectByName("joinGameButton").hidden = false;
     Engine.GetGUIObjectByName("gameInfoEmpty").hidden = true;
 
     // Display the map name, number of players, the names of the players, the map size and the map type.
     Engine.GetGUIObjectByName("sgMapName").caption = translate(g_GameList[g].niceMapName);
     Engine.GetGUIObjectByName("sgNbPlayers").caption = g_GameList[g].nbp + "/" + g_GameList[g].tnbp;
     Engine.GetGUIObjectByName("sgPlayersNames").caption = g_GameList[g].players;
-    Engine.GetGUIObjectByName("sgMapSize").caption = translatedMapSize(g_GameList[g].mapSize);
+    Engine.GetGUIObjectByName("sgMapSize").caption = translateMapSize(g_GameList[g].mapSize);
     let mapTypeIdx = g_MapTypes.Name.indexOf(g_GameList[g].mapType);
     Engine.GetGUIObjectByName("sgMapType").caption = mapTypeIdx != -1 ? g_MapTypes.Title[mapTypeIdx] : "";
 
-    // Display map description if it exists, otherwise display a placeholder.
-    if (mapData && mapData.settings.Description)
-        var mapDescription = translate(mapData.settings.Description);
-    else
-        var mapDescription = translate("Sorry, no description available.");
 
     // Display map preview if it exists, otherwise display a placeholder.
     if (mapData && mapData.settings.Preview)
         var mapPreview = mapData.settings.Preview;
     else
         var mapPreview = "nopreview.png";
 
-    Engine.GetGUIObjectByName("sgMapDescription").caption = mapDescription;
-    Engine.GetGUIObjectByName("sgMapPreview").sprite = "cropped:(0.7812,0.5859)session/icons/mappreview/" + mapPreview;
+    // Display map description and preview (or placeholder)
+    var mapData = getMapDescriptionAndPreview(g_GameList[g].mapType, g_GameList[g].mapName);
+    Engine.GetGUIObjectByName("sgMapDescription").caption = mapData.description;
+    Engine.GetGUIObjectByName("sgMapPreview").sprite = "cropped:(0.7812,0.5859)session/icons/mappreview/" + mapData.preview;
 }
 
 /**
  * Start the joining process on the currectly selected game.
  */