Ticket #2640: 2640_4.patch

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

@@ +1 @@
+const INVALID_MESSAGE = "Invalid chat message ";
+
+// GAMESETUP CONSTANTS
+const CONNECT_TEXT = " has joined";
+const DISCONNECT_TEXT = " has left";
+const USER_READY_TEXT = " is ready!";
+const USER_NOT_READY_TEXT = " is not ready.";
+const SETTINGS_CHANGED_TEXT = "Game settings have been changed";
+
+// IN-GAME CONSTANTS
+const CONNECT_TEXT_INGAME = " has joined the game.";
+const DISCONNECT_TEXT_INGAME = " has left the game.";
+
+const DEFEATED_TEXT_PLAYER_1 = "You have been defeated."
+const DEFEATED_TEXT_PLAYER_X = " has been defeated."
+
+const DIPLOMACY_ALLY_TEXT = "You are now allied with ";
+const DIPLOMACY_ENEMY_TEXT = "You are now at war with ";
+const DIPLOMACY_NEUTRAL_TEXT = "You are now neutral with ";
+const DIPLOMACY_ALLY_TEXT_2 = " is now allied with you.";
+const DIPLOMACY_ENEMY_TEXT_2 = " is now at war with you.";
+const DIPLOMACY_NEUTRAL_TEXT_2 = " is now neutral with you.";
+
+const TRIBUTE_TEXT = " has sent you ";
+const ATTACK_TEXT = "You have been attacked by ";
+
+
+// GAMESETUP MESSAGE TYPES and IN-GAME MESSAGE TYPES
+const CONNECT_STR = "connect";
+const DISCONNECT_STR = "disconnect";
+const MESSAGE_STR = "message";
+
+// GAMESETUP MESSAGE TYPES
+const READY_STR = "ready";
+const SETTINGS_STR = "settings";
+
+
+// IN-GAME MESSAGE TYPES
+const DEFEAT_STR = "defeat";
+const DIPLOMACY_STR = "diplomacy";
+const TRIBUTE_STR = "tribute";
+const ATTACK_STR = "attack";
+
+
+
+// other miscellaneous constants
+const ALLY_STR = "ally";
+const ENEMY_STR = "enemy";
+const NEUTRAL_STR = "neutral";
+ No newline at end of file

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

@@ -284 +284 @@
     input.caption = newText + text.substring(bufferPosition);
     input.buffer_position = bufferPosition + (newText.length - textTillBufferPosition.length);
 }
+
+function colorText(text, color)
+{
+    return '[color="'+ color +'"]' + text + '[/color]';
+}
+
+function boldText(text)
+{
+    return '[font="sans-bold-13"] ' + text + '[/font]';
+}
+
+function prependText(text, textToPrepend)
+{
+    return textToPrepend + text;
+}
+
+function postpendText(text, textToPostpend)
+{
+    return text + textToPostpend;
+}

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

@@ -1660 +1660 @@
 
         color = rgbToGuiColor(getSetting(pData, pDefs, "Color"));
     }
+    
+    username = colorText(username, color);
 
     var formatted;
     switch (msg.type)
     {
-    case "connect":
-        var formattedUsername = '[color="'+ color +'"]' + username + '[/color]';
-        formatted = '[font="sans-bold-13"] ' + sprintf(translate("== %(message)s"), { message: sprintf(translate("%(username)s has joined"), { username: formattedUsername }) }) + '[/font]';
+    case CONNECT_STR:
+        formatted = boldText(sprintf(translate("== %(message)s"), { message: sprintf(translate("%(username)s" + CONNECT_TEXT), {username : username})}));
         break;
 
-    case "disconnect":
-        var formattedUsername = '[color="'+ color +'"]' + username + '[/color]';
-        formatted = '[font="sans-bold-13"] ' + sprintf(translate("== %(message)s"), { message: sprintf(translate("%(username)s has left"), { username: formattedUsername }) }) + '[/font]';
+    case DISCONNECT_STR:
+        formatted = boldText(sprintf(translate("== %(message)s"), { message: sprintf(translate("%(username)s" + DISCONNECT_TEXT), {username : username})}));
         break;
 
-    case "message":
-        var formattedUsername = '[color="'+ color +'"]' + username + '[/color]';
-        var formattedUsernamePrefix = '[font="sans-bold-13"]' + sprintf(translate("<%(username)s>"), { username: formattedUsername }) + '[/font]'
+    case MESSAGE_STR:
+        var formattedUsernamePrefix = boldText(sprintf(translate("<%(username)s>"), {username : username}));
         formatted = sprintf(translate("%(username)s %(message)s"), { username: formattedUsernamePrefix, message: message });
         break;
 
-    case "ready":
-        var formattedUsername = '[font="sans-bold-13"][color="'+ color +'"]' + username + '[/color][/font]'
+    case READY_STR:
         if (msg.ready)
-            formatted = ' ' + sprintf(translate("* %(username)s is ready!"), { username: formattedUsername });
+            formatted = ' ' + sprintf(translate("* %(username)s is ready!"), {username: boldText(username)});
         else
-            formatted = ' ' + sprintf(translate("* %(username)s is not ready."), { username: formattedUsername });
+            formatted = ' ' + sprintf(translate("* %(username)s is not ready."), {username: boldText(username)});
         break;
 
-    case "settings":
-        formatted = '[font="sans-bold-13"] ' + sprintf(translate("== %(message)s"), { message: translate('Game settings have been changed') }) + '[/font]';
+    case SETTINGS_STR:
+        formatted = boldText(sprintf(translate("== %(message)s"), { message: translate(SETTINGS_CHANGED_TEXT) }));
         break;
 
     default:
-        error(sprintf("Invalid chat message '%(message)s'", { message: uneval(msg) }));
+        error(sprintf(INVALID_MESSAGE + "'%(message)s'", { message: uneval(msg) }));
         return;
     }
 

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

@@ -3 +3 @@
 <objects>
 
     <script file="gui/common/network.js"/>
+    <script file="gui/common/functions_chat.js"/>
     <script file="gui/common/functions_civinfo.js"/>
     <script file="gui/common/functions_global_object.js"/>
     <script file="gui/common/functions_utility.js"/>

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

@@ -388 +388 @@
 
 function addChatMessage(msg, playerAssignments)
 {
+    // take care of exit cases early so it cleans up the logic below
+    if ((msg.type == "tribute" || msg.type == "attack") && msg.player != Engine.GetPlayerID()) 
+        return;
+    // May have been hidden by the 'team' command.
+    if (msg.type == "message" && msg.hide)
+        return;
+    // Don't need to alert diplomacy if we're not involved
+    if (msg.type == "diplomacy" && (msg.player != Engine.GetPlayerID() && msg.player1 != Engine.GetPlayerID()))
+        return;
+
     // Default to global assignments, but allow overriding for when reporting
     // new players joining
     if (!playerAssignments)
@@ -408 +418 @@
         username = escapeText(playerAssignments[msg.guid].name);
 
         // Parse in-line commands in regular messages.
-        if (msg.type == "message")
+        if (msg.type == MESSAGE_STR)
             parseChatCommands(msg, playerAssignments);
     }
-    else if (msg.type == "defeat" && msg.player)
+    else if (msg.type == DEFEAT_STR && msg.player)
     {
         [username, playerColor] = getUsernameAndColor(msg.player);
     }
-    else if (msg.type == "message")
+    else if (msg.type == MESSAGE_STR)
     {
         [username, playerColor] = getUsernameAndColor(msg.player);
         parseChatCommands(msg, playerAssignments);
@@ -427 +437 @@
     }
 
     var formatted;
-
+    var formattedUserName = colorText(username, playerColor);
+    
     switch (msg.type)
     {
-    case "connect":
-        formatted = sprintf(translate("%(player)s has joined the game."), { player: "[color=\"" + playerColor + "\"]" + username + "[/color]" });
+    case CONNECT_STR:
+        formatted = sprintf(translate("%(player)s" + CONNECT_TEXT_INGAME), {player : formattedUserName});
         break;
-    case "disconnect":
-        formatted = sprintf(translate("%(player)s has left the game."), { player: "[color=\"" + playerColor + "\"]" + username + "[/color]" });
+    case DISCONNECT_STR:
+        formatted = sprintf(translate("%(player)s" + DISCONNECT_TEXT_INGAME), {player : formattedUserName});
         break;
-    case "defeat":
+    case DEFEAT_STR:
         // In singleplayer, the local player is "You". "You has" is incorrect.
         if (!g_IsNetworked && msg.player == Engine.GetPlayerID())
-            formatted = translate("You have been defeated.");
+            formatted = translate(DEFEATED_TEXT_PLAYER_1);
         else
-            formatted = sprintf(translate("%(player)s has been defeated."), { player: "[color=\"" + playerColor + "\"]" + username + "[/color]" });
+            formatted = sprintf(translate("%(player)s" + DEFEATED_TEXT_PLAYER_X), {player : formattedUserName});
         break;
-    case "diplomacy":
-        var status = (msg.status == "ally" ? "allied" : (msg.status == "enemy" ? "at war" : "neutral"));
+    case DIPLOMACY_STR:
         if (msg.player == Engine.GetPlayerID())
         {
             [username, playerColor] = getUsernameAndColor(msg.player1);
-            if (msg.status == "ally")
-                formatted = sprintf(translate("You are now allied with %(player)s."), { player: "[color=\"" + playerColor + "\"]" + username + "[/color]" });
-            else if (msg.status == "enemy")
-                formatted = sprintf(translate("You are now at war with %(player)s."), { player: "[color=\"" + playerColor + "\"]" + username + "[/color]" });
-            else // (msg.status == "neutral")
-                formatted = sprintf(translate("You are now neutral with %(player)s."), { player: "[color=\"" + playerColor + "\"]" + username + "[/color]" });
+            if (msg.status == ALLY_STR)
+                formatted = sprintf(translate(DIPLOMACY_ALLY_TEXT + "%(player)s."), {player : formattedUserName});
+            else if (msg.status == ENEMY_STR)
+                formatted = sprintf(translate(DIPLOMACY_ENEMY_TEXT + "%(player)s."), {player : formattedUserName});
+            else
+                formatted = sprintf(translate(DIPLOMACY_NEUTRAL_TEXT + "%(player)s."), {player : formattedUserName});
         }
         else if (msg.player1 == Engine.GetPlayerID())
         {
             [username, playerColor] = getUsernameAndColor(msg.player);
-            if (msg.status == "ally")
-                formatted = sprintf(translate("%(player)s is now allied with you."), { player: "[color=\"" + playerColor + "\"]" + username + "[/color]" });
-            else if (msg.status == "enemy")
-                formatted = sprintf(translate("%(player)s is now at war with you."), { player: "[color=\"" + playerColor + "\"]" + username + "[/color]" });
-            else // (msg.status == "neutral")
-                formatted = sprintf(translate("%(player)s is now neutral with you."), { player: "[color=\"" + playerColor + "\"]" + username + "[/color]" });
+            if (msg.status == ALLY_STR)
+                formatted = sprintf(translate("%(player)s" + DIPLOMACY_ALLY_TEXT_2), {player : formattedUserName});
+            else if (msg.status == ENEMY_STR)
+                formatted = sprintf(translate("%(player)s" + DIPLOMACY_ENEMY_TEXT_2), {player : formattedUserName});
+            else
+                formatted = sprintf(translate("%(player)s" + DIPLOMACY_NEUTRAL_TEXT_2), {player : formattedUserName});
         }
-        else // No need for other players to know of this.
-            return;
-        break;
-    case "tribute":
-        if (msg.player != Engine.GetPlayerID()) 
-            return;
-
+    case TRIBUTE_STR:
         [username, playerColor] = getUsernameAndColor(msg.player1);
 
-        // Format the amounts to proper English: 200 food, 100 wood, and 300 metal; 100 food; 400 wood and 200 stone
-        let amounts = Object.keys(msg.amounts)
-            .filter(function (type) { return msg.amounts[type] > 0; })
-            .map(function (type) { return sprintf(translate("%(amount)s %(resourceType)s"), {
-                "amount": msg.amounts[type],
-                "resourceType": getLocalizedResourceName(type, "withinSentence")});
-            });
+        let amounts = getTributeAmounts(msg);
 
-        if (amounts.length > 1)
-        {
-            let lastAmount = amounts.pop();
-            amounts = sprintf(translate("%(previousAmounts)s and %(lastAmount)s"), {
-                previousAmounts: amounts.join(translate(", ")),
-                lastAmount: lastAmount
-            });
-        }
-
-        formatted = sprintf(translate("%(player)s has sent you %(amounts)s."), {
-            player: "[color=\"" + playerColor + "\"]" + username + "[/color]",
+        formatted = sprintf(translate("%(player)s" + TRIBUTE_TEXT + "%(amounts)s."), {
+            player: formattedUserName,
             amounts: amounts
         });
         break;
-    case "attack":
-        if (msg.player != Engine.GetPlayerID()) 
-            return;
-
+    case ATTACK_STR:
         [username, playerColor] = getUsernameAndColor(msg.attacker);
-        formatted = sprintf(translate("You have been attacked by %(attacker)s!"), { attacker: "[color=\"" + playerColor + "\"]" + username + "[/color]" });
+        formatted = sprintf(translate(ATTACK_TEXT + "%(attacker)s!"), {attacker : colorText(username, playerColor)});
         break;
-    case "message":
-        // May have been hidden by the 'team' command.
-        if (msg.hide)
-            return;
-
+    case MESSAGE_STR:
         var message;
         if ("translate" in msg && msg.translate)
         {
@@ -528 +510 @@
             {
                 formatted = sprintf(translate("(%(context)s) * %(user)s %(message)s"), {
                     context: msg.context,
-                    user: "[color=\"" + playerColor + "\"]" + username + "[/color]",
+                    user: formattedUserName,
                     message: message
                 });
             }
@@ -535 +517 @@
             else
             {
                 formatted = sprintf(translate("* %(user)s %(message)s"), {
-                    user: "[color=\"" + playerColor + "\"]" + username + "[/color]",
+                    user: formattedUserName,
                     message: message
                 });
             }
@@ -542 +524 @@
         }
         else
         {
-            var userTag = sprintf(translate("<%(user)s>"), { user: username })
-            var formattedUserTag = sprintf(translate("<%(user)s>"), { user: "[color=\"" + playerColor + "\"]" + username + "[/color]" })
+            var userTag = sprintf(translate("<%(user)s>"), {user : username})
+            var formattedUserTag = sprintf(translate("<%(user)s>"), {user : formattedUserName})
             if (msg.context !== "")
             {
                 formatted = sprintf(translate("(%(context)s) %(userTag)s %(message)s"), {
@@ -559 +541 @@
         }
         break;
     default:
-        error(sprintf("Invalid chat message '%(message)s'", { message: uneval(msg) }));
+        error(sprintf(INVALID_MESSAGE + "'%(message)s'", { message: uneval(msg) }));
         return;
     }
 
@@ -572 +554 @@
         Engine.GetGUIObjectByName("chatText").caption = chatMessages.join("\n");
 }
 
+function getTributeAmounts(msg) {       
+    // Format the amounts to proper English: 200 food, 100 wood, and 300 metal; 100 food; 400 wood and 200 stone
+    let amounts = Object.keys(msg.amounts)
+        .filter(function (type) { return msg.amounts[type] > 0; })
+        .map(function (type) { return sprintf(translate("%(amount)s %(resourceType)s"), {
+            amount: msg.amounts[type],
+            resourceType: getLocalizedResourceName(type, "withinSentence")});
+        });
+
+    if (amounts.length > 1)
+    {
+        let lastAmount = amounts.pop();
+        amounts = sprintf(translate("%(previousAmounts)s and %(lastAmount)s"), {
+            previousAmounts: amounts.join(translate(", ")),
+            lastAmount: lastAmount
+        });
+    }
+    return amounts;
+}
+
 function removeOldChatMessages()
 {
     clearTimeout(chatTimers[0]); // The timer only needs to be cleared when new messages bump old messages off

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

@@ -3 +3 @@
 <objects>
 
 <script file="gui/common/colorFades.js"/>
+<script file="gui/common/functions_chat.js"/>
 <script file="gui/common/functions_civinfo.js"/>
 <script file="gui/common/functions_global_object.js"/>
 <script file="gui/common/functions_utility.js"/>