Private chat mode #1

AKMDM · 2020-12-28T05:05:00Z

This adds a new chat mode to Zandronum, allowing the player (or the server) to send chat messages privately to another player. Nobody else can see these messages and they won't be logged into the server's chat log, unless the server is sending or receiving a private message.

… other. The sender can either pass the player's name with "sayto" or a player's number with "sayto_idx". Alternatively, players can send private messages to the server by passing "server" as a name.

… message level.

src/c_console.cpp

src/cl_commands.cpp

src/doomtype.h

src/sv_commands.cpp

AKMDM · 2021-01-03T21:14:19Z

I'm finishing up on these adjustments, if that's everything. I should have a new commit ready very soon.

EDIT: Just committed the adjustments, I hope these are okay. One more thing, I added extra code to allow the client to cycle backwards through the player list if they're pressing TAB + SHIFT. Otherwise, it cycles forward with just TAB.

TorrSamaho · 2021-01-03T21:21:17Z

I'm finishing up on these adjustments, if that's everything. I should have a new commit ready very soon.

Yes, I'm done checking and commented on everything I noticed.

src/chat.cpp

TorrSamaho · 2021-01-10T21:43:21Z

Sorry for overlooking the changes in chat.cpp last time. I didn't realize that github automatically hides changed files with too many changes...

AKMDM · 2021-01-10T21:46:44Z

No worries! I'm glad we took a good look in this file to see where things need to be improved for next time. I'll probably have these changes ready for next week, if that's okay. Thanks for the feedback!

TorrSamaho · 2021-01-10T22:15:50Z

Sure, there's no rush. Have a nice week!

AKMDM · 2021-01-10T22:26:22Z

Thank you, you as well. :)

AKMDM · 2021-01-16T15:07:31Z

I submitted a couple of new commits.

I fixed the private chat mode so that it now only works in online games and bots cannot be selected. Also, if the client tries to start typing a private message when there's no other clients, the server is selected instead.
chat_CanSendPrivateMessage( ULONG ulPlayer ) is replaced with chat_IsPlayerValidReceiver( ULONG ulPlayer ) and chat_FindValidReciever ( void ). The former checks if a player is eligible to become a receiver of a private message, and the latter checks for a valid player that can be a receiver. Otherwise, the server is chosen.
The possibility of any infinite loops occurring in the code should be resolved now.
The server can now be selected by passing -1 to sayto_idx.

I also added more commits, some of which aren't necessarily related to the private chat:

Players cannot name themselves as "server" in online games anymore. This should avert potential impersonation of the server, and the possibility that someone tries using sayto "server" when there's a player with the same name.
The chat cursor now blinks while the playing is creating a message. If they're typing or passing any input, the cursor remains visible. The additions are somewhat complicated, but I had to make sure displayString still looks convincing on the screen while the cursor is supposed to be invisible by taking account the width of the '_' character.
I touched up and re-added my commit which adds the new EVENT type: GAMEEVENT_CHAT and the ACS function GetChatMessage( int player, int index ). The biggest difference is that up to three chat messages from the player (or server) are stored in memory, so modders can also pass an index between 0 and 2 to get that corresponding chat message, with ~~0 being the oldest and 2 being newest~~. This is in case we receive more than one chat message from the client in a single tic, in which the last chat message replaces the older one.

EDIT: An index of 0 returns the newest chat message, and 2 returns the oldest chat message.

src/chat.cpp

TorrSamaho · 2021-01-17T21:16:11Z

Thanks for the new patches! However, to keep things more manageable, can you do me a favor and remove the separate commits cd80940, d2fc101, f976178 from this merge request? Let's first get the private chat system merged, before extending it or adding other chat features.

AKMDM · 2021-01-17T21:18:23Z

Sure, will do.

~~EDIT: Is it okay if I open up a new pull request? I'm having trouble removing those few commits on my end and ended up making some mistakes~~.

AKMDM · 2021-01-17T22:02:51Z

I managed to fix it, Torr.

TorrSamaho · 2021-01-24T20:06:37Z

src/chat.cpp

+// [AK] Allows players (or the server) to send private messages to other players.
+//
+void chat_PrivateMessage( FCommandLine &argv, const ULONG ulReceiver, const bool bServerSelected )
+{


Why do we need a separate argument bServerSelected to encode the server as target instead of just using ulReceiver == MAXPLAYERS?
BTW: Sorry that this comment only shows up now. I posted it last week but unfortunately using "Start a review" instead of "Add single comment". I just now realized that you couldn't see it.

Thank you for asking. I added bServerSelected to ignore all the extra checks required to validate another player being the receiver, if the client explicitly chooses to the server. If the client wants indicates that they want to send a private message to the server using sayto server or sayto_idx -1, then it's not necessary to check if the receiver is invalid, a bot, ourselves, etc.

Additionally, if bServerSelected is true, then the function chat_FindValidReceiver won't be entered at all. If we did enter that function and there was only one client connected, then the message "There's no other clients to send private messages to. The server will be selected instead." would always appear in the console, even if the client intentionally chose to send a private message to the server.

You could also bypass all those checks by using ulReceiver == MAXPLAYERS instead of bServerSelected. For instance, you could add const bool bServerSelected = (ulReceiver == MAXPLAYERS); in the first line of the implementation of chat_PrivateMessage and keep the rest of chat_PrivateMessage untouched (except for removing the argument bServerSelected). Perhaps there is a reason why you don't want to encode the information bServerSelected in the argument ulReceiver, but right now I don't see it.

Fair enough, I can change that quickly and resubmit it if you're still around.

Yes, I'm still around.

Sorry, but I gotta go now. I should be able to add this tomorrow though.

TorrSamaho · 2021-01-24T20:07:36Z

I managed to fix it, Torr.

Thanks! Looking all good now, except for the one comment I didn't properly post last week. Sorry for that.

TorrSamaho · 2021-01-24T22:13:16Z

src/chat.cpp

 {
 	ULONG		ulIdx;
 	FString		ChatString;
+	const bool	bServerSelected = ulReceiver;


Shouldn't this be const bool bServerSelected = (ulReceiver == MAXPLAYERS);?

EDIT: Now I'm really gone for today ;).

Yes, I forgot to fix that (really stupid mistake). :(

EDIT: Uploaded the now fixed commit, so sorry about that!

TorrSamaho · 2021-01-25T07:52:05Z

I compressed, rebased and added this patch.

AKMDM added 2 commits December 11, 2020 19:53

Added a new chat mode that lets players send private messages to each…

e27c014

… other. The sender can either pass the player's name with "sayto" or a player's number with "sayto_idx". Alternatively, players can send private messages to the server by passing "server" as a name.

The chat sound shouldn't play for messages that are below the minimum…

6e5655a

… message level.

TorrSamaho reviewed Jan 3, 2021

View reviewed changes

src/c_console.cpp Outdated Show resolved Hide resolved

TorrSamaho reviewed Jan 3, 2021

View reviewed changes

src/cl_commands.cpp Outdated Show resolved Hide resolved

TorrSamaho reviewed Jan 3, 2021

View reviewed changes

src/doomtype.h Show resolved Hide resolved

TorrSamaho reviewed Jan 3, 2021

View reviewed changes

src/sv_commands.cpp Show resolved Hide resolved

Made some adjustments to the private chat mode.

d2bab9c