Pending ghost messages (#736)

This feature allows text to be posted to the IC log as a "ghost" before it has been displayed in-game. When desync chat is enabled, it's common for the player to wait a little while before their messages are displayed.

Ghosts only apply to the active player's messages, not all queued messages. They are also pinned at the end of the IC log until they are displayed.

Co-authored-by: oldmud0 <oldmud0@users.noreply.github.com>
Co-authored-by: stonedDiscord <Tukz@gmx.de>

Author: 3 people

include/aoapplication.h

@@ -107,8 +107,8 @@ class AOApplication : public QApplication {
 
   ///////////////loading info///////////////////
 
-  // player number, it's hardly used but might be needed for some old servers
-  int s_pv = 0;
+  // client ID. Not useful, to be removed eventually
+  int client_id = 0;
 
   QString server_software = "";
 

include/courtroom.h

@@ -245,10 +245,11 @@ class Courtroom : public QMainWindow {
   enum LogMode {
     IO_ONLY,
     DISPLAY_ONLY,
-    DISPLAY_AND_IO
+    DISPLAY_AND_IO,
+    QUEUED,
   };
   // Log the message contents and information such as evidence presenting etc. into the log file, the IC log, or both.
-  void log_chatmessage(QString f_message, int f_char_id, QString f_showname = "", QString f_char = "", QString f_objection_mod = "", int f_evi_id = 0, int f_color = 0, LogMode f_log_mode=IO_ONLY);
+  void log_chatmessage(QString f_message, int f_char_id, QString f_showname = "", QString f_char = "", QString f_objection_mod = "", int f_evi_id = 0, int f_color = 0, LogMode f_log_mode=IO_ONLY, bool sender = false);
 
   // Log the message contents and information such as evidence presenting etc. into the IC logs
   void handle_callwords();
@@ -292,7 +293,12 @@ class Courtroom : public QMainWindow {
   // selected
   // or the user isn't already scrolled to the top
   void append_ic_text(QString p_text, QString p_name = "", QString action = "",
-                      int color = 0, bool selfname = false, QDateTime timestamp = QDateTime::currentDateTime());
+                      int color = 0, bool selfname = false, QDateTime timestamp = QDateTime::currentDateTime(),
+                      bool ghost = false);
+
+  // clear sent messages that appear on the IC log but haven't been delivered
+  // yet to other players
+  void pop_ic_ghost();
 
   // prints who played the song to IC chat and plays said song(if found on local
   // filesystem) takes in a list where the first element is the song name and
@@ -485,6 +491,9 @@ class Courtroom : public QMainWindow {
   // amount by which we multiply the delay when we parse punctuation chars
   const int punctuation_modifier = 3;
 
+  // amount of ghost blocks
+  int ghost_blocks = 0;
+
   // Minumum and maximum number of parameters in the MS packet
   static const int MS_MINIMUM = 15;
   static const int MS_MAXIMUM = 30;

include/datatypes.h

@@ -110,7 +110,7 @@ enum CHAT_MESSAGE {
   FRAME_REALIZATION,
   FRAME_SFX,
   ADDITIVE,
-  EFFECTS
+  EFFECTS,
 };
 
 enum EMOTE_MOD {

src/charselect.cpp

@@ -180,7 +180,8 @@ void Courtroom::char_clicked(int n_char)
     ao_app->send_server_packet(
         new AOPacket("PW", {ui_char_password->text()}));
     ao_app->send_server_packet(
-        new AOPacket("CC", {QString::number(ao_app->s_pv), QString::number(n_char), get_hdid()}));
+        new AOPacket("CC", {QString::number(ao_app->client_id),
+                            QString::number(n_char), get_hdid()}));
   }
   if (n_char == m_cid || n_char == -1) {
     update_character(n_char);