Allow mods to easily tune 'Target Hostile Bomb or Bomber' control (#7048)

* Allow mods to easily tune 'Target Hostile Bomb or Bomber' control

The `Target Hostile Bomb or Bomber` control targets bombs or bombers, though in mods may want a way to easily set exactly what this control does while still leveraging the utility of the 'bomb' flag for weapons and/or 'bomber' flag for ships (both of which affect AI behavior in various ways).

For example, in Solaris, Darius wants a way a way to allow players to only target bombs, while still allowing ships to be classified as as 'bomber'. In this case, the 'only bombs' option can be used. This PR adds a `$Behavior for pressing 'Target Hostile Bomb or Bomber' control:` to allow mods to set the behavior to `default` `only bombs` or `only bombers`.

For example, in FotG we want to allow players to target just bombers, as bombs themselves are hard to shoot down (critically though we still want the player to be able to manually target a bomb via 'target object in reticle'. This allows players to prioritize and easily target bombers while allowing skilled pilots to retain the option of manually shooting down bombs if they want an extra challenge. In this case the 'only bomber' option can be used.

Tested and works as expected in all cases.

* update using cleaned up function

* extra alt option for default case

* warning cleanup

* update default message

* whitespace clang

* appease clang with brackets

Author: wookieejedi

code/hud/hudconfig.cpp

@@ -1026,7 +1026,7 @@ void hud_config_handle_keypresses(int k)
 {
 	switch(k) {
 	case KEY_ESC:
-		if (escape_key_behavior_in_options == EscapeKeyBehaviorInOptions::SAVE) {
+		if (Escape_key_behavior_in_options == EscapeKeyBehaviorInOptions::SAVE) {
 			hud_config_commit();
 		} else {
 			hud_config_cancel();

code/hud/hudtarget.cpp

@@ -1570,11 +1570,11 @@ void hud_target_hostile_bomb_or_bomber(object* source_obj, int next_flag, bool t
 			} else {
 				// cycle with wraparound
 				int next_index;
-				int num_candiates = static_cast<int>(candidates.size());
+				int num_candidates = static_cast<int>(candidates.size());
 				if (next_flag > 0) {
-					next_index = (current_target_index + 1) % num_candiates;
+					next_index = (current_target_index + 1) % num_candidates;
 				} else {
-					next_index = (current_target_index - 1 + num_candiates) % num_candiates;
+					next_index = (current_target_index - 1 + num_candidates) % num_candidates;
 				}
 				target_to_set = candidates[next_index];
 			}

code/io/keycontrol.cpp

@@ -2718,62 +2718,74 @@ int button_function(int n)
 	}
 
 	keyHasBeenUsed = TRUE;
-	switch(n) {
-		// undefined in multiplayer for clients right now
-		// match target speed
-		case MATCH_TARGET_SPEED:
-			// If player is auto-matching, break auto-match speed
-			if ( Player->flags & PLAYER_FLAGS_AUTO_MATCH_SPEED ) {
-				Player->flags &= ~PLAYER_FLAGS_AUTO_MATCH_SPEED;
-			}
-			player_match_target_speed();
-			break;
-
-		// toggle auto-targeting
-		case TOGGLE_AUTO_TARGETING:
-			hud_gauge_popup_start(HUD_AUTO_TARGET);
-			Players[Player_num].flags ^= PLAYER_FLAGS_AUTO_TARGETING;
-			if ( Players[Player_num].flags & PLAYER_FLAGS_AUTO_TARGETING ) {
-				if (hud_sensors_ok(Player_ship)) {
-					hud_target_closest(iff_get_attackee_mask(Player_ship->team), -1, FALSE, TRUE );
-					snd_play(gamesnd_get_game_sound(GameSounds::SHIELD_XFER_OK), 1.0f);
-					//HUD_sourced_printf(HUD_SOURCE_HIDDEN, XSTR( "Auto targeting activated", -1));
-				} else {
-					Players[Player_num].flags ^= PLAYER_FLAGS_AUTO_TARGETING;
-				}
-			} else {
+	switch (n) {
+	// undefined in multiplayer for clients right now
+	// match target speed
+	case MATCH_TARGET_SPEED:
+		// If player is auto-matching, break auto-match speed
+		if (Player->flags & PLAYER_FLAGS_AUTO_MATCH_SPEED) {
+			Player->flags &= ~PLAYER_FLAGS_AUTO_MATCH_SPEED;
+		}
+		player_match_target_speed();
+		break;
+
+	// toggle auto-targeting
+	case TOGGLE_AUTO_TARGETING:
+		hud_gauge_popup_start(HUD_AUTO_TARGET);
+		Players[Player_num].flags ^= PLAYER_FLAGS_AUTO_TARGETING;
+		if (Players[Player_num].flags & PLAYER_FLAGS_AUTO_TARGETING) {
+			if (hud_sensors_ok(Player_ship)) {
+				hud_target_closest(iff_get_attackee_mask(Player_ship->team), -1, FALSE, TRUE);
 				snd_play(gamesnd_get_game_sound(GameSounds::SHIELD_XFER_OK), 1.0f);
-				//HUD_sourced_printf(HUD_SOURCE_HIDDEN, XSTR( "Auto targeting deactivated", -1));
+				// HUD_sourced_printf(HUD_SOURCE_HIDDEN, XSTR( "Auto targeting activated", -1));
+			} else {
+				Players[Player_num].flags ^= PLAYER_FLAGS_AUTO_TARGETING;
 			}
-			break;
+		} else {
+			snd_play(gamesnd_get_game_sound(GameSounds::SHIELD_XFER_OK), 1.0f);
+			// HUD_sourced_printf(HUD_SOURCE_HIDDEN, XSTR( "Auto targeting deactivated", -1));
+		}
+		break;
 
-		// target the closest repair ship
-		case TARGET_CLOSEST_REPAIR_SHIP:
-			// AL: Try to find the closest repair ship coming to repair the player... if no support
-			//		 ships are coming to rearm the player, just try for the closest repair ship
-			if ( hud_target_closest_repair_ship(OBJ_INDEX(Player_obj)) == 0 ) {
-				if ( hud_target_closest_repair_ship() == 0 ) {
-					snd_play(gamesnd_get_game_sound(GameSounds::TARGET_FAIL));
-				}
+	// target the closest repair ship
+	case TARGET_CLOSEST_REPAIR_SHIP:
+		// AL: Try to find the closest repair ship coming to repair the player... if no support
+		//		 ships are coming to rearm the player, just try for the closest repair ship
+		if (hud_target_closest_repair_ship(OBJ_INDEX(Player_obj)) == 0) {
+			if (hud_target_closest_repair_ship() == 0) {
+				snd_play(gamesnd_get_game_sound(GameSounds::TARGET_FAIL));
 			}
-			break;
+		}
+		break;
 
-		// stop targeting ship
-		case STOP_TARGETING_SHIP:
-			hud_cease_targeting(true);
-			break;
+	// stop targeting ship
+	case STOP_TARGETING_SHIP:
+		hud_cease_targeting(true);
+		break;
 
-		// stop targeting subsystems on ship
-		case STOP_TARGETING_SUBSYSTEM:
-			hud_cease_subsystem_targeting();
-			break;
-			
-		case TARGET_NEXT_BOMB:
-			hud_target_hostile_bomb_or_bomber(Player_obj, 1, true, true, false);
-			break;
+	// stop targeting subsystems on ship
+	case STOP_TARGETING_SUBSYSTEM:
+		hud_cease_subsystem_targeting();
+		break;
 
-		case TARGET_PREV_BOMB:
-			hud_target_hostile_bomb_or_bomber(Player_obj, 0, true, true, false);
+	case TARGET_NEXT_BOMB: 
+	{
+		bool target_bomb = ((Target_bomb_or_bomber_behavior == TargetBomborBomberBehaviorOptions::BOMBS_AND_BOMBERS) ||
+							(Target_bomb_or_bomber_behavior == TargetBomborBomberBehaviorOptions::ONLY_BOMBS));
+		bool target_bomber = ((Target_bomb_or_bomber_behavior == TargetBomborBomberBehaviorOptions::BOMBS_AND_BOMBERS) ||
+				(Target_bomb_or_bomber_behavior == TargetBomborBomberBehaviorOptions::ONLY_BOMBERS));
+		hud_target_hostile_bomb_or_bomber(Player_obj, 1, target_bomb, target_bomber, Target_bomb_or_bomber_use_distance);
+	} 
+		 break;
+
+	case TARGET_PREV_BOMB: 
+	{
+		bool target_bomb = ((Target_bomb_or_bomber_behavior == TargetBomborBomberBehaviorOptions::BOMBS_AND_BOMBERS) ||
+							(Target_bomb_or_bomber_behavior == TargetBomborBomberBehaviorOptions::ONLY_BOMBS));
+		bool target_bomber = ((Target_bomb_or_bomber_behavior == TargetBomborBomberBehaviorOptions::BOMBS_AND_BOMBERS) ||
+				(Target_bomb_or_bomber_behavior == TargetBomborBomberBehaviorOptions::ONLY_BOMBERS));
+		hud_target_hostile_bomb_or_bomber(Player_obj, 0, target_bomb, target_bomber, Target_bomb_or_bomber_use_distance);
+	}
 			break;
 
 		// wingman message: attack current target

code/menuui/optionsmenu.cpp

@@ -1281,7 +1281,7 @@ void options_menu_do_frame(float  /*frametime*/)
 			break;
 
 		case KEY_ESC:
-			if (escape_key_behavior_in_options == EscapeKeyBehaviorInOptions::SAVE) {
+			if (Escape_key_behavior_in_options == EscapeKeyBehaviorInOptions::SAVE) {
 				options_accept();
 				gamesnd_play_iface(InterfaceSounds::COMMIT_PRESSED);
 				gameseq_post_event(GS_EVENT_PREVIOUS_STATE);

code/mod_table/mod_table.cpp

@@ -173,7 +173,9 @@ bool Hide_main_rearm_items_in_comms_gauge;
 bool Fix_scripted_velocity;
 color Overhead_line_colors[MAX_SHIP_SECONDARY_BANKS];
 bool Preload_briefing_icon_models;
-EscapeKeyBehaviorInOptions escape_key_behavior_in_options;
+EscapeKeyBehaviorInOptions Escape_key_behavior_in_options;
+bool Target_bomb_or_bomber_use_distance;
+TargetBomborBomberBehaviorOptions Target_bomb_or_bomber_behavior;
 bool Fix_asteroid_bounding_box_check;
 bool Disable_intro_movie;
 bool Show_locked_status_scramble_missions;
@@ -1564,16 +1566,44 @@ void parse_mod_table(const char *filename)
 
 				if (temp == "default")
 				{
-					escape_key_behavior_in_options = EscapeKeyBehaviorInOptions::DEFAULT;
+					Escape_key_behavior_in_options = EscapeKeyBehaviorInOptions::DEFAULT;
 				}
 				else if (temp == "save")
 				{
-					escape_key_behavior_in_options = EscapeKeyBehaviorInOptions::SAVE;
+					Escape_key_behavior_in_options = EscapeKeyBehaviorInOptions::SAVE;
 				}
 				else
 				{
 					Warning(LOCATION, "$Behavior for pressing Escape key in options menu: Invalid selection. Must be value of 'default' or 'save'. Reverting to 'default' value.");
-					escape_key_behavior_in_options = EscapeKeyBehaviorInOptions::DEFAULT;
+					Escape_key_behavior_in_options = EscapeKeyBehaviorInOptions::DEFAULT;
+				}
+			}
+
+			if (optional_string("$Use closest distance method for 'Target Hostile Bomb or Bomber' control:")) {
+				stuff_boolean(&Target_bomb_or_bomber_use_distance);
+			}
+
+			if (optional_string("$Objects targeted with 'Target Hostile Bomb or Bomber' control:")) {
+				SCP_string temp;
+				stuff_string(temp, F_RAW);
+				SCP_tolower(temp);
+
+				if (temp == "default" || temp == "bombs and bombers")
+				{
+					Target_bomb_or_bomber_behavior = TargetBomborBomberBehaviorOptions::BOMBS_AND_BOMBERS;
+				}
+				else if (temp == "only bombs")
+				{
+					Target_bomb_or_bomber_behavior = TargetBomborBomberBehaviorOptions::ONLY_BOMBS;
+				}
+				else if (temp == "only bombers")
+				{
+					Target_bomb_or_bomber_behavior = TargetBomborBomberBehaviorOptions::ONLY_BOMBERS;
+				}
+				else
+				{
+					Warning(LOCATION, "$Objects targeted with 'Target Hostile Bomb or Bomber' control: Invalid selection. Must be value of 'default' or 'bombs and bombers' or 'only bombs' or 'only bombers'. Reverting to 'bombs and bombers' value.");
+					Target_bomb_or_bomber_behavior = TargetBomborBomberBehaviorOptions::BOMBS_AND_BOMBERS;
 				}
 			}
 
@@ -1845,7 +1875,9 @@ void mod_table_reset()
 	gr_init_alphacolor(&Overhead_line_colors[2], 175, 175, 175, 255);
 	gr_init_alphacolor(&Overhead_line_colors[3], 100, 100, 100, 255);
 	Preload_briefing_icon_models = false;
-	escape_key_behavior_in_options = EscapeKeyBehaviorInOptions::DEFAULT;
+	Escape_key_behavior_in_options = EscapeKeyBehaviorInOptions::DEFAULT;
+	Target_bomb_or_bomber_use_distance = false;
+	Target_bomb_or_bomber_behavior = TargetBomborBomberBehaviorOptions::BOMBS_AND_BOMBERS;
 	Fix_asteroid_bounding_box_check = false;
 	Disable_intro_movie = false;
 	Show_locked_status_scramble_missions = false;

code/mod_table/mod_table.h

@@ -26,6 +26,13 @@ typedef enum {
 	SAVE
 } EscapeKeyBehaviorInOptions;
 
+// Typedef for 'Target Hostile Bomb or Bomber' control behavior --wookieejedi
+typedef enum {
+	BOMBS_AND_BOMBERS,
+	ONLY_BOMBS,
+	ONLY_BOMBERS
+} TargetBomborBomberBehaviorOptions;
+
 // And one for splash screens
 struct splash_screen {
 	SCP_string filename;
@@ -188,7 +195,9 @@ extern bool Hide_main_rearm_items_in_comms_gauge;
 extern bool Fix_scripted_velocity;
 extern color Overhead_line_colors[MAX_SHIP_SECONDARY_BANKS];
 extern bool Preload_briefing_icon_models;
-extern EscapeKeyBehaviorInOptions escape_key_behavior_in_options;
+extern EscapeKeyBehaviorInOptions Escape_key_behavior_in_options;
+extern bool Target_bomb_or_bomber_use_distance;
+extern TargetBomborBomberBehaviorOptions Target_bomb_or_bomber_behavior;
 extern bool Fix_asteroid_bounding_box_check;
 extern bool Disable_intro_movie;
 extern bool Show_locked_status_scramble_missions;