Add player element for onClientChatMessage (#138)

Author: Marek Kulik

Client/mods/deathmatch/logic/CPacketHandler.cpp

@@ -1268,21 +1268,36 @@ void CPacketHandler::Packet_ChatEcho ( NetBitStreamInterface& bitStream )
     // unsigned char    (1)     - green
     // unsigned char    (1)     - blue
     // unsigned char    (1)     - color-coded
+    // ElementID        (2)     - client (if typed by a player)
     // unsigned char    (x)     - message
 
     // Read out the color
     unsigned char ucRed;
     unsigned char ucGreen;
     unsigned char ucBlue;
     bool ucColorCoded;
+
+    CClientEntity * pClient = nullptr;
+
     if ( bitStream.Read ( ucRed ) &&
          bitStream.Read ( ucGreen ) &&
          bitStream.Read ( ucBlue ) &&
          bitStream.ReadBit ( ucColorCoded ) )
     {
-        // Valid length?
+        // Read the client's ID
+        int iNumberOfBytesUsed;
+
+        if ( bitStream.Version() >= 0x06B ) {
+            ElementID ClientID;
+            bitStream.Read( ClientID );
+            pClient = ( ClientID != INVALID_ELEMENT_ID ) ? CElementIDs::GetElement( ClientID ) : nullptr;
+            iNumberOfBytesUsed = bitStream.GetNumberOfBytesUsed() - 6;
+        }
+        else {
+            iNumberOfBytesUsed = bitStream.GetNumberOfBytesUsed() - 4;
+        }
 
-        int iNumberOfBytesUsed = bitStream.GetNumberOfBytesUsed () - 4;
+        // Valid length?
         if ( iNumberOfBytesUsed >= MIN_CHATECHO_LENGTH  )
         {
             // Read the message into a buffer
@@ -1295,13 +1310,17 @@ void CPacketHandler::Packet_ChatEcho ( NetBitStreamInterface& bitStream )
                 // Strip it for bad characters
                 StripControlCodes ( szMessage, ' ' );
 
+                // Determine the event source entity
+                CClientEntity * pRootEntity = g_pClientGame->GetRootEntity();
+                CClientEntity * pEntity = pClient ? pClient : pRootEntity;
+
                 // Call an event
                 CLuaArguments Arguments;
                 Arguments.PushString ( szMessage );
                 Arguments.PushNumber ( ucRed );
                 Arguments.PushNumber ( ucGreen );
                 Arguments.PushNumber ( ucBlue );
-                bool bCancelled = !g_pClientGame->GetRootEntity()->CallEvent ( "onClientChatMessage", Arguments, false );
+                bool bCancelled = !pEntity->CallEvent ( "onClientChatMessage", Arguments, pEntity != pRootEntity );
                 if ( !bCancelled )
                 {
                     // Echo it

Client/version.h

@@ -77,7 +77,7 @@
 #define _NETCODE_VERSION_BRANCH_ID      0x4         // Use 0x1 - 0xF to indicate an incompatible branch is being used (0x0 is reserved, 0x4 is trunk)
 #define _CLIENT_NET_MODULE_VERSION      0x0A7       // (0x000 - 0xfff) Lvl9 wizards only
 #define _NETCODE_VERSION                0x1DA       // (0x000 - 0xfff) Increment when net messages change (pre-release)
-#define MTA_DM_BITSTREAM_VERSION        0x06A       // (0x000 - 0xfff) Increment when net messages change (post-release). (Changing will also require additional backward compatibility code).
+#define MTA_DM_BITSTREAM_VERSION        0x06B       // (0x000 - 0xfff) Increment when net messages change (post-release). (Changing will also require additional backward compatibility code).
 
 // To avoid user confusion, make sure the ASE version matches only if communication is possible
 #if defined(MTA_DM_CONNECT_TO_PUBLIC)

Server/mods/deathmatch/logic/CConsoleCommands.cpp

@@ -361,13 +361,15 @@ bool CConsoleCommands::Say ( CConsole* pConsole, const char* szInArguments, CCli
                                 }
 
                                 // Broadcast the message to all clients
-                                pConsole->GetPlayerManager ()->BroadcastOnlyJoined ( CChatEchoPacket ( strEcho, ucR, ucG, ucB, true ) );
+                                auto ChatEchoPacket = CChatEchoPacket ( strEcho, ucR, ucG, ucB, true );
+                                ChatEchoPacket.SetSourceElement( pPlayer );
+                                pConsole->GetPlayerManager ()->BroadcastOnlyJoined ( ChatEchoPacket );
 
                                 // Call onChatMessage if players chat message was delivered
                                 CLuaArguments Arguments2;
                                 Arguments2.PushString ( szArguments );
                                 Arguments2.PushElement ( pPlayer );
-                                static_cast < CPlayer* > ( pClient )->CallEvent ( "onChatMessage", Arguments2 );
+                                pPlayer->CallEvent ( "onChatMessage", Arguments2 );
                             }
 
                             break;

Server/mods/deathmatch/logic/packets/CChatEchoPacket.cpp

@@ -20,6 +20,11 @@ bool CChatEchoPacket::Write ( NetBitStreamInterface& BitStream ) const
     BitStream.Write ( m_ucBlue );
     BitStream.WriteBit ( m_bColorCoded );
 
+    // Write the client's ID
+    if ( BitStream.Version() >= 0x06B ) {
+        BitStream.Write ( GetSourceElement() ? GetSourceElement()->GetID() : INVALID_ELEMENT_ID );
+    }
+
     // Too short?
     size_t sizeMessage = m_strMessage.length();
     if ( sizeMessage >= MIN_CHATECHO_LENGTH )

Server/version.h

@@ -81,7 +81,7 @@
 #define _NETCODE_VERSION_BRANCH_ID      0x4         // Use 0x1 - 0xF to indicate an incompatible branch is being used (0x0 is reserved, 0x4 is trunk)
 #define _SERVER_NET_MODULE_VERSION      0x0A7       // (0x000 - 0xfff) Lvl9 wizards only
 #define _NETCODE_VERSION                0x1DA       // (0x000 - 0xfff) Increment when net messages change (pre-release)
-#define MTA_DM_BITSTREAM_VERSION        0x06A       // (0x000 - 0xfff) Increment when net messages change (post-release). (Changing will also require additional backward compatibility code).
+#define MTA_DM_BITSTREAM_VERSION        0x06B       // (0x000 - 0xfff) Increment when net messages change (post-release). (Changing will also require additional backward compatibility code).
 
 // To avoid user confusion, make sure the ASE version matches only if communication is possible
 #if defined(MTA_DM_CONNECT_FROM_PUBLIC)