Preliminary cleanup of goal code. Remove AI_GOAL_PLACEHOLDER_1 since it is not needed; goals higher than AI_GOAL_NONE do not need to be a specific value.

Author: Goober5000

code/ai/aigoals.cpp

@@ -53,11 +53,11 @@ struct ship_registry_entry;
 // PURGE_GOALS_ONE_SHIP for goals which should only purge other goals in the one ship.
 // Goober5000 - note that the new disable and disarm goals (AI_GOAL_DISABLE_SHIP_TACTICAL and
 // AI_GOAL_DISARM_SHIP_TACTICAL) do not purge ANY goals, not even the ones in the one ship
-inline bool purge_goals_all_ships(ai_goal_mode ai_mode)
+[[nodiscard]] bool purge_goals_all_ships(ai_goal_mode ai_mode)
 {
 	return ai_mode == AI_GOAL_IGNORE || ai_mode == AI_GOAL_DISABLE_SHIP || ai_mode == AI_GOAL_DISARM_SHIP;
 }
-inline bool purge_goals_one_ship(ai_goal_mode ai_mode)
+[[nodiscard]] bool purge_goals_one_ship(ai_goal_mode ai_mode)
 {
 	return ai_mode == AI_GOAL_IGNORE_NEW;
 }
@@ -195,12 +195,10 @@ void ai_maybe_add_form_goal(wing* wingp)
 		return;
 	}
 
-	int j;
-
 	// iterate through the ship_index list of this wing and check for orders.  We will do
 	// this for all ships in the wing instead of on a wing only basis in case some ships
 	// in the wing actually have different orders than others
-	for (j = 0; j < wingp->current_count; j++) {
+	for (int j = 0; j < wingp->current_count; j++) {
 		ai_info* aip;
 
 		Assert(wingp->ship_index[j] != -1);						// get Allender
@@ -938,11 +936,9 @@ void ai_add_goal_sub_sexp( int sexp, ai_goal_type type, ai_info *aip, ai_goal *a
 		// for achievability.
 		aigp->target_name = ai_get_goal_target_name(CTEXT(CDR(node)), &aigp->target_name_index);  // waypoint path name;
 
-
 		aigp->priority = eval_num(CDDR(node), priority_is_nan, priority_is_nan_forever);
-		aigp->ai_mode = AI_GOAL_WAYPOINTS;
-		if ( op == OP_AI_WAYPOINTS_ONCE )
-			aigp->ai_mode = AI_GOAL_WAYPOINTS_ONCE;
+		aigp->ai_mode = (op == OP_AI_WAYPOINTS_ONCE) ? AI_GOAL_WAYPOINTS_ONCE : AI_GOAL_WAYPOINTS;
+
 		if (CDDDDR(node) < 0)
 			aigp->int_data = 0;	// handle optional node separately because we don't subtract 1 here
 		else
@@ -1042,13 +1038,9 @@ void ai_add_goal_sub_sexp( int sexp, ai_goal_type type, ai_info *aip, ai_goal *a
 		break;
 
 	case OP_AI_PLAY_DEAD:
-		aigp->priority = eval_num(CDR(node), priority_is_nan, priority_is_nan_forever);
-		aigp->ai_mode = AI_GOAL_PLAY_DEAD;
-		break;
-
 	case OP_AI_PLAY_DEAD_PERSISTENT:
 		aigp->priority = eval_num(CDR(node), priority_is_nan, priority_is_nan_forever);
-		aigp->ai_mode = AI_GOAL_PLAY_DEAD_PERSISTENT;
+		aigp->ai_mode = (op == OP_AI_PLAY_DEAD) ? AI_GOAL_PLAY_DEAD : AI_GOAL_PLAY_DEAD_PERSISTENT;
 		break;
 
 	case OP_AI_KEEP_SAFE_DISTANCE:
@@ -1295,12 +1287,9 @@ int ai_remove_goal_sexp_sub( int sexp, ai_goal* aigp, bool &remove_more )
 	/* We now need to determine what the mode and submode values are*/
 	switch( op )
 	{
-	case OP_AI_WAYPOINTS_ONCE:
-		goalmode = AI_GOAL_WAYPOINTS_ONCE;
-		priority = eval_priority_et_seq(CDDR(node));
-		break;
 	case OP_AI_WAYPOINTS:
-		goalmode = AI_GOAL_WAYPOINTS;
+	case OP_AI_WAYPOINTS_ONCE:
+		goalmode = (op == OP_AI_WAYPOINTS_ONCE) ? AI_GOAL_WAYPOINTS_ONCE : AI_GOAL_WAYPOINTS;
 		priority = eval_priority_et_seq(CDDR(node));
 		break;
 	case OP_AI_DESTROY_SUBSYS:
@@ -2548,16 +2537,14 @@ void ai_process_mission_orders( int objnum, ai_info *aip )
 		break;
 
 	case AI_GOAL_PLAY_DEAD:
-		// if a ship is playing dead, MWA says that it shouldn't try to do anything else.
-		// clearing out goals is okay here since we are now what mode to set this AI object to.
-		ai_clear_ship_goals( aip );
-		aip->mode = AIM_PLAY_DEAD;
-		aip->submode = -1;
-		aip->submode_start_time = Missiontime;
-		break;
-
 	case AI_GOAL_PLAY_DEAD_PERSISTENT:
-		// same as above, but we don't clear out ship goals
+		// we don't clear out ship goals for the "persistent" goal variant
+		if (current_goal->ai_mode == AI_GOAL_PLAY_DEAD)
+		{
+			// if a ship is playing dead, MWA says that it shouldn't try to do anything else.
+			// clearing out goals is okay here since we are now what mode to set this AI object to.
+			ai_clear_ship_goals(aip);
+		}
 		aip->mode = AIM_PLAY_DEAD;
 		aip->submode = -1;
 		aip->submode_start_time = Missiontime;

code/ai/aigoals.h

@@ -47,9 +47,8 @@ enum class ai_goal_type
 enum ai_goal_mode : uint8_t
 {
 	AI_GOAL_NONE = 0,
-	AI_GOAL_PLACEHOLDER_1,
 
-	AI_GOAL_CHASE,              // per the original #define list, AI_GOAL_CHASE started at 2 (1<<1)
+	AI_GOAL_CHASE,
 	AI_GOAL_DOCK,               // used for undocking as well
 	AI_GOAL_WAYPOINTS,
 	AI_GOAL_WAYPOINTS_ONCE,

code/parse/sexp.cpp

@@ -39811,9 +39811,9 @@ SCP_vector<sexp_help_struct> Sexp_help = {
 		"\t1:\tName of target to ignore.\r\n"
 		"\t2:\tGoal priority (number between 0 and 89) - note, this does not imply any ranking of ignored targets." },
 
-	{ OP_AI_STAY_STILL, "Ai-stay still (Ship goal)\r\n"
+	{ OP_AI_STAY_STILL, "Ai-stay-still (Ship goal)\r\n"
 		"\tCauses the specified ship to stay still.  The ship will do nothing until attacked at "
-		"which time the ship will come to life and defend itself.\r\n\r\n"
+		"which time the ship will come to life and defend itself.  All other goals specified for the ship will be cleared.\r\n\r\n"
 		"Takes 2 arguments...\r\n"
 		"\t1:\tShip or waypoint the ship staying still will directly face (currently not implemented)\r\n"
 		"\t2:\tGoal priority (number between 0 and 89)." },
@@ -39841,7 +39841,7 @@ SCP_vector<sexp_help_struct> Sexp_help = {
 
 	{ OP_AI_FORM_ON_WING, "Ai-form-on-wing (Ship Goal)\r\n"
 		"\tCauses the ship to form on the specified ship's wing. This works analogous to the "
-		"player order, and will cause all other goals specified for the ship to be purged.\r\n\r\n"
+		"player order, and will cause all other goals specified for the ship to be cleared.\r\n\r\n"
 		"Takes 1 argument...\r\n"
 		"\t1:\tShip to form on." },
 

code/scripting/api/objs/order.cpp

@@ -91,7 +91,6 @@ ADE_FUNC(getType, l_Order, NULL, "Gets the type of the order.", "enumeration", "
 
 	switch(ohp->aigp->ai_mode){
 		case AI_GOAL_NONE:
-		case AI_GOAL_PLACEHOLDER_1:
 		case AI_GOAL_NUM_VALUES:
 			break;
 		case AI_GOAL_DESTROY_SUBSYSTEM:
@@ -223,8 +222,8 @@ ADE_VIRTVAR(Target, l_Order, "object", "Target of the order. Value may also be a
 				case AI_GOAL_DISABLE_SHIP_TACTICAL:
 				case AI_GOAL_DISARM_SHIP:
 				case AI_GOAL_DISARM_SHIP_TACTICAL:
-				case AI_GOAL_IGNORE_NEW:
 				case AI_GOAL_IGNORE:
+				case AI_GOAL_IGNORE_NEW:
 				case AI_GOAL_EVADE_SHIP:
 				case AI_GOAL_STAY_NEAR_SHIP:
 				case AI_GOAL_KEEP_SAFE_DISTANCE:
@@ -318,8 +317,8 @@ ADE_VIRTVAR(Target, l_Order, "object", "Target of the order. Value may also be a
 		case AI_GOAL_DISABLE_SHIP_TACTICAL:
 		case AI_GOAL_DISARM_SHIP:
 		case AI_GOAL_DISARM_SHIP_TACTICAL:
-		case AI_GOAL_IGNORE_NEW:
 		case AI_GOAL_IGNORE:
+		case AI_GOAL_IGNORE_NEW:
 		case AI_GOAL_EVADE_SHIP:
 		case AI_GOAL_STAY_NEAR_SHIP:
 		case AI_GOAL_KEEP_SAFE_DISTANCE:

code/scripting/api/objs/ship.cpp

@@ -1641,7 +1641,7 @@ ADE_FUNC(giveOrder, l_Ship, "enumeration Order, [object Target=nil, subsystem Ta
 		{
 			if(tgh_valid && tgh->objp()->type == OBJ_WAYPOINT)
 			{
-				ai_mode = eh->index == LE_ORDER_WAYPOINTS_ONCE ? AI_GOAL_WAYPOINTS_ONCE : AI_GOAL_WAYPOINTS;
+				ai_mode = (eh->index == LE_ORDER_WAYPOINTS_ONCE) ? AI_GOAL_WAYPOINTS_ONCE : AI_GOAL_WAYPOINTS;
 				int wp_list_index, wp_index;
 				calc_waypoint_indexes(tgh->objp()->instance, wp_list_index, wp_index);
 				if (wp_list_index >= 0 && wp_index >= 0)