Ticket #2898: userNotify.4.2.patch

binaries/data/config/default.cfg

@@ -235 +235 @@
 [hotkey.selection]
 add = Shift                  ; Add units to selection
 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
 [hotkey.selection.group.add]
 0 = "Shift+0"
@@ -379 +379 @@
 musicgain = 0.2
 ambientgain = 0.6
 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.
 
 [userreport] ; Opt-in online user reporting system
 url = "http://feedback.wildfiregames.com/report/upload/v1/"

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

@@ +1 @@
+/**
+ * Used by notifyUser() to limit the number of pings
+ */
+var g_LastNickNotification = -1;
+
+/**
+ * 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 || timeNow > g_LastNickNotification + 3000)
+        Engine.PlayUISound("audio/interface/ui/chat_alert.ogg", false);
+
+    g_LastNickNotification = timeNow;
+}
+
 function getRandom(randomMin, randomMax)
 {
     // Returns a random whole number in a min..max range.
     // NOTE: There should probably be an engine function for this,
     // since we'd need to keep track of random seeds for replays.
@@ -392 +414 @@
             "playerDescriptions": playerDescriptions.observer.join("\n")
         }));
 
     return teamDescription.join("\n\n");
 }
+
+

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

@@ -22 +22 @@
             {"name": "Adrian Fatol"},
             {"nick": "AI-Amsterdam"},
             {"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"},
             {"nick": "bb", "name": "Bouke Jansen"},
             {"nick": "Ben", "name": "Ben Vinegar"},

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

@@ -1803 +1803 @@
     return '[color="'+ color +'"]' + username + '[/color]';
 }
 
 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;
 
     let user = colorizePlayernameByGUID(msg.guid || -1, msg.username || "");
 

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

@@ -819 +819 @@
         if (Engine.LobbyGetPlayerRole(msg.from) == "moderator")
             msg.from = g_ModeratorPrefix + msg.from;
 
         // 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)
         {
             updateSpamMonitor(msg.from);

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

@@ -163 +163 @@
             "parameters": { "config": "waterreflection", "renderer": "WaterReflection" }
         },
         {
             "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" }
         },
         {
             "type": "boolean",
             "label": "Shadows on Water",
@@ -228 +228 @@
         {
             "type": "number",
             "label": "UI Gain",
             "tooltip": "UI sound gain",
             "parameters": { "config": "sound.uigain", "function": "SetUIGain", "min": "0" }
+        },
+        {
+            "type": "boolean",
+            "label": "Nick Notification",
+            "tooltip": "Receive audio notification when someone types your nick",
+            "parameters": { "config": "sound.notify.nick" }
         }
     ],
     "lobbySetting":
     [
         {
             "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" }
         }
     ]
 }

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

@@ -820 +820 @@
         msg.text = msg.text.substr("/me ".length);
 
     // Translate or escape text
     if (!msg.text)
         return "";
+
     if (msg.translate)
     {
         msg.text = translate(msg.text);
         if (msg.translateParameters)
         {
@@ -831 +832 @@
             translateObjectKeys(parameters, msg.translateParameters);
             msg.text = sprintf(msg.text, parameters);
         }
     }
     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);
 
     return sprintf(g_ChatCommands[isMe ? "me" : "regular"][msg.context ? "context" : "no-context"], {
         "message": msg.text,