2 * $Logfile: /Freespace2/code/MissionUI/Chatbox.cpp $
7 * C module to handle all code for multiplayer chat windows
10 * Revision 1.1 2002/05/03 03:28:10 root
14 * 12 8/05/99 4:05p Jefff
15 * fixed pause chatbox display coords
17 * 11 7/29/99 10:47p Dave
18 * Standardized D3D fogging using vertex fog. Shook out Savage 4 bugs.
20 * 10 5/22/99 5:35p Dave
21 * Debrief and chatbox screens. Fixed small hi-res HUD bug.
23 * 9 2/24/99 2:25p Dave
24 * Fixed up chatbox bugs. Made squad war reporting better. Fixed a respawn
25 * bug for dogfight more.
27 * 8 2/23/99 8:11p Dave
28 * Tidied up dogfight mode. Fixed TvT ship type problems for alpha wing.
29 * Small pass over todolist items.
31 * 7 2/11/99 3:08p Dave
32 * PXO refresh button. Very preliminary squad war support.
34 * 6 2/01/99 5:55p Dave
35 * Removed the idea of explicit bitmaps for buttons. Fixed text
36 * highlighting for disabled gadgets.
38 * 5 1/29/99 2:08a Dave
39 * Fixed beam weapon collisions with players. Reduced size of scoring
40 * struct for multiplayer. Disabled PXO.
42 * 4 1/28/99 7:09p Neilk
43 * Modified chatbox to use new interface graphics (only 640)
45 * 3 10/13/98 9:28a Dave
46 * Started neatening up freespace.h. Many variables renamed and
47 * reorganized. Added AlphaColors.[h,cpp]
49 * 2 10/07/98 10:53a Dave
52 * 1 10/07/98 10:49a Dave
54 * 57 9/17/98 3:08p Dave
55 * PXO to non-pxo game warning popup. Player icon stuff in create and join
56 * game screens. Upped server count refresh time in PXO to 35 secs (from
59 * 56 9/11/98 5:08p Dave
60 * More tweaks to kick notification system.
62 * 55 9/11/98 4:14p Dave
63 * Fixed file checksumming of < file_size. Put in more verbose kicking and
64 * PXO stats store reporting.
66 * 54 6/09/98 5:15p Lawrance
67 * French/German localization
69 * 53 6/09/98 10:31a Hoffoss
70 * Created index numbers for all xstr() references. Any new xstr() stuff
71 * added from here on out should be added to the end if the list. The
72 * current list count can be found in FreeSpace.cpp (search for
75 * 52 6/01/98 11:43a John
76 * JAS & MK: Classified all strings for localization.
78 * 51 5/22/98 9:35p Dave
79 * Put in channel based support for PXO. Put in "shutdown" button for
80 * standalone. UI tweaks for TvT
82 * 50 5/17/98 6:32p Dave
83 * Make sure clients/servers aren't kicked out of the debriefing when team
84 * captains leave a game. Fixed chatbox off-by-one error. Fixed image
85 * xfer/pilot info popup stuff.
87 * 49 5/17/98 1:43a Dave
88 * Eradicated chatbox problems. Remove speed match for observers. Put in
89 * help screens for PXO. Fix messaging and end mission privelges. Fixed
90 * team select screen bugs. Misc UI fixes.
92 * 48 5/15/98 9:52p Dave
93 * Added new stats for freespace. Put in artwork for viewing stats on PXO.
95 * 47 5/15/98 5:15p Dave
96 * Fix a standalone resetting bug.Tweaked PXO interface. Display captaincy
97 * status for team vs. team. Put in asserts to check for invalid team vs.
100 * 46 5/08/98 7:08p Dave
101 * Lots of UI tweaking.
103 * 45 5/07/98 6:26p Dave
104 * Fix strange boundary conditions which arise when players die/respawn
105 * while the game is being ended. Spiff up the chatbox doskey thing a bit.
107 * 44 5/04/98 10:39p Dave
108 * Put in endgame sequencing. Need to check campaign situations.
109 * Realigned ship info on team select screen.
111 * 43 5/02/98 5:38p Dave
112 * Put in new tracker API code. Put in ship information on mp team select
113 * screen. Make standalone server name permanent. Fixed standalone server
116 * 42 4/29/98 6:00p Dave
117 * Fixed chatbox font colors. Made observer offscreen indicators work.
118 * Numerous small UI fixes. Fix rank limitations for mp games.
120 * 41 4/25/98 3:14p Dave
121 * Fixed chatbox clipping problem.
123 * 40 4/16/98 6:34p Dave
124 * Fixed reversed team vs. team colors.
126 * 39 4/14/98 5:06p Dave
127 * Don't load or send invalid pilot pics. Fixed chatbox graphic errors.
128 * Made chatbox display team icons in a team vs. team game. Fixed up pause
129 * and endgame sequencing issues.
131 * 38 4/13/98 7:48p Dave
132 * Fixed chatbox overrun errors. Put in line recall function (4 deep).
134 * 37 4/12/98 2:09p Dave
135 * Make main hall door text less stupid. Make sure inputbox focus in the
136 * multi host options screen is managed more intelligently.
138 * 36 4/01/98 11:19p Dave
139 * Put in auto-loading of xferred pilot pic files. Grey out background
140 * behind pinfo popup. Put a chatbox message in when players are kicked.
141 * Moved mission title down in briefing. Other ui fixes.
143 * 35 3/31/98 4:42p Allender
144 * mission objective support for team v. team mode. Chatbox changes to
145 * make input box be correct length when typing
147 * 34 3/29/98 1:24p Dave
148 * Make chatbox not clear between multiplayer screens. Select player ship
149 * as default in mp team select and weapons select screens. Made create
150 * game mission list use 2 fixed size columns.
152 * 33 3/19/98 5:05p Dave
153 * Put in support for targeted multiplayer text and voice messaging (all,
154 * friendly, hostile, individual).
156 * 32 3/18/98 12:03p John
157 * Marked all the new strings as externalized or not.
159 * 31 3/17/98 12:30a Dave
160 * Put in hud support for rtvoice. Several ui interface changes.
162 * 30 3/10/98 10:59p Dave
163 * Fixed single player pause screen. Put in temporary fix for multiplayer
164 * version. Fixed several chatbox display and text string bugs.
166 * 29 2/27/98 9:41a Dave
167 * Made "up/down" arrows flip direction when toggling chatbox sizes.
169 * 28 2/26/98 4:21p Dave
170 * More robust multiplayer voice.
172 * 27 2/22/98 4:17p John
173 * More string externalization classification... 190 left to go!
175 * 26 2/22/98 12:19p John
176 * Externalized some strings
178 * 25 2/13/98 3:46p Dave
179 * Put in dynamic chatbox sizing. Made multiplayer file lookups use cfile
182 * 24 2/04/98 10:50p Allender
183 * zero out chat line before storing text
185 * 23 1/29/98 5:23p Dave
186 * Made ingame join handle bad packets gracefully.
188 * 22 1/23/98 5:43p Dave
189 * Finished bringing standalone up to speed. Coded in new host options
192 * 21 1/17/98 5:51p Dave
193 * Bug fixes for bugs generated by multiplayer testing.
195 * 20 1/16/98 5:23p Allender
196 * more chatbox changes
198 * 19 1/16/98 4:28p Allender
199 * automatically send line when close to end of chatbox.
201 * 18 1/16/98 2:34p Dave
202 * Made pause screen work properly (multiplayer). Changed how chat packets
205 * 17 1/15/98 6:12p Dave
206 * Fixed weapons loadout bugs with multiplayer respawning. Added
207 * multiplayer start screen. Fixed a few chatbox bugs.
209 * 16 1/15/98 5:10p Allender
210 * ton of interface changes. chatbox in multiplayer now behaves
211 * differently than before. It's always active in any screen that uses
212 * it. Only non-printatble characters will get passed back out from
215 * 15 1/12/98 5:17p Dave
216 * Put in a bunch of multiplayer sequencing code. Made weapon/ship select
217 * work through the standalone.
219 * 14 1/07/98 5:20p Dave
220 * Put in support for multiplayer campaigns with the new interface
223 * 13 1/05/98 5:06p Dave
224 * Fixed a chat packet bug. Fixed a few state save/restore bugs. Updated a
225 * few things for multiplayer server transfer.
227 * 12 12/29/97 3:15p Dave
228 * Put in auto-indenting for multiplayer chatbox. Tweaked some multiplayer
231 * 11 12/22/97 9:13p Allender
232 * fixed up a few minor issues with chatbox
234 * 10 12/19/97 7:08p Jasen
235 * Updated coords for new ChatBox (small)
237 * 9 12/18/97 8:59p Dave
238 * Finished putting in basic support for weapon select and ship select in
241 * 8 12/06/97 4:27p Dave
242 * Another load of interface and multiplayer bug fixes.
244 * 7 12/03/97 4:16p Hoffoss
245 * Changed sound stuff used in interface screens for interface purposes.
247 * 6 11/12/97 4:40p Dave
248 * Put in multiplayer campaign support parsing, loading and saving. Made
249 * command-line variables better named. Changed some things on the initial
250 * pilot select screen.
252 * 5 10/24/97 10:59p Hoffoss
253 * Added in create pilot popup window and barracks screen.
255 * 4 10/08/97 5:08p Lawrance
256 * use mask region for chat box inputbox, so getting focus is easier
258 * 3 10/01/97 4:47p Lawrance
259 * move some #defines out of header file into .cpp file
261 * 2 10/01/97 4:39p Lawrance
262 * move chat code into Chatbox.cpp, simplify interface
264 * 1 10/01/97 10:54a Lawrance
271 #include "freespace.h"
273 #include "missionscreencommon.h"
274 #include "multimsgs.h"
281 #include "multi_pmsg.h"
282 #include "alphacolors.h"
284 ///////////////////////////////////////////////////////////
286 ///////////////////////////////////////////////////////////
288 // a little extra spacing for the team vs. team icons
289 #define CHATBOX_TEAM_ICON_SPACE 18
291 // SMALL CHATBOX ----------------------------------------------------------------------------------
294 char* Chatbox_small_bitmap_fname[GR_NUM_RESOLUTIONS] = {
296 "2_Chatbox" // GR_1024
300 char* Chatbox_small_bitmap_mask_fname[GR_NUM_RESOLUTIONS] = {
301 "Chatbox-m", // GR_640
302 "2_Chatbox-m" // GR_1024
306 int Chatbox_small_coords[GR_NUM_RESOLUTIONS][2] = {
315 // display area coods
316 int Chatbox_small_display_coords[GR_NUM_RESOLUTIONS][4] = {
318 196 + CHATBOX_TEAM_ICON_SPACE, 13, 410 - CHATBOX_TEAM_ICON_SPACE, 74
321 315 + CHATBOX_TEAM_ICON_SPACE, 22, 654 - CHATBOX_TEAM_ICON_SPACE, 116
326 int Chatbox_small_input_coords[GR_NUM_RESOLUTIONS][4] = {
336 int Chatbox_small_max_lines[GR_NUM_RESOLUTIONS] = {
341 // BIG CHATBOX ----------------------------------------------------------------------------------
344 char* Chatbox_big_bitmap_fname[GR_NUM_RESOLUTIONS] = {
345 "ChatboxBig", // GR_640
346 "2_ChatboxBig" // GR_1024
350 char* Chatbox_big_bitmap_mask_fname[GR_NUM_RESOLUTIONS] = {
351 "Chatbox-m", // GR_640
352 "2_Chatbox-m" // GR_1024
356 int Chatbox_big_coords[GR_NUM_RESOLUTIONS][2] = {
365 // display area coords
366 int Chatbox_big_display_coords[GR_NUM_RESOLUTIONS][4] = {
368 196 + CHATBOX_TEAM_ICON_SPACE, 13, 410 - CHATBOX_TEAM_ICON_SPACE, 326
371 315 + CHATBOX_TEAM_ICON_SPACE, 22, 654 - CHATBOX_TEAM_ICON_SPACE, 519
376 int Chatbox_big_input_coords[GR_NUM_RESOLUTIONS][4] = {
386 int Chatbox_big_max_lines[GR_NUM_RESOLUTIONS] = {
391 // PAUSED CHATBOX ----------------------------------------------------------------------------------
394 char* Chatbox_p_bitmap_fname[GR_NUM_RESOLUTIONS] = {
396 "2_MPPause" // GR_1024
400 char* Chatbox_p_bitmap_mask_fname[GR_NUM_RESOLUTIONS] = {
401 "MPPause-m", // GR_640
402 "2_MPPause-m" // GR_1024
406 int Chatbox_p_coords[GR_NUM_RESOLUTIONS][2] = {
415 // display area coords
416 int Chatbox_p_display_coords[GR_NUM_RESOLUTIONS][4] = {
418 103 + CHATBOX_TEAM_ICON_SPACE, 149, 380 - CHATBOX_TEAM_ICON_SPACE, 143
421 165 + CHATBOX_TEAM_ICON_SPACE, 244, 654 - CHATBOX_TEAM_ICON_SPACE, 263
426 int Chatbox_p_input_coords[GR_NUM_RESOLUTIONS][4] = {
436 int Chatbox_p_max_lines[GR_NUM_RESOLUTIONS] = {
441 // defines for location and other info of chat box MULTI_PAUSED
443 #define CHATBOX_MP_FNAME NOX("MPPause")
444 #define CHATBOX_MP_MASK NOX("MPPause-m")
445 #define CHATBOX_MP_X1 112
446 #define CHATBOX_MP_Y1 198
447 #define CHATBOX_MP_X2 477
448 #define CHATBOX_MP_Y2 308
449 #define CHATBOX_MP_ICON_X (CHATBOX_MP_X1)
450 #define CHATBOX_MP_W (CHATBOX_MP_X2 - CHATBOX_MP_X1 + 1)
451 #define CHATBOX_MP_H (CHATBOX_MP_Y2 - CHATBOX_MP_Y1 + 1)
452 #define CHATBOX_MP_BEGIN_X (CHATBOX_MP_X1 + 3 + CHATBOX_TEAM_ICON_SPACE)
453 #define CHATBOX_MP_BEGIN_Y CHATBOX_MP_Y1
454 #define CHATBOX_MP_DISP_W 365
455 #define CHATBOX_MP_MAX_LINES 11
456 #define CHATBOX_MP_INPUTBOX_X (CHATBOX_MP_X1 + 3)
457 #define CHATBOX_MP_INPUTBOX_W (CHATBOX_MP_W)
458 #define CHATBOX_MP_TEXTENTER_Y 329
461 // CHATBOX ----------------------------------------------------------------------------------
463 // the settings being used for this instance
464 char Chatbox_mask[50];
473 int Chatbox_max_lines;
474 int Chatbox_inputbox_x;
475 int Chatbox_inputbox_w;
476 int Chatbox_textenter_y;
477 int Chat_scroll_up_coord[2];
478 int Chat_scroll_down_coord[2];
480 // how many pixels to indent succesive lines of text from a given player
481 #define CHAT_LINE_INDENT 20
483 // what chars other than letters and number's we'll toss
484 #define CHATBOX_INVALID_CHARS NOX("~`") // this is primarily so that we don't interfere with the voice recording keys
486 // common defines and data
487 #define CHATBOX_STRING_LEN (CALLSIGN_LEN + CHATBOX_MAX_LEN + 32)
488 UI_WINDOW Chat_window;
489 UI_INPUTBOX Chat_inputbox;
490 UI_BUTTON Chat_enter_text;
493 #define CHATBOX_NUM_BUTTONS 3
494 #define CHATBOX_SCROLL_UP 0
495 #define CHATBOX_SCROLL_DOWN 1
496 #define CHATBOX_TOGGLE_SIZE 2 // used for both big and small
498 // coordinate indicies
499 #define CHATBOX_X_COORD 0
500 #define CHATBOX_Y_COORD 1
501 #define CHATBOX_W_COORD 2
502 #define CHATBOX_H_COORD 3
505 ui_button_info Chatbox_buttons[GR_NUM_RESOLUTIONS][CHATBOX_NUM_BUTTONS+1] = {
507 ui_button_info("CHB_00", 613, 3, -1, -1, 0),
508 ui_button_info("CHB_01", 613, 41, -1, -1, 1),
509 ui_button_info("CHB_02a", 607, 74, -1, -1, 2),
510 ui_button_info("CHB_02b", 607, 74, -1, -1, 2),
513 ui_button_info("2_CHB_00", 981, 5, -1, -1, 0),
514 ui_button_info("2_CHB_01", 981, 67, -1, -1, 1),
515 ui_button_info("2_CHB_02a", 971, 119, -1, -1, 2),
516 ui_button_info("2_CHB_02b", 971, 119, -1, -1, 2),
520 int Chatbox_mode_flags = 0;
522 int Chatbox_bitmap = -1;
523 int Chatbox_big_bitmap = -1;
524 int Chatbox_small_bitmap = -1;
525 int Chatbox_mp_bitmap = -1;
526 int Chatbox_created = 0;
528 ///////////////////////////////////////////////////////////
530 ///////////////////////////////////////////////////////////
531 #define MAX_BRIEF_CHAT_LINES 60 // how many lines we can store in the scrollback buffer
532 #define BRIEF_DISPLAY_SPACING 2 // pixel spacing between chat lines
534 // the first byte of the text string will be the net player id of the
535 char Brief_chat_lines[MAX_BRIEF_CHAT_LINES][CHATBOX_STRING_LEN];
536 int Brief_chat_indents[MAX_BRIEF_CHAT_LINES];
538 int Brief_chat_next_index[MAX_BRIEF_CHAT_LINES];
539 int Brief_chat_prev_index[MAX_BRIEF_CHAT_LINES];
540 int Num_brief_chat_lines;
541 int Brief_current_add_line;
542 int Brief_start_display_index;
544 // chatbox line recall data
545 #define CHATBOX_MAX_RECALL_LINES 10
546 int Chatbox_recall_count = 0;
547 int Chatbox_recall_index = 0;
548 int Chatbox_recall_last = -1;
549 char Chatbox_recall_lines[CHATBOX_MAX_RECALL_LINES][CHATBOX_MAX_LEN+2];
551 ///////////////////////////////////////////////////////////
552 // forward declarations
553 ///////////////////////////////////////////////////////////
554 void chatbox_chat_init();
555 void chatbox_render_chat_lines();
556 void chatbox_set_mode(int mode_flags);
557 void chatbox_toggle_size();
558 void chatbox_toggle_size_adjust_lines();
559 void chat_autosplit_line(char *msg,char *remainder);
560 int chatbox_num_displayed_lines();
561 void chatbox_recall_add(char *string);
562 void chatbox_recall_up();
563 void chatbox_recall_down();
565 // set the chatbox mode without checking for any previous modes which may need to be handled specially
566 void chatbox_set_mode(int mode_flags)
570 // set the stored mode
571 Chatbox_mode_flags = mode_flags;
573 // small pregame chatbox
574 if(Chatbox_mode_flags & CHATBOX_FLAG_SMALL){
577 // big pregame chatbox
578 else if(Chatbox_mode_flags & CHATBOX_FLAG_BIG){
581 // multiplayer paused
586 // set up the display/init variables based upon what mode we chode
589 strcpy(Chatbox_mask, Chatbox_small_bitmap_mask_fname[gr_screen.res]);
590 Chatbox_x1 = Chatbox_small_coords[gr_screen.res][CHATBOX_X_COORD];
591 Chatbox_y1 = Chatbox_small_coords[gr_screen.res][CHATBOX_Y_COORD];
592 Chatbox_icon_x = Chatbox_small_display_coords[gr_screen.res][CHATBOX_X_COORD] - CHATBOX_TEAM_ICON_SPACE;
593 Chatbox_w = Chatbox_small_display_coords[gr_screen.res][CHATBOX_W_COORD];
594 Chatbox_h = Chatbox_small_display_coords[gr_screen.res][CHATBOX_H_COORD];
595 Chatbox_begin_x = Chatbox_small_display_coords[gr_screen.res][CHATBOX_X_COORD];
596 Chatbox_begin_y = Chatbox_small_display_coords[gr_screen.res][CHATBOX_Y_COORD];
597 Chatbox_disp_w = Chatbox_small_display_coords[gr_screen.res][CHATBOX_W_COORD];
598 Chatbox_max_lines = Chatbox_small_max_lines[gr_screen.res];
599 Chatbox_inputbox_x = Chatbox_small_input_coords[gr_screen.res][CHATBOX_X_COORD];
600 Chatbox_inputbox_w = Chatbox_small_input_coords[gr_screen.res][CHATBOX_W_COORD];
601 Chatbox_textenter_y = Chatbox_small_input_coords[gr_screen.res][CHATBOX_Y_COORD];
605 strcpy(Chatbox_mask, Chatbox_big_bitmap_mask_fname[gr_screen.res]);
606 Chatbox_x1 = Chatbox_big_coords[gr_screen.res][CHATBOX_X_COORD];
607 Chatbox_y1 = Chatbox_big_coords[gr_screen.res][CHATBOX_Y_COORD];
608 Chatbox_icon_x = Chatbox_big_display_coords[gr_screen.res][CHATBOX_X_COORD] - CHATBOX_TEAM_ICON_SPACE;
609 Chatbox_w = Chatbox_big_display_coords[gr_screen.res][CHATBOX_W_COORD];
610 Chatbox_h = Chatbox_big_display_coords[gr_screen.res][CHATBOX_H_COORD];
611 Chatbox_begin_x = Chatbox_big_display_coords[gr_screen.res][CHATBOX_X_COORD];
612 Chatbox_begin_y = Chatbox_big_display_coords[gr_screen.res][CHATBOX_Y_COORD];
613 Chatbox_disp_w = Chatbox_big_display_coords[gr_screen.res][CHATBOX_W_COORD];
614 Chatbox_max_lines = Chatbox_big_max_lines[gr_screen.res];
615 Chatbox_inputbox_x = Chatbox_big_input_coords[gr_screen.res][CHATBOX_X_COORD];
616 Chatbox_inputbox_w = Chatbox_big_input_coords[gr_screen.res][CHATBOX_W_COORD];
617 Chatbox_textenter_y = Chatbox_big_input_coords[gr_screen.res][CHATBOX_Y_COORD];
621 Chatbox_x1 = Chatbox_p_coords[gr_screen.res][CHATBOX_X_COORD];
622 Chatbox_y1 = Chatbox_p_coords[gr_screen.res][CHATBOX_Y_COORD];
623 Chatbox_icon_x = Chatbox_p_display_coords[gr_screen.res][CHATBOX_X_COORD] - CHATBOX_TEAM_ICON_SPACE;
624 Chatbox_w = Chatbox_p_display_coords[gr_screen.res][CHATBOX_W_COORD];
625 Chatbox_h = Chatbox_p_display_coords[gr_screen.res][CHATBOX_H_COORD];
626 Chatbox_begin_x = Chatbox_p_display_coords[gr_screen.res][CHATBOX_X_COORD];
627 Chatbox_begin_y = Chatbox_p_display_coords[gr_screen.res][CHATBOX_Y_COORD];
628 Chatbox_disp_w = Chatbox_p_display_coords[gr_screen.res][CHATBOX_W_COORD];
629 Chatbox_max_lines = Chatbox_p_max_lines[gr_screen.res];
630 Chatbox_inputbox_x = Chatbox_p_input_coords[gr_screen.res][CHATBOX_X_COORD];
631 Chatbox_inputbox_w = Chatbox_p_input_coords[gr_screen.res][CHATBOX_W_COORD];
632 Chatbox_textenter_y = Chatbox_p_input_coords[gr_screen.res][CHATBOX_Y_COORD];
637 // automatically split up any input text, send it, and leave the remainder
638 void chatbox_autosplit_line()
640 char *remainder,msg[150];
643 // if the chat line is getting too long, fire off the message, putting the last
644 // word on the next input line.
646 Chat_inputbox.get_text(msg);
648 // determine if the width of the string in pixels is > than the inputbox width -- if so,
649 // then send the message
650 gr_get_string_size(&msg_pixel_width, NULL, msg);
651 // if ( msg_pixel_width >= (Chatbox_inputbox_w - Player->short_callsign_width) ) {
652 if ( msg_pixel_width >= (Chatbox_inputbox_w - 25)) {
653 remainder = strrchr(msg, ' ');
660 // if I'm the server, then broadcast the packet
661 chatbox_recall_add(msg);
662 send_game_chat_packet(Net_player, msg, MULTI_MSG_ALL,NULL);
663 chatbox_add_line(msg, MY_NET_PLAYER_NUM);
665 // display any remainder of text on the next line
666 Chat_inputbox.set_text(remainder);
667 } else if((Chat_inputbox.pressed() && (strlen(msg) > 0)) || (strlen(msg) >= CHATBOX_MAX_LEN)) {
668 // tack on the null terminator in the boundary case
670 if(x >= CHATBOX_MAX_LEN){
671 msg[CHATBOX_MAX_LEN-1] = '\0';
673 // if I'm the server, then broadcast the packet
674 chatbox_recall_add(msg);
675 send_game_chat_packet(Net_player, msg, MULTI_MSG_ALL,NULL);
676 chatbox_add_line(msg, MY_NET_PLAYER_NUM);
678 // display any remainder of text on the next line
679 Chat_inputbox.set_text(remainder);
683 // initialize all chatbox details with the given mode flags
684 int chatbox_create(int mode_flags)
688 // don't do anything if the chatbox is already initialized
689 if (Chatbox_created){
693 // probably shouldn't be using the chatbox in single player mode
694 Assert(Game_mode & GM_MULTIPLAYER);
696 // setup all data to correspond to our mode flags
697 chatbox_set_mode(mode_flags);
699 // initialize all low-level details related to chatting
702 // attempt to load in the chatbox background bitmap
703 if(Chatbox_mode_flags & CHATBOX_FLAG_DRAW_BOX){
704 Chatbox_big_bitmap = bm_load(Chatbox_big_bitmap_fname[gr_screen.res]);
705 Chatbox_small_bitmap = bm_load(Chatbox_small_bitmap_fname[gr_screen.res]);
706 Chatbox_mp_bitmap = bm_load(Chatbox_p_bitmap_fname[gr_screen.res]);
708 if(Chatbox_mode_flags & CHATBOX_FLAG_SMALL){
709 Chatbox_bitmap = Chatbox_small_bitmap;
710 } else if(Chatbox_mode_flags & CHATBOX_FLAG_BIG){
711 Chatbox_bitmap = Chatbox_big_bitmap;
713 Chatbox_bitmap = Chatbox_mp_bitmap;
716 if((Chatbox_bitmap == -1) || (Chatbox_small_bitmap == -1) || (Chatbox_big_bitmap == -1) || (Chatbox_mp_bitmap == -1)){
721 // attempt to create the ui window for the chatbox and assign the mask
722 Chat_window.create( 0, 0, gr_screen.max_w, gr_screen.max_h, 0 );
723 Chat_window.set_mask_bmap(Chatbox_mask);
725 // create the chat text enter input area
726 Chat_inputbox.create( &Chat_window, Chatbox_inputbox_x, Chatbox_textenter_y, Chatbox_inputbox_w, CHATBOX_MAX_LEN, "", UI_INPUTBOX_FLAG_INVIS | UI_INPUTBOX_FLAG_ESC_CLR | UI_INPUTBOX_FLAG_KEYTHRU | UI_INPUTBOX_FLAG_EAT_USED, Chatbox_w, Color_netplayer[MY_NET_PLAYER_NUM]);
727 Chat_inputbox.set_focus();
728 Chat_inputbox.set_invalid_chars(CHATBOX_INVALID_CHARS);
730 // if we're supposed to supply and check for out own buttons
731 if((Chatbox_mode_flags & CHATBOX_FLAG_BUTTONS) && (Chatbox_mode_flags & CHATBOX_FLAG_DRAW_BOX)){
732 for(idx=0; idx<CHATBOX_NUM_BUTTONS; idx++){
734 Chatbox_buttons[gr_screen.res][idx].button.create(&Chat_window, "", Chatbox_buttons[gr_screen.res][idx].x, Chatbox_buttons[gr_screen.res][idx].y, 60, 30, (idx == CHATBOX_TOGGLE_SIZE) ? 0 : 1);
736 // set the highlight action
737 Chatbox_buttons[gr_screen.res][idx].button.set_highlight_action(common_play_highlight_sound);
740 Chatbox_buttons[gr_screen.res][idx].button.set_bmaps(Chatbox_buttons[gr_screen.res][idx].filename);
743 Chatbox_buttons[gr_screen.res][idx].button.link_hotspot(Chatbox_buttons[gr_screen.res][idx].hotspot);
746 // now create the toggle size button with the appropriate button
747 if(Chatbox_mode_flags & CHATBOX_FLAG_SMALL){
748 Chatbox_buttons[gr_screen.res][CHATBOX_TOGGLE_SIZE].button.set_bmaps(Chatbox_buttons[gr_screen.res][CHATBOX_TOGGLE_SIZE].filename);
750 Chatbox_buttons[gr_screen.res][CHATBOX_TOGGLE_SIZE].button.set_bmaps(Chatbox_buttons[gr_screen.res][CHATBOX_TOGGLE_SIZE+1].filename);
754 // an invisible button that will set focus to input box when clicked on
755 Chat_enter_text.create( &Chat_window, "", 0, 0, 60, 30, 0);
756 Chat_enter_text.hide(); // button doesn't show up
757 Chat_enter_text.link_hotspot(50);
763 // process this frame for the chatbox
764 int chatbox_process(int key_in)
770 // if the chatbox hasn't explicitly been created, we can't do any processing
771 if(!Chatbox_created){
775 // process the incoming key appropriately
777 key_out = Chat_window.process();
779 key_out = Chat_window.process(key_in);
782 // look for special keypresses
784 // line recall up one
790 // line recall down one
792 chatbox_recall_down();
797 // if we're supposed to be checking our own scroll buttons
798 if((Chatbox_mode_flags & CHATBOX_FLAG_BUTTONS) && (Chatbox_mode_flags & CHATBOX_FLAG_DRAW_BOX)){
799 if ( Chatbox_buttons[gr_screen.res][CHATBOX_SCROLL_UP].button.pressed() ) {
803 if ( Chatbox_buttons[gr_screen.res][CHATBOX_SCROLL_DOWN].button.pressed() ) {
804 chatbox_scroll_down();
807 if ( Chatbox_buttons[gr_screen.res][CHATBOX_TOGGLE_SIZE].button.pressed() ){
808 chatbox_toggle_size();
812 // check to see if the enter text button has been pressed
813 if ( Chat_enter_text.pressed() ) {
814 Chat_inputbox.set_focus();
817 // check to see if the current input text needs to be split up and sent automaticall
818 chatbox_autosplit_line();
825 // destory the UI window
826 Chat_window.destroy();
828 // unload any bitmaps
829 if(Chatbox_small_bitmap != -1){
830 bm_unload(Chatbox_small_bitmap);
832 if(Chatbox_big_bitmap != -1){
833 bm_unload(Chatbox_big_bitmap);
835 if(Chatbox_mp_bitmap != -1){
836 bm_unload(Chatbox_mp_bitmap);
839 // clear all the text lines in the
844 // shutdown all chatbox functionality
847 // only do this if we have valid data
849 // clear all chat data
850 memset(Brief_chat_lines,0,(MAX_BRIEF_CHAT_LINES * (CHATBOX_MAX_LEN + 2)));
851 Brief_start_display_index=0;
852 Num_brief_chat_lines=0;
853 Brief_current_add_line=0;
855 // clear all line recall data
856 Chatbox_recall_count = 0;
857 Chatbox_recall_index = 0;
858 Chatbox_recall_last = -1;
859 memset(Chatbox_recall_lines,0,CHATBOX_MAX_RECALL_LINES * (CHATBOX_MAX_LEN + 2));
863 // render the chatbox for this frame
864 void chatbox_render()
866 if (!Chatbox_created){
870 // clear the multiplayer chat window
871 // gr_set_clip(Chatbox_x1, Chatbox_y1, Chatbox_w, Chatbox_h);
875 // draw the background bitmap if we're supposed to
876 if ( (Chatbox_bitmap != -1) && (Chatbox_mode_flags & CHATBOX_FLAG_DRAW_BOX)) {
877 gr_set_bitmap( Chatbox_bitmap );
878 gr_bitmap(Chatbox_x1, Chatbox_y1);
881 // render the chat lines
882 chatbox_render_chat_lines();
884 // render any UI window stuff
888 // try and scroll the chatbox up. return 0 or 1 on fail or success
889 int chatbox_scroll_up()
891 if(Num_brief_chat_lines > Chatbox_max_lines){
892 int prev = Brief_chat_prev_index[Brief_start_display_index];
894 // check to make sure we won't be going "up" above the "beginning" of the text array
895 if(Brief_chat_prev_index[Brief_current_add_line] != prev && !(Num_brief_chat_lines < MAX_BRIEF_CHAT_LINES && Brief_start_display_index==0)){
896 Brief_start_display_index = prev;
904 // try and scroll the chatbox down, return 0 or 1 on fail or success
905 int chatbox_scroll_down()
910 if(Num_brief_chat_lines > Chatbox_max_lines){
911 // yuck. There's got to be a better way to do this.
912 next = Brief_chat_next_index[Brief_start_display_index];
913 for(idx = 1;idx <= Chatbox_max_lines; idx++){
914 next = Brief_chat_next_index[next];
917 // check to make sure we won't be going "down" below the "bottom" of the text array
918 if(Brief_chat_next_index[Brief_current_add_line] != next){
919 Brief_start_display_index = Brief_chat_next_index[Brief_start_display_index];
926 // quick explanation as to how the scrolling works :
927 // Brief_chat_next_index is an array A of size n, where A[i] = i+1 and A[n] = 0
928 // Brief_chat_prev_index is an array A of size n, where A[i] = i-1 and A[0] = n
929 // in other words, if you increment an integer i = A[i], you get the next index (or the prev)
930 // with wrapping. In this way, as chat lines are entered, they are continuously wrapped
931 // around the Brief_chat_lines array so we can keep it at a fixed size. These arrays are used
932 // for both entering new chat strings as well as moving the Brief_start_display_index
933 // integer, which is self-explanatory
935 void chatbox_chat_init()
941 // setup the wraparound arrays
942 for(idx=0;idx<MAX_BRIEF_CHAT_LINES;idx++){
943 Brief_chat_next_index[idx] = idx+1;
945 Brief_chat_next_index[MAX_BRIEF_CHAT_LINES-1]=0;
947 for(idx=MAX_BRIEF_CHAT_LINES-1; idx > 0 ; idx--){
948 Brief_chat_prev_index[idx] = idx - 1;
950 Brief_chat_prev_index[0] = MAX_BRIEF_CHAT_LINES-1;
952 // initialize the line recall data
953 Chatbox_recall_count = 0;
954 Chatbox_recall_index = 0;
955 Chatbox_recall_last = -1;
956 memset(Chatbox_recall_lines,0,CHATBOX_MAX_RECALL_LINES * (CHATBOX_MAX_LEN + 2));
959 // int Test_color = 0;
960 void chatbox_add_line(char *msg, int pid, int add_id)
965 char *p_str[3]; // for the initial line (unindented)
966 char msg_extra[CHATBOX_STRING_LEN];
968 if(!Chatbox_created){
972 // maybe stick on who sent the message
974 if(MULTI_STANDALONE(Net_players[pid])){
975 sprintf(msg_extra, NOX("%s %s"), NOX("<SERVER>"), msg );
977 sprintf(msg_extra, NOX("%s: %s"), Net_players[pid].player->short_callsign, msg );
980 strcpy(msg_extra,msg);
982 Assert(strlen(msg_extra) < (CHATBOX_STRING_LEN - 2));
984 // split the text up into as many lines as necessary
985 n_lines = split_str(msg_extra, Chatbox_disp_w, n_chars, p_str, 3);
986 Assert(n_lines != -1);
988 // setup the first line -- be sure to clear out the line
989 memset( Brief_chat_lines[Brief_current_add_line], 0, CHATBOX_STRING_LEN );
991 // add the player id #
992 Brief_chat_lines[Brief_current_add_line][0] = (char)(pid % 16);
993 // Brief_chat_lines[Brief_current_add_line][0] = (char)Test_color;
994 // Test_color = (Test_color == MAX_PLAYERS - 1) ? 0 : Test_color++;
996 // set the indent to 0
997 Brief_chat_indents[Brief_current_add_line] = 0;
1000 strncpy(&Brief_chat_lines[Brief_current_add_line][1],p_str[0],CHATBOX_STRING_LEN - 1);
1001 if(n_chars[0] >= CHATBOX_STRING_LEN){
1002 Brief_chat_lines[Brief_current_add_line][CHATBOX_STRING_LEN - 1] = '\0';
1004 Brief_chat_lines[Brief_current_add_line][n_chars[0] + 1] = '\0';
1007 // increment the total line count if we haven't reached the max already
1008 if(Num_brief_chat_lines<MAX_BRIEF_CHAT_LINES){
1009 Num_brief_chat_lines++;
1012 // get the index of the next string to add text to
1013 Brief_current_add_line = Brief_chat_next_index[Brief_current_add_line];
1015 // if we have more than 1 line, re-split everything so that the rest are indented
1017 // split up the string after the first break-marker
1018 n_lines = split_str(msg_extra + n_chars[0],Chatbox_disp_w - CHAT_LINE_INDENT,n_chars,p_str,3);
1019 Assert(n_lines != -1);
1021 // setup these remaining lines
1022 for(idx=0;idx<n_lines;idx++){
1023 // add the player id#
1024 Brief_chat_lines[Brief_current_add_line][0] = (char)(pid % 16);
1026 // add the proper indent
1027 Brief_chat_indents[Brief_current_add_line] = CHAT_LINE_INDENT;
1029 // copy in the line text itself
1030 strncpy(&Brief_chat_lines[Brief_current_add_line][1],p_str[idx],CHATBOX_STRING_LEN-1);
1031 if(n_chars[idx] >= CHATBOX_STRING_LEN){
1032 Brief_chat_lines[Brief_current_add_line][CHATBOX_STRING_LEN - 1] = '\0';
1034 Brief_chat_lines[Brief_current_add_line][n_chars[idx] + 1] = '\0';
1037 // increment the total line count if we haven't reached the max already
1038 if(Num_brief_chat_lines<MAX_BRIEF_CHAT_LINES){
1039 Num_brief_chat_lines++;
1042 // get the index of the next line to add text to
1043 Brief_current_add_line = Brief_chat_next_index[Brief_current_add_line];
1047 // COMMAND LINE OPTION
1048 if(Cmdline_multi_stream_chat_to_file && Multi_chat_stream!=NULL && strlen(msg)>0){ // stream to the file if we're supposed to
1049 cfwrite_string(msg,Multi_chat_stream);
1050 cfwrite_char('\n',Multi_chat_stream);
1053 // if this line of text is from the player himself, automatically go to the bottom of
1055 if(pid == MY_NET_PLAYER_NUM){
1056 if(Num_brief_chat_lines > Chatbox_max_lines){
1057 Brief_start_display_index = Brief_current_add_line;
1058 for(backup = 1;backup <= Chatbox_max_lines;backup++){
1059 Brief_start_display_index = Brief_chat_prev_index[Brief_start_display_index];
1063 // if we have enough lines of text to require scrolling, scroll down by one.
1065 chatbox_scroll_down();
1069 void chatbox_render_chat_lines()
1071 int started_at,player_num,count,ly;
1073 started_at = Brief_start_display_index;
1075 ly = Chatbox_begin_y;
1076 while((count < Chatbox_max_lines) && (count < Num_brief_chat_lines)){
1077 // determine what player this chat line came from, and set the appropriate text color
1078 player_num = Brief_chat_lines[started_at][0];
1080 // print the line out
1081 gr_set_color_fast(Color_netplayer[player_num]);
1083 // draw the first line (no indent)
1084 gr_string(Chatbox_begin_x + Brief_chat_indents[started_at],ly,&Brief_chat_lines[started_at][1]);
1086 // if we're in a team vs. team game, blit the player color icon
1087 if(Netgame.type_flags & NG_TYPE_TEAM){
1088 switch(Net_players[player_num].p_info.team){
1090 // if he's a team captain
1091 if(Net_players[player_num].flags & NETINFO_FLAG_TEAM_CAPTAIN){
1092 if(Multi_common_icons[MICON_TEAM0_SELECT] != -1){
1093 gr_set_bitmap(Multi_common_icons[MICON_TEAM0_SELECT]);
1094 gr_bitmap(Chatbox_icon_x,ly-2);
1097 // just you're average peon
1099 if(Multi_common_icons[MICON_TEAM0] != -1){
1100 gr_set_bitmap(Multi_common_icons[MICON_TEAM0]);
1101 gr_bitmap(Chatbox_icon_x,ly-2);
1106 // if he's a team captain
1107 if(Net_players[player_num].flags & NETINFO_FLAG_TEAM_CAPTAIN){
1108 if(Multi_common_icons[MICON_TEAM1_SELECT] != -1){
1109 gr_set_bitmap(Multi_common_icons[MICON_TEAM1_SELECT]);
1110 gr_bitmap(Chatbox_icon_x,ly-2);
1113 // just your average peon
1115 if(Multi_common_icons[MICON_TEAM1] != -1){
1116 gr_set_bitmap(Multi_common_icons[MICON_TEAM1]);
1117 gr_bitmap(Chatbox_icon_x,ly-2);
1124 // increment the count and line position
1128 // increment the started at index
1129 started_at = Brief_chat_next_index[started_at];
1133 void chatbox_toggle_size()
1135 // if we're in "small" mode
1136 if(Chatbox_mode_flags & CHATBOX_FLAG_SMALL){
1137 chatbox_force_big();
1140 gamesnd_play_iface(SND_IFACE_MOUSE_CLICK);
1142 // if we're in "big" mode
1143 else if(Chatbox_mode_flags & CHATBOX_FLAG_BIG){
1144 chatbox_force_small();
1147 gamesnd_play_iface(SND_IFACE_MOUSE_CLICK);
1151 void chatbox_toggle_size_adjust_lines()
1155 // if the chatbox is now big, move the starting display index _up_ as far as possible
1156 if(Chatbox_mode_flags & CHATBOX_FLAG_BIG){
1157 // if we've wrapped around or we have more chatlines then we can display, move back as far as we can
1158 if((Num_brief_chat_lines > MAX_BRIEF_CHAT_LINES) || (Num_brief_chat_lines > Chatbox_max_lines)){
1159 count_diff = Chatbox_max_lines - chatbox_num_displayed_lines();
1160 while(count_diff > 0){
1161 Brief_start_display_index = Brief_chat_prev_index[Brief_start_display_index];
1165 // otherwise start displaying from position 0
1167 Brief_start_display_index = 0;
1170 // if the chatbox is now small, move the starting display index down as far as we need
1171 else if(Chatbox_mode_flags & CHATBOX_FLAG_SMALL){
1172 count_diff = chatbox_num_displayed_lines();
1173 // if we were displaying more lines than we can now
1174 if(count_diff > Chatbox_max_lines){
1175 count_diff -= Chatbox_max_lines;
1176 while(count_diff > 0){
1177 Brief_start_display_index = Brief_chat_next_index[Brief_start_display_index];
1184 int chatbox_num_displayed_lines()
1186 int idx = Brief_start_display_index;
1189 // count the lines up
1191 while(idx != Brief_current_add_line){
1192 idx = Brief_chat_next_index[idx];
1199 // force the chatbox to go into small mode (if its in large mode) - will not wotk if in multi paused chatbox mode
1200 void chatbox_force_small()
1204 // don't do anything unless we're currently in "big" mode
1205 if(!(Chatbox_mode_flags & CHATBOX_FLAG_BIG)){
1209 new_mode_flags = Chatbox_mode_flags;
1211 // switch to the appropriate mode
1212 new_mode_flags &= ~(CHATBOX_FLAG_SMALL | CHATBOX_FLAG_BIG);
1213 new_mode_flags |= CHATBOX_FLAG_SMALL;
1214 Chatbox_bitmap = Chatbox_small_bitmap;
1216 // flip the up/down arrow
1217 Chatbox_buttons[gr_screen.res][CHATBOX_TOGGLE_SIZE].button.set_bmaps(Chatbox_buttons[gr_screen.res][CHATBOX_TOGGLE_SIZE].filename);
1219 // call this to set everything up correctly
1220 chatbox_set_mode(new_mode_flags);
1222 // change the location of the input box
1223 Chat_inputbox.update_dimensions(Chatbox_inputbox_x, Chatbox_textenter_y, Chatbox_inputbox_w,15);
1224 Chat_inputbox.set_focus();
1226 // adjust what line we start displaying from based upon the new size of the window
1227 chatbox_toggle_size_adjust_lines();
1230 // force the chatbox to go into big mode (if its in small mode) - will not work if in multi paused chatbox mode
1231 void chatbox_force_big()
1235 // don't do anything unless we're currently in "small" mode
1236 if(!(Chatbox_mode_flags & CHATBOX_FLAG_SMALL)){
1240 new_mode_flags = Chatbox_mode_flags;
1242 // switch to the appropriate mode
1243 new_mode_flags &= ~(CHATBOX_FLAG_SMALL | CHATBOX_FLAG_BIG);
1244 new_mode_flags |= CHATBOX_FLAG_BIG;
1245 Chatbox_bitmap = Chatbox_big_bitmap;
1247 // flip the up/down arrow
1248 Chatbox_buttons[gr_screen.res][CHATBOX_TOGGLE_SIZE].button.set_bmaps(Chatbox_buttons[gr_screen.res][CHATBOX_TOGGLE_SIZE+1].filename);
1250 // call this to set everything up correctly
1251 chatbox_set_mode(new_mode_flags);
1253 // change the location of the input box
1254 Chat_inputbox.update_dimensions(Chatbox_inputbox_x, Chatbox_textenter_y, Chatbox_inputbox_w,15);
1255 Chat_inputbox.set_focus();
1257 // adjust what line we start displaying from based upon the new size of the window
1258 chatbox_toggle_size_adjust_lines();
1261 // "lose" the focus on the chatbox inputbox
1262 void chatbox_lose_focus()
1264 if(!Chatbox_created){
1268 // clear the focus on the inputbox
1269 Chat_inputbox.clear_focus();
1272 // return if the inputbox for the chatbox currently has focus
1273 int chatbox_has_focus()
1275 return Chat_inputbox.has_focus();
1278 // grab the focus for the chatbox inputbox
1279 void chatbox_set_focus()
1281 Chat_inputbox.set_focus();
1284 // return if the inputbox was pressed - "clicked on"
1285 int chatbox_pressed()
1287 return Chat_inputbox.pressed();
1290 // add the string to the line recall list
1291 void chatbox_recall_add(char *string)
1295 // aleays reset the recall index when adding
1296 Chatbox_recall_index = 0;
1297 Chatbox_recall_last = -1;
1299 // if this string matches the last string we entered, don't add it again
1300 if(!strcmp(string,Chatbox_recall_lines[0])){
1304 // move all items up (this works fine for small #'s of recall lines
1305 for(idx=CHATBOX_MAX_RECALL_LINES-1;idx > 0;idx--){
1306 memcpy(&Chatbox_recall_lines[idx],&Chatbox_recall_lines[idx-1],CHATBOX_MAX_LEN+2);
1309 // copy the new item into spot 0
1310 strcpy(Chatbox_recall_lines[0],string);
1312 // increment the recall count if necessary
1313 if(Chatbox_recall_count < CHATBOX_MAX_RECALL_LINES){
1314 Chatbox_recall_count++;
1318 // user has pressed the "up" key
1319 void chatbox_recall_up()
1321 // if we've got no recall lines, do nothing
1322 if(Chatbox_recall_count <= 0){
1326 // if we can increment up
1327 if(Chatbox_recall_index < (Chatbox_recall_count - 1)){
1328 // if this is the last line we recalled, pre-increment
1329 if(Chatbox_recall_last == Chatbox_recall_index){
1330 Chat_inputbox.set_text(Chatbox_recall_lines[++Chatbox_recall_index]);
1331 Chatbox_recall_last = Chatbox_recall_index;
1333 // otherwise, post increment
1335 Chat_inputbox.set_text(Chatbox_recall_lines[Chatbox_recall_index++]);
1336 Chatbox_recall_last = Chatbox_recall_index - 1;
1339 // if we can't increment up
1341 Chat_inputbox.set_text(Chatbox_recall_lines[Chatbox_recall_index]);
1342 Chatbox_recall_last = Chatbox_recall_index;
1346 // user has pressed the "down" key
1347 void chatbox_recall_down()
1349 // if we've got no recall lines, do nothing
1350 if(Chatbox_recall_count <= 0){
1354 // if we can decrement down
1355 if(Chatbox_recall_index > 0){
1356 // if this is the last line we recalled, pre-decrement
1357 if(Chatbox_recall_last == Chatbox_recall_index){
1358 Chat_inputbox.set_text(Chatbox_recall_lines[--Chatbox_recall_index]);
1359 Chatbox_recall_last = Chatbox_recall_index;
1361 // otherwise post,decrement
1363 Chat_inputbox.set_text(Chatbox_recall_lines[Chatbox_recall_index--]);
1364 Chatbox_recall_last = Chatbox_recall_index + 1;
1367 // if we can't decrement down
1369 Chat_inputbox.set_text("");
1370 Chatbox_recall_last = -1;
1374 // reset all timestamps associated with the chatbox
1375 void chatbox_reset_timestamps()
1379 // if there is no chatbox created, do nothing
1380 if(!Chatbox_created){
1384 // otherwise clear all timestamps on all the buttons
1385 for(idx=0; idx<CHATBOX_NUM_BUTTONS+1; idx++){
1386 Chatbox_buttons[gr_screen.res][idx].button.reset_timestamps();