Merge pull request #6630 from Goober5000/form_on_wing_and_stay_still_updates

form-on-wing and stay-still updates

Author: Goober5000

code/ai/ai_flags.h

@@ -44,12 +44,15 @@ namespace AI {
 		Goal_on_hold,		// when set, this goal cannot currently be satisfied, although it could be in the future
 		Subsys_needs_fixup,	// when set, the subsystem index (for a destroy subsystem goal) is invalid and must be gotten from the subsys name stored in docker.name field!!
 		Goal_override,		// paired with ai_goal_type::DYNAMIC to mean this goal overrides any other goal
+		Want_override,		// a goal should set this flag if Goal_override should be assigned when the goal is achievable
 		Purge,				// purge this goal next time we process
-		Goals_purged,		// this goal has already caused other goals to get purged
+		Purge_when_new_goal_added,	// this goal is perpetual until any other goal is added, at which time it sets its own Purge flag
+		Goals_purged,		// this goal has already caused other goals to get purged (because it is something like ai-disarm that renders other goals invalid)
 		Depart_sound_played,// Goober5000 - replacement for AL's hack ;)
 		Target_own_team,	// this attack goal is allowed to target friendlies
 		Afterburn_hard,		// afterburn as hard as possible to the goal
 		Waypoints_in_reverse,	// decrement instead of increment
+		Clear_all_goals_first,	// this goal wipes all goals (including itself) before it runs (handled separately, and in a different place, from purging invalid goals)
 
 		NUM_VALUES
 	};
@@ -181,6 +184,10 @@ namespace AI {
 		ETS_uses_power_output,
 		ETS_energy_same_regardless_of_system_presence,
 		Dont_form_on_wing_at_mission_start,
+		Do_not_clear_goals_when_running_form_on_wing,
+		Do_not_clear_goals_when_running_stay_still,
+		Do_not_set_override_when_assigning_form_on_wing,
+		Purge_player_issued_form_on_wing_after_subsequent_order,
 
 		NUM_VALUES
 	};

code/ai/ai_profiles.cpp

@@ -721,6 +721,24 @@ void parse_ai_profiles_tbl(const char *filename)
 
 				set_flag(profile, "$don't issue form-on-wing goals at mission start:", AI::Profile_Flags::Dont_form_on_wing_at_mission_start);
 
+				if (optional_string("$default form-on-wing priority:")) {
+					int priority;
+					stuff_int(&priority);
+					if (priority > 0) {
+						profile->default_form_on_wing_priority = priority;
+					} else {
+						mprintf(("Warning: $default form-on-wing priority: should be > 0 (read %d).  Value will not be used.\n", priority));
+					}
+				}
+
+				set_flag(profile, "$do not clear goals when running form-on-wing:", AI::Profile_Flags::Do_not_clear_goals_when_running_form_on_wing);
+
+				set_flag(profile, "$do not clear goals when running stay-still:", AI::Profile_Flags::Do_not_clear_goals_when_running_stay_still);
+
+				set_flag(profile, "$do not set override when assigning form-on-wing:", AI::Profile_Flags::Do_not_set_override_when_assigning_form_on_wing);
+
+				set_flag(profile, "$purge player-issued form-on-wing after subsequent order:", AI::Profile_Flags::Purge_player_issued_form_on_wing_after_subsequent_order);
+
 
 				// end of options ----------------------------------------
 
@@ -825,6 +843,8 @@ void ai_profile_t::reset()
 	guard_big_orbit_max_speed_percent = 1.0f;
 	attack_any_idle_circle_distance = 100.0f;
 
+	default_form_on_wing_priority = 99;	// as originally assigned in ai_add_goal_sub_sexp()
+
     for (int i = 0; i < NUM_SKILL_LEVELS; ++i) {
         max_incoming_asteroids[i] = 0;
         max_allowed_player_homers[i] = 0;
@@ -938,5 +958,6 @@ void ai_profile_t::reset()
 	}
 	if (mod_supports_version(25, 0, 0)) {
 		flags.set(AI::Profile_Flags::Fix_avoid_shockwave_bugs);
+		flags.set(AI::Profile_Flags::Purge_player_issued_form_on_wing_after_subsequent_order);
 	}
 }

code/ai/ai_profiles.h

@@ -147,6 +147,8 @@ class ai_profile_t {
 	// AI attack any option --wookieejedi
 	float attack_any_idle_circle_distance; // Radius that AI circles around a point while waiting for new enemies in attack-any mode
 
+	int default_form_on_wing_priority;	// the priority used if not specified in the sexp
+
     void reset();
 };
 

code/ai/aicode.cpp

@@ -3677,6 +3677,14 @@ void ai_form_on_wing(object *objp, object *goal_objp)
 	aip->ai_flags.remove(AI::AI_Flags::Formation_wing);
 	aip->ai_flags.set(AI::AI_Flags::Formation_object);
 
+	// if this goal is going to stick around for a while, change the mode
+	if (The_mission.ai_profile->flags[AI::Profile_Flags::Do_not_clear_goals_when_running_form_on_wing])
+	{
+		aip->mode = AIM_NONE;
+		aip->submode = -1;
+		aip->submode_start_time = Missiontime;
+	}
+
 	aip->goal_objnum = OBJ_INDEX(goal_objp);
 
 	ai_formation_object_recalculate_slotnums(aip->goal_objnum);