Comms menu controls (#6736)

* Added new keybinds, keycontrol handlers,  hudsquadmsg methods for alternate communication menu control scheme

* .gitignore update. CMake in VStudio places builds in [Oo]ut/ folder by default

* Added support for menu pages

* Small formatting cleanup

* code cleanup

* removed unecessary variable

* Updates after code review

* Updated comments

* XSTR_SIZE correction

Author: Wielkimati

.gitignore

@@ -42,6 +42,7 @@ _ReSharper*/
 
 #Project files
 [Bb]uild/
+[Oo]ut/
 
 #Subversion files
 .svn

code/controlconfig/controlsconfig.h

@@ -297,6 +297,13 @@ enum IoActionId : int {
 	JOY_ABS_THROTTLE_AXIS							= 127,
 	JOY_REL_THROTTLE_AXIS							= 128,
 
+	//!< @n
+	//! Communication menu controls
+	//! ----------------------------
+	COMMS_MENU_MOVE_UP,
+	COMMS_MENU_MOVE_DOWN,
+	COMMS_MENU_SELECT,
+
 	TOGGLE_HUD_SHADOWS,
 
 	CYCLE_PRIMARY_WEAPON_PATTERN,

code/controlconfig/controlsconfigcommon.cpp

@@ -272,6 +272,13 @@ void control_config_common_init_bindings() {
 	(CUSTOM_CONTROL_3,                  KEY_ALTED | KEY_SHIFTED | KEY_3, -1, COMPUTER_TAB, 1786, "Custom Control 3", CC_TYPE_TRIGGER, true)
 	(CUSTOM_CONTROL_4,                  KEY_ALTED | KEY_SHIFTED | KEY_4, -1, COMPUTER_TAB, 1787, "Custom Control 4", CC_TYPE_TRIGGER, true)
 	(CUSTOM_CONTROL_5,                  KEY_ALTED | KEY_SHIFTED | KEY_5, -1, COMPUTER_TAB, 1788, "Custom Control 5", CC_TYPE_TRIGGER, true)
+
+
+	//Comms Controls
+	(COMMS_MENU_MOVE_UP,                                             -1, -1, COMPUTER_TAB, 1883, "Communication Menu Move Up",   CC_TYPE_TRIGGER)
+	(COMMS_MENU_MOVE_DOWN,                                           -1, -1, COMPUTER_TAB, 1884, "Communication Menu Move Down", CC_TYPE_TRIGGER)
+	(COMMS_MENU_SELECT,                                              -1, -1, COMPUTER_TAB, 1885, "Communication Menu Select",    CC_TYPE_TRIGGER)
+
 	.end();	// Builder
 
 	// init default preset
@@ -438,6 +445,9 @@ SCP_unordered_map<SCP_string, IoActionId> old_text = {
 	{"Custom Control 3",                        CUSTOM_CONTROL_3},
 	{"Custom Control 4",                        CUSTOM_CONTROL_4},
 	{"Custom Control 5",                        CUSTOM_CONTROL_5},
+	{"Communication Menu Move Up",              COMMS_MENU_MOVE_UP},
+	{"Communication Menu Move Down",            COMMS_MENU_MOVE_DOWN},
+	{"Communication Menu Select",               COMMS_MENU_SELECT},
 };
 
 // Localization strings for hat positions. Back[0], Forward[1], Left[2], Right[3]
@@ -1164,6 +1174,10 @@ void LoadEnumsIntoActionMap() {
 	ADD_ENUM_TO_ACTION_MAP(JOY_ABS_THROTTLE_AXIS)
 	ADD_ENUM_TO_ACTION_MAP(JOY_REL_THROTTLE_AXIS)
 
+	ADD_ENUM_TO_ACTION_MAP(COMMS_MENU_MOVE_UP)
+	ADD_ENUM_TO_ACTION_MAP(COMMS_MENU_MOVE_DOWN)
+	ADD_ENUM_TO_ACTION_MAP(COMMS_MENU_SELECT)
+
 
 #undef ADD_ENUM_TO_ACTION_MAP
 

code/hud/hudsquadmsg.cpp

@@ -107,7 +107,8 @@ char Squad_msg_title[256] = "";
 mmode_item MsgItems[MAX_MENU_ITEMS];
 int Num_menu_items = -1; // number of items for a message menu
 
-int First_menu_item= -1;							// index of first item in the menu
+int First_menu_item= -1;							// index of first item in the menu. This tracks what element of comms options collection is displayed as first option, and displays the next 9 options. Changes only by +/- MAX_MENU_ITEMS (10)
+int Selected_menu_item = First_menu_item;           //!< index of selected item in the menu. Possible index range: 0 - 9, assuming MAX_MENU_ITEMS == 10, and First_menu_item gets initialized
 SCP_string Lua_sqd_msg_cat;
 
 #define MAX_KEYS_NO_SCROLL	10
@@ -217,6 +218,7 @@ void hud_squadmsg_start()
 
 	Num_menu_items = -1;													// reset the menu items
 	First_menu_item = 0;
+	Selected_menu_item = First_menu_item;                            // make first menu item a selected object
 	Squad_msg_mode = SM_MODE_TYPE_SELECT;							// start off at the base state
 	Msg_mode_timestamp = timestamp(DEFAULT_MSG_TIMEOUT);		// initialize our timer to bogus value
 	Msg_shortcut_command = -1;											// assume no shortcut key being used
@@ -485,6 +487,89 @@ void hud_squadmsg_page_up()
 	}
 }
 
+//Fuctions that allow selection of specific comms menu items with simple up/down/select buttons
+void hud_squadmsg_selection_move_down() {
+
+	//Check if comms menu is up
+	if (Player->flags & PLAYER_FLAGS_MSG_MODE)
+	{
+		//move down
+		++Selected_menu_item;
+
+		//play scrolling sound and reset the comms window timeout timer, so the window doesn't dissapear while we select our item
+		gamesnd_play_iface(InterfaceSounds::SCROLL);
+		Msg_mode_timestamp = timestamp(DEFAULT_MSG_TIMEOUT);
+
+		//Move to next page if we went outside of current one
+		if (Selected_menu_item == MAX_MENU_DISPLAY 
+			&& (First_menu_item + MAX_MENU_DISPLAY < Num_menu_items))
+		{
+			hud_squadmsg_page_down();
+			Selected_menu_item = 0;
+		}
+
+		//Select the first menu item if we went outside items range, so we can loop around
+		if (First_menu_item + Selected_menu_item >= Num_menu_items) 
+		{
+			First_menu_item = 0;
+			Selected_menu_item = First_menu_item;
+		}
+	}
+}
+
+void hud_squadmsg_selection_move_up() {
+
+	//Check if comms menu is up
+	if (Player->flags & PLAYER_FLAGS_MSG_MODE)
+	{
+		//move up
+		--Selected_menu_item;
+
+		//play scrolling sound and reset the comms window timeout timer, so the window doesn't dissapear while we select our item
+		gamesnd_play_iface(InterfaceSounds::SCROLL);
+		Msg_mode_timestamp = timestamp(DEFAULT_MSG_TIMEOUT);
+
+		//Move to previous page if it exists
+		if (Selected_menu_item < 0 && First_menu_item > 0)
+		{
+			hud_squadmsg_page_up();
+			Selected_menu_item = MAX_MENU_DISPLAY - 1; //if we're moving to previous page in the first place, we assume it was already populated to the max
+		}
+
+		//Select the last menu item if we went outside items range, so we can loop around
+		else if (Selected_menu_item < 0) 
+		{
+			//Assuming MAX_MENU_DISPLAY = 10, set First_menu_item to the nearest lower multiple of 10
+			//So if we have 85 items in comms menu, looping back from 1st page to last would set First_menu_item to 80
+			//exactly like pageUp/pageDown does
+			First_menu_item = ((Num_menu_items - 1) / MAX_MENU_DISPLAY) * MAX_MENU_DISPLAY;
+			Selected_menu_item = Num_menu_items - 1 - First_menu_item;
+		}
+	}
+}
+
+//function that tricks hud_squadmsg_get_key() into thinking player selected a menu item with a num key press
+//Yes, this is a pretty much a hack, but it's simple and works with every squadmsq type.
+void hud_squadmsg_selection_select() {
+	
+	//Check if comms menu is up
+	if (Player->flags & PLAYER_FLAGS_MSG_MODE)
+	{
+		//Check if selected option is even active
+		if (!(MsgItems[Selected_menu_item + First_menu_item].active))
+		{
+			gamesnd_play_iface(InterfaceSounds::GENERAL_FAIL);
+		}
+		else
+		{
+			Msg_key_used = 1;
+			Msg_key = Selected_menu_item + 2;	  //+1 because menu items on actual menu start from 1, not 0
+												  //Another +1 because methods that use this later do -1. I'm not sure why they do that, but it works
+			Selected_menu_item = 0; //Reset this value, so the position will reset at the next window
+		}
+	}
+}
+
 int hud_squadmsg_get_total_keys()
 {
 	int num_keys_used;
@@ -2839,6 +2924,7 @@ void HudGaugeSquadMessage::render(float  /*frametime*/, bool config)
 
 	for (int i = 0; i < nitems; i++ ) {
 		int item_num;
+		bool isSelectedItem = First_menu_item + i == First_menu_item + Selected_menu_item;
 		char text[255];
 
 		if (!config) {
@@ -2867,22 +2953,30 @@ void HudGaugeSquadMessage::render(float  /*frametime*/, bool config)
 		by += fl2i(Item_h * scale);
 
 		// set the text color
-		if (!config && (MsgItems[First_menu_item+i].active > 0) ) {
+		if (!config && (MsgItems[First_menu_item + i].active > 0)) {
 			setGaugeColor(HUD_C_BRIGHT, config);
-		} else {
+		}
+		else if (isSelectedItem) {
+			setGaugeColor(HUD_C_NORMAL, config);
+		}
+		else {
 			setGaugeColor(HUD_C_DIM, config);
 		}
 
-		// first do the number
 		if (MsgItems[First_menu_item + i].active >= 0) {
-			item_num = (i+1) % MAX_MENU_DISPLAY;
-			renderPrintfWithGauge(sx, sy, EG_SQ1 + i, scale, config, NOX("%1d."), item_num);
+			// first print an icon to indicate selected item
+			if (isSelectedItem) {
+				renderString(sx, sy, EG_SQ1 + i, ">>", scale, config);
+			}
+			// or do the number
+			else {
+				item_num = (i + 1) % MAX_MENU_DISPLAY;
+				renderPrintfWithGauge(sx, sy, EG_SQ1 + i, scale, config, NOX("%1d."), item_num);
+			}
 
 			// then the text
 			font::force_fit_string(text, 255, fl2i(Ship_name_max_width * scale), scale);
-   
 			renderString(sx + fl2i(Item_offset_x * scale), sy, EG_SQ1 + i, text, scale, config);
-
 			sy += fl2i(Item_h * scale);
 		}
 

code/hud/hudsquadmsg.h

@@ -190,6 +190,11 @@ void hud_enemymsg_toggle();						// debug function to allow messaging of enemies
 // Added for voicer implementation
 void hud_squadmsg_do_mode( int mode );
 
+// functions for menu item selection with simple up/down/select buttons
+void hud_squadmsg_selection_move_down();
+void hud_squadmsg_selection_move_up();
+void hud_squadmsg_selection_select();
+
 // Added for checking message validity - Mjn
 bool hud_squadmsg_ship_order_valid(int shipnum, int order);
 

code/io/keycontrol.cpp

@@ -340,7 +340,11 @@ int Normal_key_set[] = {
     CUSTOM_CONTROL_2,
     CUSTOM_CONTROL_3,
 	CUSTOM_CONTROL_4,
-	CUSTOM_CONTROL_5
+	CUSTOM_CONTROL_5,
+		
+	COMMS_MENU_MOVE_UP,
+	COMMS_MENU_MOVE_DOWN,
+	COMMS_MENU_SELECT
 };
 
 int Dead_key_set[] = {
@@ -480,7 +484,11 @@ int Non_critical_key_set[] = {
     CUSTOM_CONTROL_2,
     CUSTOM_CONTROL_3,
 	CUSTOM_CONTROL_4,
-	CUSTOM_CONTROL_5
+	CUSTOM_CONTROL_5,
+
+	COMMS_MENU_MOVE_UP,
+	COMMS_MENU_MOVE_DOWN,
+	COMMS_MENU_SELECT
 };
 
 int Ignored_keys[CCFG_MAX];
@@ -2840,6 +2848,18 @@ int button_function(int n)
 		case SQUADMSG_MENU:
 			hud_squadmsg_toggle();				// leave the details to the messaging code!!!
 			break;
+			 
+		case COMMS_MENU_MOVE_DOWN:
+			hud_squadmsg_selection_move_down();
+			break;
+
+		case COMMS_MENU_MOVE_UP:
+			hud_squadmsg_selection_move_up();
+			break;
+
+		case COMMS_MENU_SELECT:
+			hud_squadmsg_selection_select();
+			break;
 
 		// show the mission goals screen
 		case SHOW_GOALS:

code/localization/localize.cpp

@@ -64,7 +64,7 @@ bool *Lcl_unexpected_tstring_check = nullptr;
 // NOTE: with map storage of XSTR strings, the indexes no longer need to be contiguous,
 // but internal strings should still increment XSTR_SIZE to avoid collisions.
 // retail XSTR_SIZE = 1570
-// #define XSTR_SIZE	1883 // This is the next available ID
+// #define XSTR_SIZE	1886 // This is the next available ID
 
 // struct to allow for strings.tbl-determined x offset
 // offset is 0 for english, by default