Ticket #1839: tribute-notifications.patch

simulation/components/Player.js

@@ -547 +547 @@
         var cmpTheirStatisticsTracker = QueryPlayerIDInterface(player, IID_StatisticsTracker);
         if (cmpTheirStatisticsTracker)
             cmpTheirStatisticsTracker.IncreaseTributesReceivedCounter(total);
-        // TODO: notify the receiver
+        
+        var notification = {"type": "tribute", "player": player, "player1": this.playerID, "amounts": amounts};
+        var cmpGUIInterface = Engine.QueryInterface(SYSTEM_ENTITY, IID_GuiInterface);
+        cmpGUIInterface.PushNotification(notification);
     }
     // else not enough resources... TODO: send gui notification
 };

gui/session/messages.js

@@ -53 +53 @@
         if (isDiplomacyOpen)
             openDiplomacy();
     }
+    else if (notification.type == "tribute")
+    {
+        addChatMessage({
+            "type": "tribute",
+            "player": notification.player,
+            "player1": notification.player1,
+            "amounts": notification.amounts
+        })
+    }
     else if (notification.type == "quit")
     {
         // Used for AI testing
@@ -306 +315 @@
         else // No need for other players to know of this.
             return;
         break;
+    case "tribute":
+        if (msg.player != Engine.GetPlayerID())
+            return;
+        
+        username = escapeText(g_Players[msg.player].name);
+        playerColor = g_Players[msg.player].color.r + " " + g_Players[msg.player].color.g + " " + g_Players[msg.player].color.b;
+        
+        // Format the amounts to proper English: 200 food, 100 wood, and 300 metal; 100 food; 400 wood and 200 stone
+        var amounts = Object.keys(msg.amounts)
+                 .filter(function (type) msg.amounts[type] > 0)
+                 .map(function (type) msg.amounts[type] + " " + type);
+        // This is one of the times I actually miss Common Lisp's incredibly cryptic but enormously useful format function.
+        // With that this would be a cute one-liner. I've racked my brain a bit and can't think of anything as elegant in JS.
+        // Now before I end up writing an essay in the comments, the code:
+        if (amounts.length > 1)
+        {
+            var lastAmount = amounts.pop();
+            amounts = amounts.join(", ") + " and " + lastAmount;
+        }
+        
+        formatted = "[color=\"" + playerColor + "\"]" + username + "[/color] has sent you " + amounts + ".";
+        break;
     case "message":
         // May have been hidden by the 'team' command.
         if (msg.hide)