Ticket #1767: chat_addressee_dropdown_v1.patch

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

@@ -85 +85 @@
             })
         });
 }
 
 /**
- * Get a colorized list of usernames sorted by player slot, observers last.
- * Requires g_PlayerAssignments and colorizePlayernameByGUID.
- *
- * @returns {string}
+ * Sort GUIDs of connected users sorted by playerindex, observers last.
+ * Requires g_PlayerAssignments.
  */
-function getUsernameList()
+function sortGUIDsByPlayerID()
 {
-    let usernames = Object.keys(g_PlayerAssignments).sort((guidA, guidB) => {
+    return Object.keys(g_PlayerAssignments).sort((guidA, guidB) => {
 
         let playerIdA = g_PlayerAssignments[guidA].player;
         let playerIdB = g_PlayerAssignments[guidB].player;
 
-        // Sort observers last
         if (playerIdA == -1) return +1;
         if (playerIdB == -1) return -1;
 
-        // Sort players
         return playerIdA - playerIdB;
+    });
+}
 
-    }).map(guid => colorizePlayernameByGUID(guid));
+/**
+ * Get a colorized list of usernames sorted by player slot, observers last.
+ * Requires g_PlayerAssignments and colorizePlayernameByGUID.
+ *
+ * @returns {string}
+ */
+function getUsernameList()
+{
+    let usernames = sortGUIDsByPlayerID().map(guid => colorizePlayernameByGUID(guid));
 
     return sprintf(translate("Users: %(users)s"),
         // Translation: This comma is used for separating first to penultimate elements in an enumeration.
         { "users": usernames.join(translate(", ")) });
 }

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

@@ -201 +201 @@
     if (g_Disconnected)
         return;
 
     closeOpenDialogs();
 
-    updateTeamCheckbox(false);
+    setTeamChat(false);
 
     Engine.GetGUIObjectByName("chatInput").focus(); // Grant focus to the input area
     Engine.GetGUIObjectByName("chatDialogPanel").hidden = false;
 }
 
@@ -215 +215 @@
     Engine.GetGUIObjectByName("chatInput").blur(); // Remove focus
     Engine.GetGUIObjectByName("chatDialogPanel").hidden = true;
 }
 
 /**
- * Chat is sent via GUID, not playerID.
+ * If the teamchat hotkey was pressed, set allies or observers as addressees,
+ * otherwise send to everyone.
  */
-function updateTeamCheckbox(check)
+function setTeamChat(teamChat = false)
 {
-    Engine.GetGUIObjectByName("toggleTeamChatLabel").hidden = g_IsObserver;
-    let toggleTeamChat = Engine.GetGUIObjectByName("toggleTeamChat");
-    toggleTeamChat.hidden = g_IsObserver;
-    toggleTeamChat.checked = !g_IsObserver && check;
+    let command = teamChat ? (g_IsObserver ? "/observers" : "/allies") : "";
+    let chatAddressee = Engine.GetGUIObjectByName("chatAddressee");
+    chatAddressee.selected = chatAddressee.list_data.indexOf(command);
 }
-
+/**
+ * Opens chat-window or closes it and sends the userinput.
+ */
 function toggleChatWindow(teamChat)
 {
     if (g_Disconnected)
         return;
 
@@ -237 +239 @@
     let hidden = chatWindow.hidden;
 
     closeOpenDialogs();
 
     if (hidden)
-        chatInput.focus(); // Grant focus to the input area
+    {
+        setTeamChat(teamChat);
+        chatInput.focus();
+    }
     else
     {
         if (chatInput.caption.length)
         {
             submitChatInput();
             return;
         }
-        chatInput.caption = ""; // Clear chat input
+        chatInput.caption = "";
     }
 
-    updateTeamCheckbox(teamChat);
     chatWindow.hidden = !hidden;
 }
 
 function setDiplomacy(data)
 {

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

@@ -83 +83 @@
 
 var g_ChatAddresseeContext = {
     "/team": translate("Team"),
     "/allies": translate("Ally"),
     "/enemies": translate("Enemy"),
+    "/observers": translate("Observer"),
     "/msg": translate("Private")
 };
 
 /**
  * Returns true if the current player is an addressee, given the chat message type and sender.
@@ -98 +99 @@
         g_Players[Engine.GetPlayerID()].team != -1 &&
         g_Players[Engine.GetPlayerID()].team == g_Players[senderID].team,
 
     "/allies": senderID =>
         g_Players[senderID] &&
+        g_Players[Engine.GetPlayerID()] &&
         g_Players[senderID].isMutualAlly[Engine.GetPlayerID()],
 
     "/enemies": senderID =>
         g_Players[senderID] &&
+        g_Players[Engine.GetPlayerID()] &&
         g_Players[senderID].isEnemy[Engine.GetPlayerID()],
 
+    "/observers": senderID =>
+        g_IsObserver,
+
     "/msg": (senderID, addresseeGUID) =>
-        g_Players[Engine.GetPlayerID()] &&
-        g_PlayerAssignments[addresseeGUID] &&
-        g_PlayerAssignments[addresseeGUID].name == g_Players[Engine.GetPlayerID()].name
+        addresseeGUID == Engine.GetPlayerGUID()
 };
 
 /**
  * Chatmessage shown on diplomacy change.
  */
@@ -186 +190 @@
             "guid": findGuidForPlayerID(player),
             "player": player
         });
 
         updateDiplomacy();
+        updateChatAddressees();
     },
     "diplomacy": function(notification, player)
     {
         addChatMessage({
             "type": "diplomacy",
@@ -441 +446 @@
         }
 
         addChatMessage({ "type": "connect", "guid": guid });
     });
 
+    updateChatAddressees();
+
     // Update lobby gamestatus
     if (g_IsController && Engine.HasXmppClient())
     {
         let players = Object.keys(g_PlayerAssignments).map(guid => g_PlayerAssignments[guid].name);
         Engine.SendChangeStateGame(Object.keys(g_PlayerAssignments).length, players.join(", "));
     }
 }
 
+function updateChatAddressees()
+{
+    let addressees = [
+        {
+            "label": translateWithContext("chat addressee", "Everyone"),
+            "cmd": ""
+        }
+    ];
+
+    if (!g_IsObserver)
+    {
+        addressees.push({
+            "label": translateWithContext("chat addressee", "Allies"),
+            "cmd": "/allies"
+        });
+        addressees.push({
+            "label": translateWithContext("chat addressee", "Enemies"),
+            "cmd": "/enemies"
+        });
+    }
+
+    addressees.push({
+        "label": translateWithContext("chat addressee", "Observers"),
+        "cmd": "/observers"
+    });
+
+    // Add playernames for private messages
+    for (let guid of sortGUIDsByPlayerID())
+    {
+        let username = g_PlayerAssignments[guid].name;
+        let playerIndex = g_PlayerAssignments[guid].player;
+
+        if (playerIndex == Engine.GetPlayerID())
+            continue;
+
+        // Don't provide option for PM from observer to player
+        if (g_IsObserver && !isPlayerObserver(playerIndex))
+            continue;
+
+        let colorBox = isPlayerObserver(playerIndex) ? "" : '[color="' + rgbToGuiColor(g_Players[playerIndex].color) + '"]■ [/color]';
+
+        addressees.push({
+            "cmd": "/msg " + username,
+            "label": colorBox + username
+        });
+    }
+
+    let chatAddressee = Engine.GetGUIObjectByName("chatAddressee");
+    chatAddressee.list = addressees.map(adressee => adressee.label);
+    chatAddressee.list_data = addressees.map(adressee => adressee.cmd);
+    chatAddressee.selected = 0;
+}
+
 /**
  * Send text as chat. Don't look for commands.
  *
  * @param {string} text
  */
@@ -471 +531 @@
  * Loads the text from the GUI window, checks if it is a local command
  * or cheat and executes it. Otherwise sends it as chat.
  */
 function submitChatInput()
 {
-    let teamChat = Engine.GetGUIObjectByName("toggleTeamChat").checked;
     let input = Engine.GetGUIObjectByName("chatInput");
     let text = input.caption;
 
     input.blur(); // Remove focus
     input.caption = ""; // Clear chat input
@@ -488 +547 @@
         return;
 
     if (executeCheat(text))
         return;
 
-    // Observers should only be able to chat with everyone.
-    if (g_IsObserver && text.indexOf("/") == 0 && text.indexOf("/me ") != 0)
-        return;
-
-    if (teamChat && text.indexOf("/team ") != 0)
-        text = "/team " + text;
+    let chatAddressee = Engine.GetGUIObjectByName("chatAddressee");
+    if (chatAddressee.selected > 0 && (text.indexOf("/") != 0 || text.indexOf("/me ") == 0))
+        text = chatAddressee.list_data[chatAddressee.selected] + " " + text;
 
     submitChatDirectly(text);
 }
 
 /**
@@ -621 +677 @@
 {
     if (!msg.text)
         return "";
 
     let isMe = msg.text.indexOf("/me ") == 0;
-    if (!isMe && !checkChatAddressee(msg))
+    if (!isMe && !isChatAddressee(msg))
         return "";
 
     isMe = msg.text.indexOf("/me ") == 0;
     if (isMe)
         msg.text = msg.text.substr("/me ".length);
@@ -657 +713 @@
     });
 }
 
 /**
  * Checks if the current user is an addressee of the chatmessage sent by another player.
+ * Sets the context of that message.
+ * Returns true if the message should be displayed.
  *
  * @param {Object} msg
  */
-function checkChatAddressee(msg)
+function isChatAddressee(msg)
 {
     if (msg.text[0] != '/')
         return true;
 
-    if (Engine.GetPlayerID() == -1)
-        return false;
-
+    // Split addressee command and message-text
     let cmd = msg.text.split(/\s/)[0];
     msg.text = msg.text.substr(cmd.length + 1);
 
     if (cmd == "/ally")
         cmd = "/allies";
 
     if (cmd == "/enemy")
         cmd = "/enemies";
 
-    // GUID for players, ID for bots
+    if (cmd == "/observer")
+        cmd = "/observers";
+
+    // GUID for players and observers, ID for bots
     let senderID = (g_PlayerAssignments[msg.guid] || msg).player;
+    let isSender = msg.guid ? msg.guid == Engine.GetPlayerGUID() : senderID == Engine.GetPlayerID();
+
+    // Parse private message
+    let isPM = cmd == "/msg";
     let addresseeGUID;
-    if (cmd == "/msg")
+    let addresseeIndex;
+    if (isPM)
     {
         addresseeGUID = matchUsername(msg.text);
         let addressee = g_PlayerAssignments[addresseeGUID];
-        if (!addressee || addressee.player == -1 || senderID == -1)
+        if (!addressee)
+        {
+            if (isSender)
+                warn("Couldn't match username: " + msg.text);
+            return false;
+        }
+
+        // Prohibit PM if addressee and sender are identical
+        if (isSender && addresseeGUID == Engine.GetPlayerGUID())
             return false;
+
         msg.text = msg.text.substr(addressee.name.length + 1);
+        addresseeIndex = addressee.player;
     }
 
-    let isSender = senderID == Engine.GetPlayerID();
+    // Set context string
     if (!g_ChatAddresseeContext[cmd])
     {
         if (isSender)
             warn("Unknown chat command: " + cmd);
         return false;
     }
     msg.context = g_ChatAddresseeContext[cmd];
 
+    // For observers only permit public- and observer-chat and PM to observers
+    if (isPlayerObserver(senderID) &&
+            (isPM && !isPlayerObserver(addresseeIndex) || !isPM && cmd != "/observers"))
+        return false;
+
     return isSender || g_IsChatAddressee[cmd](senderID, addresseeGUID);
 }
 
 /**
  * Returns the guid of the user with the longest name that is a prefix of the given string.

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

@@ -314 +314 @@
 
     Engine.SetViewedPlayer(g_ViewedPlayer);
 
     updateTopPanel();
 
+    updateChatAddressees();
+
     // Update GUI and clear player-dependent cache
     onSimulationUpdate();
 
     let viewPlayer = Engine.GetGUIObjectByName("viewPlayer");
     viewPlayer.hidden = !changeView;

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

@@ -207 +207 @@
     <object name="chatPanel" size="0 130 100% 100%-240" type="image" ghost="true" z="0" absolute="true">
         <object name="chatText" size="3 1 100%-1 100%-1" type="text" style="chatPanel" ghost="true"/>
     </object>
 
     <!-- Chat window -->
-    <object name="chatDialogPanel" size="50%-180 50%-48 50%+180 50%+36" type="image" hidden="true" sprite="genericPanel">
-        <object name="chatInput" size="16 12 100%-16 36" type="input" style="ModernInput" max_length="80">
+    <object name="chatDialogPanel" size="50%-180 50%-66 50%+180 50%+54" type="image" hidden="true" sprite="genericPanel">
+
+        <!-- Message addressee -->
+        <object size="16 14 50 38" type="text" style="chatPanel">
+            <translatableAttribute id="caption" context="chat input">To:</translatableAttribute>
+        </object>
+        <object size="75 12 100%-16 36" name="chatAddressee" type="dropdown" style="ModernDropDown" tooltip_style="sessionToolTipBold">
+            <translatableAttribute id="tooltip" context="chat input">Select chatmessage addresse</translatableAttribute>
+        </object>
+
+        <!-- Message text -->
+        <object size="16 46 50 70" type="text" style="chatPanel">
+            <translatableAttribute id="caption" context="chat input">Text:</translatableAttribute>
+        </object>
+        <object name="chatInput" size="75 44 100%-16 68" type="input" style="ModernInput" max_length="80">
+            <translatableAttribute id="tooltip" context="chat input">Type the message to send.</translatableAttribute>
             <action on="Press">submitChatInput();</action>
             <action on="Tab">
                 var players = [];
                 for (var player in g_PlayerAssignments)
                     players.push(g_PlayerAssignments[player]);
                 autoCompleteNick("chatInput", players);
             </action>
         </object>
 
+        <!-- Cancel -->
         <object size="16 100%-40 30%+16 100%-12" type="button" style="StoneButton">
             <translatableAttribute id="caption">Cancel</translatableAttribute>
             <action on="Press">closeChat();</action>
         </object>
 
-        <object name="toggleTeamChat" size="30%+22 100%-36 30%+40 100%-6" type="checkbox" style="ModernTickBox"/>
-        <object name="toggleTeamChatLabel" size="30%+40 100%-40 60%+16 100%-12" type="text" style="ModernLeftLabelText">
-            <translatableAttribute id="caption">Team Only</translatableAttribute>
-        </object>
-
+        <!-- Send -->
         <object size="60%+16 100%-40 100%-16 100%-12" type="button" style="StoneButton">
             <translatableAttribute id="caption">Send</translatableAttribute>
             <action on="Press">submitChatInput();</action>
         </object>
     </object>

source/gui/scripting/ScriptFunctions.cpp

@@ -379 +379 @@
     SAFE_DELETE(g_NetServer);
     SAFE_DELETE(g_NetClient);
     SAFE_DELETE(g_Game);
 }
 
+std::string GetPlayerGUID(ScriptInterface::CxPrivate* UNUSED(pCxPrivate))
+{
+    if (!g_NetClient)
+        return "";
+
+    return g_NetClient->GetGUID();
+}
+
 bool KickPlayer(ScriptInterface::CxPrivate* UNUSED(pCxPrivate), const CStrW& playerName, bool ban)
 {
     if (!g_NetServer)
         return false;
 
@@ -1014 +1022 @@
     scriptInterface.RegisterFunction<void, JS::HandleValue, int, &StartGame>("StartGame");
     scriptInterface.RegisterFunction<void, &Script_EndGame>("EndGame");
     scriptInterface.RegisterFunction<void, std::wstring, &StartNetworkHost>("StartNetworkHost");
     scriptInterface.RegisterFunction<void, std::wstring, std::string, &StartNetworkJoin>("StartNetworkJoin");
     scriptInterface.RegisterFunction<void, &DisconnectNetworkGame>("DisconnectNetworkGame");
+    scriptInterface.RegisterFunction<std::string, &GetPlayerGUID>("GetPlayerGUID");
     scriptInterface.RegisterFunction<bool, CStrW, bool, &KickPlayer>("KickPlayer");
     scriptInterface.RegisterFunction<JS::Value, &PollNetworkClient>("PollNetworkClient");
     scriptInterface.RegisterFunction<void, JS::HandleValue, &SetNetworkGameAttributes>("SetNetworkGameAttributes");
     scriptInterface.RegisterFunction<void, int, std::string, &AssignNetworkPlayer>("AssignNetworkPlayer");
     scriptInterface.RegisterFunction<void, std::string, int, &SetNetworkPlayerStatus>("SetNetworkPlayerStatus");

source/network/NetClient.h

@@ -87 +87 @@
      * This must not be called after the connection setup.
      */
     void SetUserName(const CStrW& username);
 
     /**
+     * Returns the GUID of the local client.
+     * Used for distinguishing observers.
+     */
+    CStr GetGUID() const { return m_GUID; }
+
+    /**
      * Set up a connection to the remote networked server.
      * @param server IP address or host name to connect to
      * @return true on success, false on connection failure
      */
     bool SetupConnection(const CStr& server);