Ticket #2405: colist_handler_lobby_sortable_game_and_player_list.patch

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

@@ -1 +1 @@
 var g_ChatMessages = [];
 var g_Name = "unknown";
 var g_GameList = {};
+var g_GameListSortBy = "default";
+var g_PlayerListSortBy = "default";
+var g_GameListOrder = 1; // 1 for ascending sort, and -1 for descending
+var g_PlayerListOrder = 1;
 var g_specialKey = Math.random();
 // This object looks like {"name":[numMessagesSinceReset, lastReset, timeBlocked]} when in use.
 var g_spamMonitor = {};
 var g_timestamp = Engine.ConfigDB_GetValue("user", "lobby.chattimestamp") == "true";
 var g_mapSizes = {};
@@ -71 +75 @@
 
 ////////////////////////////////////////////////////////////////////////////////////////////////
 // Update functions
 ////////////////////////////////////////////////////////////////////////////////////////////////
 
+function updateGameListOrderSelection()
+{
+    var orderBy = Engine.GetGUIObjectByName("gamesBox").selected_column;
+
+    // If selected column equal to previous then just reverse order
+    if (orderBy == g_GameListSortBy)
+        g_GameListOrder = -g_GameListOrder;
+    else
+    {
+        g_GameListSortBy = orderBy;
+        g_GameListOrder = 1;
+    }
+
+    applyFilters();
+}
+
+function updatePlayerListOrderSelection() {
+    var orderBy = Engine.GetGUIObjectByName("playersBox").selected_column;
+
+    // If selected column equal to previous then just reverse order
+    if (orderBy == g_PlayerListSortBy)
+        g_PlayerListOrder = -g_PlayerListOrder;
+    else
+    {
+        g_PlayerListSortBy = orderBy;
+        g_PlayerListOrder = 1;
+    }
+    updatePlayerList();
+}
+
 function resetFilters()
 {
     // Reset states of gui objects
     Engine.GetGUIObjectByName("mapSizeFilter").selected = 0
     Engine.GetGUIObjectByName("playersNumberFilter").selected = 0;
     Engine.GetGUIObjectByName("mapTypeFilter").selected = 0;
     Engine.GetGUIObjectByName("showFullFilter").checked = false;
 
-    // Update the list of games
-    updateGameList();
-
-    // Update info box about the game currently selected
-    updateGameSelection();
+    applyFilters();
 }
 
 function applyFilters()
 {
     // Update the list of games
@@ -146 +176 @@
         logo.size = "50%-110 40 50%+110 140";
     }
 }
 
 /**
- * Do a full update of the player listing, including ratings from C++.
+ * Do a full update of the player listing, including ratings from cached C++ information.
  *
  * @return Array containing the player, presence, nickname, and rating listings.
  */
 function updatePlayerList()
 {
@@ -161 +191 @@
     var ratingList = [];
     var cleanPlayerList = Engine.GetPlayerList();
     // Sort the player list, ignoring case.
     cleanPlayerList.sort(function(a,b) 
     {
-        var aName = a.name.toLowerCase();
-        var bName = b.name.toLowerCase();
-        return ((aName > bName) ? 1 : (bName > aName) ? -1 : 0);
-    } );
+        switch (g_PlayerListSortBy)
+        {
+        case 'rating':
+            if (a.rating < b.rating)
+                return -g_PlayerListOrder;
+            else if (a.rating > b.rating)
+                return g_PlayerListOrder;
+            return 0;
+        case 'status':
+            let order = ["available", "away", "playing", "gone", "offline"];
+            let presenceA = order.indexOf(a.presence);
+            let presenceB = order.indexOf(b.presence);
+            if (presenceA < presenceB)
+                return -g_PlayerListOrder;
+            else if (presenceA > presenceB)
+                return g_PlayerListOrder;
+            return 0;
+        default:
+            var aName = a.name.toLowerCase();
+            var bName = b.name.toLowerCase();
+            if (aName < bName)
+                return -g_PlayerListOrder;
+            else if (aName > bName)
+                return g_PlayerListOrder;
+            return 0;
+        }
+    });
     for (var i = 0; i < cleanPlayerList.length; i++)
     {
         // Identify current user's rating.
         if (cleanPlayerList[i].name == g_Name && cleanPlayerList[i].rating)
             g_userRating = cleanPlayerList[i].rating;
@@ -362 +415 @@
     g_GameList = gameList;
 
     // Sort the list of games to that games 'waiting' are displayed at the top, followed by 'init', followed by 'running'.
     var gameStatuses = ['waiting', 'init', 'running'];
     g_GameList.sort(function (a,b) {
-        if (gameStatuses.indexOf(a.state) < gameStatuses.indexOf(b.state))
-            return -1;
-        else if (gameStatuses.indexOf(a.state) > gameStatuses.indexOf(b.state))
-            return 1;
-
-        // Alphabetical comparison of names as tiebreaker.
-        if (a.name < b.name)
-            return -1;
-        else if (a.name > b.name)
-            return 1;
-        return 0;
+        switch (g_GameListSortBy)
+        {
+        case 'name':
+            if (a.name < b.name)
+                return -g_GameListOrder;
+            else if (a.name > b.name)
+                return g_GameListOrder;
+            return 0;
+        case 'mapName':
+            if (translate(a.niceMapName) < translate(b.niceMapName))
+                return -g_GameListOrder;
+            else if (translate(a.niceMapName) > translate(b.niceMapName))
+                return g_GameListOrder;
+            return 0;
+        case 'mapSize':
+            // mapSize contains the number of tiles for random maps
+            // scenario maps always display default size
+            if (a.mapSize < b.mapSize)
+                return -g_GameListOrder;
+            else if (a.mapSize > b.mapSize)
+                return g_GameListOrder;
+            return 0;
+        case 'mapType':
+            if (a.mapType < b.mapType)
+                return -g_GameListOrder;
+            else if (a.mapType > b.mapType)
+                return g_GameListOrder;
+            return 0;
+        case 'nPlayers':
+            // Numerical comparison of player count ratio.
+            if (a.nbp * b.tnbp < b.nbp * a.tnbp) // ratio a = a.nbp / a.tnbp, ratio b = b.nbp / b.tnbp
+                return -g_GameListOrder;
+            else if (a.nbp * b.tnbp > b.nbp * a.tnbp)
+                return g_GameListOrder;
+            return 0;
+        default:
+            if (gameStatuses.indexOf(a.state) < gameStatuses.indexOf(b.state))
+                return -1;
+            else if (gameStatuses.indexOf(a.state) > gameStatuses.indexOf(b.state))
+                return 1;
+
+            // Alphabetical comparison of names as tiebreaker.
+            if (a.name < b.name)
+                return -1;
+            else if (a.name > b.name)
+                return 1;
+            return 0;
+        }
     });
 
     var list_name = [];
     var list_ip = [];
     var list_mapName = [];

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

@@ -18 +18 @@
             onTick();
         </action>
 
         <!-- Left panel: Player list. -->
         <object name="leftPanel" size="20 30 20% 100%-280">
-            <object name="playersBox" style="ModernList" type="olist" size="0 0 100% 100%" font="sans-bold-stroke-13">
+            <object name="playersBox" style="ModernList" type="olist" sortable="true" size="0 0 100% 100%" font="sans-bold-stroke-13">
                 <def id="status" width="26%">
                     <translatableAttribute id="heading">Status</translatableAttribute>
                 </def>
                 <def id="name" width="50%">
                     <translatableAttribute id="heading">Name</translatableAttribute>
@@ -31 +31 @@
                     <translatableAttribute id="heading">Rating</translatableAttribute>
                 </def>
                 <action on="SelectionChange">
                     displayProfile("lobbylist");
                 </action>
+                <action on="SelectionColumnChange">
+                    updatePlayerListOrderSelection();
+                </action> 
             </object>
         </object>
 
         <object name="profilePanel" size="20 100%-275 20% 100%-80">
             <object name="profileBox" type="image" sprite="ModernDarkBoxGold" size="0 0 100% 100%">
@@ -167 +170 @@
             </object>
         </object>
 
         <!-- Middle panel: Filters, game list, chat box. -->
         <object name="middlePanel" size="20%+5 5% 100%-255 97.2%">
-            <object name="gamesBox" style="ModernList" type="olist" size="0 25 100% 48%" font="sans-stroke-13">
+            <object name="gamesBox" style="ModernList" type="olist" sortable="true" size="0 25 100% 48%" font="sans-stroke-13">
                 <action on="SelectionChange">updateGameSelection();</action>
+                <action on="SelectionColumnChange">updateGameListOrderSelection();</action>
                 <def id="name" color="0 60 0" width="27%">
                     <translatableAttribute id="heading">Name</translatableAttribute>
                 </def>
                 <!--<def id="ip" heading="IP" color="0 128 128" width="170"/>-->
                 <def id="mapName" color="128 128 128" width="25%">

source/gui/COList.cpp

@@ -17 +17 @@
 #include "precompiled.h"
 #include "COList.h"
 #include "i18n/L10n.h"
 
 #include "ps/CLogger.h"
+#include "soundmanager/ISoundManager.h"
 
 COList::COList() : CList(),m_HeadingHeight(30.f)
 {
     AddSetting(GUIST_CGUISpriteInstance,    "sprite_heading");
+    AddSetting(GUIST_bool,                  "sortable"); // The actual sorting is done in JS for more versatility
+    AddSetting(GUIST_CStr,                  "selected_column");
+    AddSetting(GUIST_int,                   "selected_def");
+
+    // Nothing is selected by default.
+    GUI<CStr>::SetSetting(this, "selected_column", "");
+    GUI<int>::SetSetting(this, "selected_def", -1);
 }
 
 void COList::SetupText()
 {
     if (!GetGUI())
@@ -117 +125 @@
 }
 
 void COList::HandleMessage(SGUIMessage &Message)
 {
     CList::HandleMessage(Message);
+
+    switch (Message.type)
+    {
+    // If somebody clicks on the column heading
+    case GUIM_MOUSE_PRESS_LEFT:
+    {
+        bool sortable;
+        GUI<bool>::GetSetting(this, "sortable", sortable);
+        if (!sortable)
+            return;
+
+        CPos mouse = GetMousePos();
+        if (!m_CachedActualSize.PointInside(mouse))
+            return;
+        
+        float xpos = 0;
+        for (unsigned int def = 0; def < m_ObjectsDefs.size(); ++def)
+        {
+            float width = m_ObjectsDefs[def].m_Width;
+            // Check if it's a decimal value, and if so, assume relative positioning.
+            if (m_ObjectsDefs[def].m_Width < 1 && m_ObjectsDefs[def].m_Width > 0)
+                width *= m_TotalAvalibleColumnWidth;
+            CPos leftTopCorner = m_CachedActualSize.TopLeft() + CPos(xpos, 4);
+            if (mouse.x >= leftTopCorner.x &&
+                mouse.x < leftTopCorner.x + width &&
+                mouse.y < leftTopCorner.y + m_HeadingHeight)
+            {
+                GUI<CStr>::SetSetting(this, "selected_column", m_ObjectsDefs[def].m_Id.substr(5));
+                GUI<int>::SetSetting(this, "selected_def", def);
+                ScriptEvent("selectioncolumnchange");
+
+                CStrW soundPath;
+                if (g_SoundManager && GUI<CStrW>::GetSetting(this, "sound_selected", soundPath) == PSRETURN_OK && !soundPath.empty())
+                    g_SoundManager->PlayAsUI(soundPath.c_str(), false);
+
+                return;
+            }
+            xpos += width;
+        }
+        return;
+    }
+    default:
+        return;
+    }
 }
 
 bool COList::HandleAdditionalChildren(const XMBElement& child, CXeromyces* pFile)
 {
     #define ELMT(x) int elmt_##x = pFile->GetElementID(#x)