Add set/getChatboxCharacterLimit and increase max chat message length to 255 (#2215)

* Initial commit

* Add max input char limit and max input line values as const members to CChat

* Add GetChatboxMaxCharacterLimit to CCore (for CChat)

* Update CCoreInterface virtual method ordering

* Increase MAX_CHAT_LENGTH and make MAX_CHATECHO_LENGTH "dynamic"

* Fix Packet_ChatEcho to use MAX_CHATECHO_LENGTH instead of MAX_OUTPUTCHATBOX_LENGTH

Why was it using MAX_OUTPUTCHATBOX_LENGTH all this time? lmao

* Make setChatboxCharacterLimit reset on passing -1, instead of none

Otherwise you could pass anything other than a number to setChatBoxCharacterLimit, and you wouldn't know anything was wrong, yet the chatbox input limit would reset

* Remove extra func definition added by accident

* Apply suggestions from code review

* Apply constexpr suggestion from botder's code review

Suggestion at #2215 (comment)

Co-authored-by: patrikjuvonen <22572159+patrikjuvonen@users.noreply.github.com>
Co-authored-by: Marek Kulik <me@botder.com>

Author: 3 people

Client/core/CChat.cpp

@@ -63,6 +63,7 @@ CChat::CChat(CGUI* pManager, const CVector2D& vecPosition)
     m_ePositionVertical = Chat::Position::Vertical::TOP;
     m_eTextAlign = Chat::Text::Align::LEFT;
     m_iSelectedInputHistoryEntry = -1;
+    m_iCharacterLimit = m_iDefaultCharacterLimit;
 
     // Background area
     m_pBackground = m_pManager->CreateStaticImage();
@@ -714,7 +715,7 @@ bool CChat::CharacterKeyHandler(CGUIKeyEventArgs KeyboardArgs)
                         {
                             // Check size if it's ok, then output
                             SString strOutput = strCurrentInput.replace(iFound, std::string::npos, strPlayerName);
-                            if (MbUTF8ToUTF16(strOutput).size() < CHAT_MAX_CHAT_LENGTH)
+                            if (MbUTF8ToUTF16(strOutput).size() < m_iCharacterLimit)
                             {
                                 bSuccess = true;
                                 m_strLastPlayerNamePart = strPlayerNamePart;
@@ -745,7 +746,7 @@ bool CChat::CharacterKeyHandler(CGUIKeyEventArgs KeyboardArgs)
                 m_strLastPlayerName.clear();
 
             // If we haven't exceeded the maximum number of characters per chat message, append the char to the message and update the input control
-            if (MbUTF8ToUTF16(m_strInputText).size() < CHAT_MAX_CHAT_LENGTH)
+            if (MbUTF8ToUTF16(m_strInputText).size() < m_iCharacterLimit)
             {
                 if (KeyboardArgs.codepoint >= 32)
                 {
@@ -865,7 +866,7 @@ void CChat::UpdateGUI()
     m_pBackground->SetSize(m_vecBackgroundSize);
 
     // Make sure there is enough room for all the lines
-    uint uiMaxNumLines = g_pCore->GetGraphics()->GetViewportHeight() / std::max(1.f, CChat::GetFontHeight(m_vecScale.fY)) - 3;
+    uint uiMaxNumLines = g_pCore->GetGraphics()->GetViewportHeight() / std::max(1.f, CChat::GetFontHeight(m_vecScale.fY)) - m_iMaxInputLines;
     if (m_uiNumLines > uiMaxNumLines)
         SetNumLines(uiMaxNumLines);
 
@@ -967,7 +968,7 @@ void CChat::SetInputText(const char* szText)
 
     CChatLine* pLine = NULL;
 
-    while (szRemainingText && m_InputLine.m_ExtraLines.size() < 3)
+    while (szRemainingText && m_InputLine.m_ExtraLines.size() < m_iMaxInputLines)
     {
         m_InputLine.m_ExtraLines.resize(m_InputLine.m_ExtraLines.size() + 1);
         CChatLine& line = *(m_InputLine.m_ExtraLines.end() - 1);
@@ -1077,6 +1078,11 @@ void CChat::DrawTextString(const char* szText, CRect2D DrawArea, float fZ, CRect
     }
 }
 
+void CChat::SetCharacterLimit(int charLimit)
+{
+    m_iCharacterLimit = charLimit;
+}
+
 CChatLine::CChatLine()
 {
     m_bActive = false;

Client/core/CChat.h

@@ -19,7 +19,6 @@ class CChatLineSection;
 #define CHAT_WIDTH 320                                   // Chatbox default width
 #define CHAT_TEXT_COLOR CColor(235, 221, 178)            // Chatbox default text color
 #define CHAT_MAX_LINES 100                               // Chatbox maximum chat lines
-#define CHAT_MAX_CHAT_LENGTH 96                          // Chatbox maximum chat message length
 #define CHAT_BUFFER 1024                                 // Chatbox buffer size
 #define CHAT_INPUT_HISTORY_LENGTH 128                    // Chatbox input history length
 
@@ -203,6 +202,11 @@ class CChat
     void SetChatFont(eChatFont Font);
     void OnModLoad();
 
+    void          SetCharacterLimit(int charLimit);
+    int           GetCharacterLimit() const { return m_iCharacterLimit; }
+    constexpr int GetDefaultCharacterLimit() const { return m_iDefaultCharacterLimit; }
+    constexpr int GetMaxCharacterLimit() const { return m_iMaxCharacterLimit; }
+
 private:
     void LoadCVars();
 
@@ -292,4 +296,9 @@ class CChat
     CTickCount m_lastRenderTargetCreationFail;
 
     bool m_bNickCompletion;
+
+    int                         m_iCharacterLimit;
+    static inline constexpr int m_iDefaultCharacterLimit = 96;
+    static inline constexpr int m_iMaxCharacterLimit = 255;
+    static inline constexpr int m_iMaxInputLines = 5;
 };

Client/core/CCore.cpp

@@ -504,6 +504,47 @@ bool CCore::IsChatInputEnabled()
     return false;
 }
 
+bool CCore::SetChatboxCharacterLimit(int charLimit)
+{
+    CChat* pChat = m_pLocalGUI->GetChat();
+
+    if (!pChat)
+        return false;
+
+    pChat->SetCharacterLimit(charLimit);
+    return true;
+}
+
+void CCore::ResetChatboxCharacterLimit()
+{
+    CChat* pChat = m_pLocalGUI->GetChat();
+
+    if (!pChat)
+        return;
+
+    pChat->SetCharacterLimit(pChat->GetDefaultCharacterLimit());
+}
+
+int CCore::GetChatboxCharacterLimit()
+{
+    CChat* pChat = m_pLocalGUI->GetChat();
+
+    if (!pChat)
+        return 0;
+
+    return pChat->GetCharacterLimit();
+}
+
+int CCore::GetChatboxMaxCharacterLimit()
+{
+    CChat* pChat = m_pLocalGUI->GetChat();
+
+    if (!pChat)
+        return 0;
+
+    return pChat->GetMaxCharacterLimit();
+}
+
 bool CCore::IsSettingsVisible()
 {
     if (m_pLocalGUI)
@@ -1280,6 +1321,9 @@ void CCore::OnModUnload()
 
     // Destroy tray icon
     m_pTrayIcon->DestroyTrayIcon();
+
+    // Reset chatbox character limit
+    ResetChatboxCharacterLimit();
 }
 
 void CCore::RegisterCommands()

Client/core/CCore.h

@@ -125,6 +125,10 @@ class CCore : public CCoreInterface, public CSingleton<CCore>
     bool IsChatInputEnabled();
     bool ClearChat();
     void OnGameTimerUpdate();
+    bool SetChatboxCharacterLimit(int charLimit);
+    void ResetChatboxCharacterLimit();
+    int  GetChatboxCharacterLimit();
+    int  GetChatboxMaxCharacterLimit();
 
     // Screenshots
     void TakeScreenShot();

Client/mods/deathmatch/logic/CPacketHandler.cpp

@@ -1374,7 +1374,7 @@ void CPacketHandler::Packet_ChatEcho(NetBitStreamInterface& bitStream)
             szMessage[iNumberOfBytesUsed] = 0;
             // actual limits enforced on the remote client, this is the maximum a string can be to be printed.
             if (MbUTF8ToUTF16(szMessage).size() <=
-                MAX_OUTPUTCHATBOX_LENGTH + 6)            // Extra 6 characters to fix #7125 (Teamsay + long name + long message = too long message)
+                MAX_CHATECHO_LENGTH + 6) // Extra 6 characters to fix #7125 (Teamsay + long name + long message = too long message)
             {
                 // Strip it for bad characters
                 StripControlCodes(szMessage, ' ');

Client/mods/deathmatch/logic/Config.h

@@ -52,17 +52,17 @@ class CVaPassNext
 #define va_pass(valist) CVaPassNext(valist).svapassnext
 /*** va_pass() (passing of ... variable length arguments ***/
 
-// Min and max number of characters in chat messages
+// Min and max number of characters in chat messages (the message itself, not including player nick)
 #define MIN_CHAT_LENGTH 1
-#define MAX_CHAT_LENGTH 96
+#define MAX_CHAT_LENGTH 255
 
 // Min and max number of characters in a console command
 #define MIN_COMMAND_LENGTH 1
 #define MAX_COMMAND_LENGTH 255
 
 // Min and max number of characters in chat echos
 #define MIN_CHATECHO_LENGTH 1
-#define MAX_CHATECHO_LENGTH 128
+#define MAX_CHATECHO_LENGTH (MAX_CHAT_LENGTH + MAX_PLAYER_NICK_LENGTH + 2) // +2 is for ": " between player nick and the message
 
 // Min and max number of characters in outputChatBox from the server
 #define MIN_OUTPUTCHATBOX_LENGTH 1

Client/mods/deathmatch/logic/luadefs/CLuaGUIDefs.cpp

@@ -10,6 +10,7 @@
  *****************************************************************************/
 
 #include "StdInc.h"
+#include <lua/CLuaFunctionParser.h>
 
 static const SFixedArray<const char*, MAX_CHATBOX_LAYOUT_CVARS> g_chatboxLayoutCVars = {{"chat_font",
                                                                                          "chat_lines",
@@ -49,6 +50,9 @@ void CLuaGUIDefs::LoadFunctions()
         {"isMTAWindowActive", GUIIsMTAWindowActive},
         {"isTransferBoxActive", GUIIsTransferBoxActive},
 
+        {"setChatboxCharacterLimit", ArgumentParser<GUISetChatboxCharacterLimit>},
+        {"getChatboxCharacterLimit", ArgumentParser<GUIGetChatboxCharacterLimit>},
+
         {"guiCreateWindow", GUICreateWindow},
         {"guiCreateLabel", GUICreateLabel},
         {"guiCreateButton", GUICreateButton},
@@ -239,6 +243,8 @@ void CLuaGUIDefs::AddGuiElementClass(lua_State* luaVM)
     lua_classfunction(luaVM, "isInputEnabled", "guiGetInputEnabled");
     lua_classfunction(luaVM, "getInputMode", "guiGetInputMode");
     lua_classfunction(luaVM, "getCursorType", "guiGetCursorType");
+    lua_classfunction(luaVM, "setChatboxCharacterLimit", "setChatboxCharacterLimit");
+    lua_classfunction(luaVM, "getChatboxCharacterLimit", "getChatboxCharacterLimit");
 
     lua_classfunction(luaVM, "getScreenSize", "guiGetScreenSize");
     lua_classfunction(luaVM, "getProperties", "guiGetProperties");
@@ -280,6 +286,7 @@ void CLuaGUIDefs::AddGuiElementClass(lua_State* luaVM)
     lua_classvariable(luaVM, "text", "guiSetText", "guiGetText");
     lua_classvariable(luaVM, "size", "guiSetSize", "guiGetSize");
     lua_classvariable(luaVM, "position", "guiSetPosition", "guiGetPosition");
+    lua_classvariable(luaVM, "chatboxCharacterLimit", "setChatboxCharacterLimit", "getChatboxCharacterLimit");
 
     lua_registerclass(luaVM, "GuiElement", "Element");
 }
@@ -4058,3 +4065,24 @@ int CLuaGUIDefs::GUIGetCursorType(lua_State* luaVM)
     lua_pushstring(luaVM, EnumToString(eType));
     return 1;
 }
+
+bool CLuaGUIDefs::GUISetChatboxCharacterLimit(int charLimit)
+{
+    if (charLimit == -1)
+    {
+        g_pCore->ResetChatboxCharacterLimit();
+        return true;
+    }
+
+    int maxCharLimit = g_pCore->GetChatboxMaxCharacterLimit();
+
+    if (charLimit < 0 || charLimit > maxCharLimit)
+        throw std::invalid_argument(SString("Character limit must be %s than, or equal to %i (got: %i)", (charLimit < 0) ? "greater" : "less", (charLimit < 0) ? 0 : maxCharLimit, charLimit));
+
+    return g_pCore->SetChatboxCharacterLimit(charLimit);
+}
+
+int CLuaGUIDefs::GUIGetChatboxCharacterLimit()
+{
+    return g_pCore->GetChatboxCharacterLimit();
+}

Client/mods/deathmatch/logic/luadefs/CLuaGUIDefs.h

@@ -159,6 +159,9 @@ class CLuaGUIDefs : public CLuaDefs
     LUA_DECLARE(GUIComboBoxIsOpen);
     LUA_DECLARE(GUIGetCursorType);
 
+    static bool GUISetChatboxCharacterLimit(int charLimit);
+    static int  GUIGetChatboxCharacterLimit();
+
 private:
     static void AddGuiElementClass(lua_State* luaVM);
     static void AddGuiFontClass(lua_State* luaVM);

Client/sdk/core/CCoreInterface.h

@@ -175,6 +175,10 @@ class CCoreInterface
     virtual void        OnGameTimerUpdate() = 0;
 
     virtual bool IsChatInputBlocked() = 0;
+    virtual bool SetChatboxCharacterLimit(int charLimit) = 0;
+    virtual void ResetChatboxCharacterLimit() = 0;
+    virtual int  GetChatboxCharacterLimit() = 0;
+    virtual int  GetChatboxMaxCharacterLimit() = 0;
 };
 
 class CClientTime

Server/mods/deathmatch/Config.h

@@ -29,17 +29,17 @@
 // Min number of characters in passwords
 #define MIN_PASSWORD_LENGTH 1
 
-// Min and max number of characters in chat messages
+// Min and max number of characters in chat messages (the message itself, not including player nick)
 #define MIN_CHAT_LENGTH 1
-#define MAX_CHAT_LENGTH 96
+#define MAX_CHAT_LENGTH 255
 
 // Min and max number of characters in a console command
 #define MIN_COMMAND_LENGTH 1
 #define MAX_COMMAND_LENGTH 255
 
 // Min and max number of characters in chat echos
 #define MIN_CHATECHO_LENGTH 1
-#define MAX_CHATECHO_LENGTH 128
+#define MAX_CHATECHO_LENGTH (MAX_CHAT_LENGTH + MAX_PLAYER_NICK_LENGTH + 2) // +2 is for ": " between player nick and the message
 
 // Min and max number of characters in outputChatBox from the server
 #define MIN_OUTPUTCHATBOX_LENGTH 1