Ticket #2898: userNotify.3.patch

binaries/data/config/default.cfg

@@ -237 +237 @@
 milonly = Alt                ; Add only military units to selection
 idleonly = "I"               ; Select only idle units
 remove = Ctrl                ; Remove units from selection
-cancel = Esc                 ; Un-select all units and cancel building placement 
+cancel = Esc                 ; Un-select all units and cancel building placement
 idleworker = Period          ; Select next idle worker
 idlewarrior = ForwardSlash   ; Select next idle warrior
 offscreen = Alt              ; Include offscreen units in selection
@@ -381 +381 @@
 actiongain = 0.7
 uigain = 0.7
 
+[sound.notify]
+nick = true
+
 [tinygettext]
 debug = false                     ; Print error messages each time a translation for an English string is not found.
 

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

@@ -173 +173 @@
     {
         if (word.toLowerCase().indexOf(lastWord.toLowerCase()) != 0)
             continue;
-
+
         text = wordSplit.join(" ");
         if (text.length > 0)
             text += " ";
@@ -302 +302 @@
         });
     }).join("\n\n");
 }
+
+/**
+ * Plays a sound if user's nick is mentioned in chat
+ */
+function notifyUser(userName, msgText)
+{
+    if (Engine.ConfigDB_GetValue("user", "sound.notify.nick") != "true" ||
+         msgText.toLowerCase().indexOf(userName.toLowerCase()) == -1)
+            return;
+
+    let timeNow = new Date().getTime();
+
+    if (g_LastNickNotification == -1 || timeNow > g_LastNickNotification + 3000)
+        Engine.PlayUISound("audio/interface/select/resource/sel_metal_01.ogg", false);
+
+    g_LastNickNotification = timeNow;
+}

binaries/data/mods/public/gui/credits/texts/programming.json

@@ -24 +24 @@
             {"nick": "Alan", "name": "Alan Kemp"},
             {"nick": "aBothe", "name": "Alexander Bothe"},
             {"nick": "alpha123", "name": "Peter P. Cannici"},
+            {"nick": "andy5995", "name": "Andy Alt"},
             {"nick": "Aurium", "name": "Aurélio Heckert"},
             {"nick": "badmadblacksad", "name": "Martin F"},
             {"name": "Mikołaj \"Bajter\" Korcz"},

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

@@ -203 +203 @@
 var g_ChatMessages = [];
 
 /**
+ * Used by notifyUser() to limit the number of pings
+ */
+var g_LastNickNotification = -1;
+
+/**
  * Cache containing the mapsettings for scenario/skirmish maps. Just-in-time loading.
  */
 var g_MapData = {};
@@ -1804 +1809 @@
 
 function addChatMessage(msg)
 {
+    if (msg.text)
+    {
+        let userName = g_PlayerAssignments[Engine.GetPlayerGUID() || "local"].name;
+
+        if (userName != g_PlayerAssignments[msg.guid].name)
+            notifyUser(userName, msg.text);
+    }
+
     if (!g_FormatChatMessage[msg.type])
         return;
 

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

@@ -97 +97 @@
 var g_SpamMonitor = {};
 
 /**
+ * Used by notifyUser() to limit the number of pings
+ */
+var g_LastNickNotification = -1;
+
+/**
  * Used to restore the selection after updating the playerlist.
  */
 var g_SelectedPlayer = "";
@@ -821 +826 @@
 
         // Highlight local user's nick
         if (g_Username != msg.from)
+        {
             msg.text = msg.text.replace(g_Username, colorPlayerName(g_Username));
+            notifyUser(g_Username, msg.text);
+        }
 
         // Run spam test if it's not a historical message
         if (!msg.datetime)

binaries/data/mods/public/gui/options/options.json

@@ -165 +165 @@
         {
             "type": "boolean",
             "label": "Water Refraction",
-            "tooltip": "Use a real water refraction map and not transparency", 
+            "tooltip": "Use a real water refraction map and not transparency",
             "parameters": { "config": "waterrefraction", "renderer": "WaterRefraction" }
         },
         {
@@ -236 +236 @@
     [
         {
             "type": "number",
-            "label": "Chat Backlog", 
-            "tooltip": "Number of backlogged messages to load when joining the lobby", 
+            "label": "Chat Backlog",
+            "tooltip": "Number of backlogged messages to load when joining the lobby",
             "parameters": { "config": "lobby.history", "min": "0" }
         },
         {
             "type": "boolean",
             "label": "Chat Timestamp",
-            "tooltip": "Show time that messages are posted in the lobby chat", 
+            "tooltip": "Show time that messages are posted in the lobby chat",
             "parameters": { "config": "lobby.chattimestamp" }
+        },
+        {
+            "type": "boolean",
+            "label": "Nick Notification",
+            "tooltip": "Receive audio notification when someone types your nick",
+            "parameters": { "config": "sound.notify.nick" }
         }
     ]
 }

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

@@ -25 +25 @@
 var g_ChatTimers = [];
 
 /**
+ * Used by notifyUser() to limit the number of pings
+ */
+var g_LastNickNotification = -1;
+
+/**
  * Handle all netmessage types that can occur.
  */
 var g_NetMessageTypes = {
@@ -826 +831 @@
     // Translate or escape text
     if (!msg.text)
         return "";
+
     if (msg.translate)
     {
         msg.text = translate(msg.text);
@@ -837 +843 @@
         }
     }
     else
+    {
         msg.text = escapeText(msg.text);
 
+        let userName = g_PlayerAssignments[Engine.GetPlayerGUID() || "local"].name;
+
+        if (userName != g_PlayerAssignments[msg.guid].name)
+            notifyUser(userName, msg.text);
+    }
+
     // GUID for players, playerID for AIs
     let coloredUsername = msg.guid != -1 ? colorizePlayernameByGUID(msg.guid) : colorizePlayernameByID(msg.player);