Ticket #2405: colist_handler_lobby_sortable_game_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_GameListOrder = 1; // 1 for ascending sort, and -1 for descending
 var g_specialKey = Math.random();
 // This object looks like {"name":[numMessagesSinceReset, lastReset, timeBlocked]} when in use.
 var g_spamMonitor = {};
@@ -74 +76 @@
 // Update functions
 ////////////////////////////////////////////////////////////////////////////////////////////////
 
+function updateOrderSelection()
+{
+    var newGameListSortBy = Engine.GetGUIObjectByName("gamesBox").selected_column;
+
+    // If selected column equal to previous then just reverse order
+    if (newGameListSortBy == g_GameListSortBy)
+        g_GameListOrder = -g_GameListOrder;
+    else
+    {
+        g_GameListSortBy = newGameListSortBy;
+        g_GameListOrder = 1;
+    }
+
+    updateGameList();
+    updateGameSelection();
+}
+
 function resetFilters()
 {
     // Reset states of gui objects
@@ -365 +384 @@
     // 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;
+        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':
+            if (translatedMapSize(a.mapSize) < translatedMapSize(b.mapSize))
+                return -g_GameListOrder;
+            else if (translatedMapSize(a.mapSize) > translatedMapSize(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;
+            // 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 = [];

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

@@ -169 +169 @@
 
         <!-- 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">updateOrderSelection();</action>
                 <def id="name" color="0 60 0" width="27%">
                     <translatableAttribute id="heading">Name</translatableAttribute>
                 </def>

source/gui/COList.cpp

@@ -19 +19 @@
 #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");
+    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()
@@ -119 +127 @@
 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)