2 * Copyright (C) Volition, Inc. 1999. All rights reserved.
4 * All source code herein is the property of Volition, Inc. You may not sell
5 * or otherwise commercially exploit the source or things you created based on
10 * $Logfile: /Freespace2/code/Ship/AiGoals.cpp $
15 * File to deal with manipulating AI goals, etc.
18 * Revision 1.6 2006/04/26 19:46:52 taylor
19 * address a Windows qsort() issue that Volition got around before, this will correct numerous mission bugs due to goal sorting for non-Windows systems
21 * Revision 1.5 2003/08/03 16:10:30 taylor
22 * cleanup; compile warning fixes
24 * Revision 1.4 2002/06/09 04:41:26 relnev
25 * added copyright header
27 * Revision 1.3 2002/05/26 22:06:17 relnev
28 * makefile: disable stand_gui for now.
30 * rest: staticize some globals
32 * Revision 1.2 2002/05/07 03:16:52 theoddone33
33 * The Great Newline Fix
35 * Revision 1.1.1.1 2002/05/03 03:28:10 root
39 * 12 7/19/99 12:02p Andsager
40 * Allow AWACS on any ship subsystem. Fix sexp_set_subsystem_strength to
41 * only blow up subsystem if its strength is > 0
43 * 11 7/09/99 5:54p Dave
44 * Seperated cruiser types into individual types. Added tons of new
45 * briefing icons. Campaign screen.
47 * 10 7/07/99 2:55p Andsager
48 * fix ai_get_subsystem_type to recognize "radara" as an awacs type
49 * subsystem as model_read.
51 * 9 6/03/99 8:58p Andsager
52 * Fix bug where player's target is lost. Alpha wing had clear wing
53 * goals, and this was applied to alpha1.
55 * 8 5/27/99 12:14p Andsager
56 * Some fixes for live debris when more than one subsys on ship with live
57 * debris. Set subsys strength (when 0) blows off subsystem.
58 * sexp_hits_left_subsystem works for SUBSYSTEM_UNKNOWN.
60 * 7 4/23/99 12:01p Johnson
63 * 6 3/26/99 4:49p Dave
64 * Made cruisers able to dock with stuff. Made docking points and paths
67 * 5 1/07/99 1:52p Andsager
68 * Initial check in of Sexp_variables
70 * 4 12/23/98 2:53p Andsager
71 * Added ship activation and gas collection subsystems, removed bridge
73 * 3 11/05/98 5:55p Dave
74 * Big pass at reducing #includes
76 * 2 10/07/98 10:53a Dave
79 * 1 10/07/98 10:51a Dave
81 * 173 6/09/98 10:31a Hoffoss
82 * Created index numbers for all xstr() references. Any new xstr() stuff
83 * added from here on out should be added to the end if the list. The
84 * current list count can be found in FreeSpace.cpp (search for
87 * 172 6/01/98 11:43a John
88 * JAS & MK: Classified all strings for localization.
90 * 171 5/21/98 9:57a Mike
91 * Massively improve firing of bombs at big ships. Improve willingness to
92 * take incoming fire to deliver bomb. Make a little easier to gain
95 * 170 5/12/98 10:06a Mike
96 * Fix a jillion bugs preventing ships from firing bombs at Lucifer in
99 * 169 5/11/98 11:20a Sandeep
101 * 168 5/10/98 12:02a Mike
102 * Only Alpha wing will form on player's wing, not any player wing.
104 * 167 4/23/98 1:49a Allender
105 * major rearm/repair fixes for multiplayer. Fixed respawning of AI ships
106 * to not respawn until 5 seconds after they die. Send escort information
109 * 166 4/23/98 12:31a Mike
110 * Fix the sm1-04a Comet:Omega bug. Was putting a goal on hold if a ship
111 * was docked, but should only have done that if not docked with self.
113 * 165 4/22/98 5:00p Allender
114 * new multiplayer dead popup. big changes to the comm menu system for *
115 * team vs. team. Start of debriefing stuff for team vs. team Make form
116 * on my wing work with individual ships who have high priority
119 * 164 4/18/98 9:53p Mike
120 * Add debug code to track down Comet warpout problems in sm1-04a, then
121 * comment it out for checkin.
123 * 163 4/09/98 12:36p Allender
124 * nasty repair problems fixed when ordering it to warp out while
125 * repairing (and on way) and when aborting process while he's completing
128 * 162 3/31/98 5:19p John
129 * Removed demo/save/restore. Made NDEBUG defined compile. Removed a
130 * bunch of debug stuff out of player file. Made model code be able to
131 * unload models and malloc out only however many models are needed.
134 * 161 3/19/98 4:43p Allender
135 * allow player ships to follow certain orders
137 * 160 3/19/98 2:55p Allender
138 * when ship gets disabled, have him put dock goals on hold
140 * 159 3/09/98 9:35p Mike
141 * Suppress warning messages.
143 * 158 3/09/98 5:12p Mike
144 * Make sure Pl_objp uses are valid.
145 * Throw asteroids at ships in asteroid field, not "Gal"
146 * Support ships warp out if no goals after 30 seconds.
148 * 157 3/07/98 3:50p Lawrance
149 * Add lead indicator for asteroids
151 * 156 3/06/98 2:58p Allender
152 * moved assert to more appropriate place
154 * 155 3/06/98 11:55a Lawrance
155 * Don't process mission orders for player ships
157 * 154 3/05/98 9:35a Allender
158 * don't allow ships to be repaired when departing or dying
160 * 153 2/26/98 10:08p Hoffoss
161 * Rewrote state saving and restoring to fix bugs and simplify the code.
163 * 152 2/23/98 8:59p Allender
164 * fixed two docking bugs: 1) don't move cargo when ship it's docked with
165 * is undocking. 2) aigoal code was clearing dock goals when it shouldn't
168 * 151 2/22/98 4:17p John
169 * More string externalization classification... 190 left to go!
171 * 150 2/19/98 12:04a Allender
172 * more multiplayer rearm/dock stuff. Fix bug in HUD code when finding
173 * support ship reaming player. show repair as order on Hud extended
176 * 149 2/18/98 10:34p Allender
177 * repair/rearm system (for single and multi) about finished.
178 * dock/undock and ai goals packets implemented for multiplayer
180 * 148 2/16/98 10:13p Allender
181 * initial work on being able to target weapons (bombs specifically).
182 * Work on getting rearm/repair working under multiplayer
184 * 147 2/16/98 4:07p Sandeep
185 * fixed a bug with deleting waypoints
187 * 146 2/16/98 3:43p Sandeep
188 * Fixed bug with Ai_warp still expected to have an object reference in a
191 * 145 2/13/98 3:21p Lawrance
192 * Set up allowed goals for escape pods.
194 * 144 2/13/98 2:57p Allender
195 * correct code using unitialized variable
197 * 143 2/09/98 10:46a Allender
198 * fixed bug with docking where multiple orders to dock with same object
201 * 142 2/05/98 12:52p Jim
202 * fix race conditions to get to subsystem index for attacking subsystem
205 * 141 2/02/98 4:02p Mike
206 * Allender: Fix bug which caused ships to sometimes undock just as they
209 * 140 1/30/98 11:00a Allender
210 * tidied up the code to get an index for a new goal. Made all code (for
211 * both ships and wings) go through this function.
213 * 139 1/30/98 10:01a Allender
214 * made large ships able to attack other ships. Made goal code recognize
215 * when ships removed from wings during ship select
217 * 138 1/29/98 12:14p Lawrance
218 * show 'waypoints' as a mission order.
220 * 137 1/20/98 9:33a Allender
221 * fixed bug with wing goals from players
223 * 136 1/16/98 1:11p Sandeep
224 * fix bug when trying to purge goals with no ship_name
226 * 135 1/16/98 11:43a Allender
227 * made it so certain orders (see PURGE_ORDERS) cause other ai goals to
228 * get purged. This step it to help the AI do the right thing.
230 * 134 1/16/98 11:33a Mike
231 * Fix bug in targeting subsystems on protected ships.
233 * 133 1/13/98 5:36p Lawrance
234 * Change Ai_goal_text[] to not return anything for waypoints.
236 * 132 1/05/98 10:10p Mike
237 * Comment out an obsolete function (discovered while searching for
240 * 131 1/02/98 1:55p Duncan
241 * added back in case for undocking when checking for goal complete status
243 * 130 12/30/97 4:48p Allender
244 * work with ignore my target command. Added new keyboard hotkey. Made
247 * 129 12/26/97 12:15p Mike
248 * Put in debug code for tracking down ships disabling, rather than
249 * destroying, enemies.
251 * 128 12/15/97 5:25p Allender
252 * fix problem with docked ships receiving another dock goal. They now
255 * 127 12/12/97 5:21p Lawrance
256 * fix some problems with ai mode changing when arriving/departing from
259 * 126 12/04/97 12:24p Allender
260 * made support ship orders other than rearm be super low priority.
261 * Support ship orders now won't get removed incorrectly either
263 * 125 11/26/97 9:55a Allender
264 * minor changed to comm window for rearming. Fixed some repair bugs --
265 * player's repair was getting aborted by code when he was hit. Repair
266 * ship wasn't properly removing repair goals
268 * 124 11/23/97 6:21p Lawrance
269 * update goal text, used on HUD
271 * 123 11/17/97 6:39p Lawrance
272 * add AI_goal_text[] array, used by HUD code to show text description of
275 * 122 11/09/97 2:21p Mike
276 * Comment out Int3() and email Mark about it.
278 * 121 11/05/97 9:30p Mike
279 * Add play dead mode.
280 * Enable undock to complete when dockee moves.
281 * Make ships in waypoint mode react to enemy fire.
282 * Support ships not form on player's wing.
284 * 120 11/05/97 4:43p Allender
285 * reworked medal/rank system to read all data from tables. Made Fred
286 * read medals.tbl. Changed ai-warp to ai-warp-out which doesn't require
287 * waypoint for activation
289 * 119 10/31/97 4:03p Allender
290 * test code to help find rearm/repair problems
292 * 118 10/29/97 10:02p Allender
293 * be sure that player starting wings that arrive late also form on the
294 * players wing if there are no goals
296 * 117 10/29/97 9:32p Allender
297 * remove undock goal if we can't find docked sihp when docker trying to
298 * undock. Could be that docked ship was destroyed
300 * 116 10/29/97 3:41p Sandeep
301 * Allender put in dock debug code
303 * 115 10/28/97 10:30a Allender
304 * rest AIF_FORMATION_OBJECT bit when new order is given to a ship
306 * 114 10/24/97 10:40a Allender
307 * player wings with no initial orders now form on players wing by
310 * 113 10/23/97 4:41p Allender
311 * lots of new rearm/repair code. Rearm requests now queue as goals for
312 * support ship. Warp in of new support ships functional. Support for
313 * stay-still and play-dead.
315 * 112 10/23/97 4:12p Mike
316 * Support for AIM_STAY_NEAR.
318 * 111 10/22/97 1:46p Allender
319 * get ship_name field for ai-stay-still
321 * 110 10/22/97 1:44p Allender
322 * more work on stay-still and play-dead
324 * 109 10/22/97 11:07a Allender
325 * Hooked in form on my wing into Mikes AI code
327 * 108 10/22/97 1:03a Mike
330 * fix mysterious code in find_enemy that used goal_objnum instead of
333 * 107 10/12/97 11:23p Mike
334 * About ten fixes/changes in the docking system.
335 * Also, renamed SIF_REARM_REPAIR to SIF_SUPPORT.
337 * 106 10/10/97 5:03p Allender
338 * started work on ai-stay-still
340 * 105 9/24/97 4:51p Allender
341 * got rid pf default_player_ship_name variable.
343 * 104 9/23/97 4:35p Allender
344 * added two function to add "internal" goals to ships and wings. Used by
345 * AI when it needs to do something special
347 * 103 9/09/97 2:42p Allender
348 * fix bug where guarding a wing that hasn't arrived caused goal code to
351 * 102 9/09/97 11:28a Johnson
352 * Fixed bug: Code is not Fred-aware.
354 * 101 9/08/97 1:04p Allender
355 * put code in ai_post_process_mission() to set orders for ships before
356 * mission starts. Prevents ships from following orders N seconds after
357 * mission actually starts
359 * 100 9/05/97 5:05p Lawrance
360 * memset string to 0 during restore for safety
362 * 99 8/18/97 1:16p Allender
363 * added ignore goal into sexpressions
365 * 98 8/16/97 3:09p Mike
366 * If telling a ship to attack a protected ship, unprotect that ship.
368 * 97 8/16/97 2:40p Mike
369 * Move unmoving ship if it's attacking a large ship and it sees incoming
371 * Also, don't set protected bit in a ship if someone has attacked a
372 * subsystem. Only do if someone was told to disarm or disable.
374 * 96 8/15/97 11:50a Duncan
375 * Fixed bug with ai functions assuming ai_goal_undock takes a ship
376 * target, which it doesn't.
378 * 95 8/15/97 10:05a Hoffoss
379 * One more change to ai_query_goal_valid() to allow for AI_GOAL_NONE.
381 * 94 8/15/97 9:59a Hoffoss
382 * Changed ai_query_goal_valid() again. I can't think of any time you
383 * wouldn't find it easier just to pass in a ship instead of a ship_info
384 * flag structure filtered of all flags that aren't ship type bits. Since
385 * I'll call this quite a few times, it will make my life easier.
387 * 93 8/15/97 9:49a Hoffoss
388 * Changed ai_query_goal_valid() slightly for Fred. Fred can be more
389 * detailed with error messages should these situations happen, and
390 * recover from them better.
392 * 92 8/14/97 10:00p Allender
393 * made ai goals bitfields so that we can have set of orders that certain
394 * ship types are allowed to receive. Added function for Hoffoss to check
395 * goal vs. ship type validity
397 * 91 8/12/97 9:58a Hoffoss
398 * Fixed ai_update_goal_references() and query_referended_in_ai_goals().
400 * 90 8/12/97 8:01a Allender
401 * when adding goals to wing structures, replace the oldest entry of the
402 * goals if there are no empty entries
404 * 89 8/12/97 1:55a Hoffoss
405 * Made extensive changes to object reference checking and handling for
406 * object deletion call.
408 * 88 8/10/97 4:24p Hoffoss
409 * Made initial orders revert back to none if it has invalid data
412 * 87 8/08/97 1:30p Allender
413 * added commands (and ai goals) for support ships. stay near ship (which
414 * could be player or current target), and keep safe distance
416 * 86 8/07/97 11:11a Allender
417 * fixed problem with wings completing waypoint goals
419 * 85 8/06/97 9:41a Allender
420 * renamed from ai_goal function. made a function to remove a goal from a
421 * wing (used strictly for waypoints now). ai-chase-wing and
422 * ai-guard-wing now appear to user as ai-chase and ai-guard. Tidied up
423 * function which deals with sexpression goals
425 * 84 8/06/97 8:06a Lawrance
426 * add more stuff to save/restore
428 * 83 8/01/97 11:51a Dave
429 * Changed calls to timer_get_fixed_seconds() to simply Missiontime.
430 * Solves a lot of demo related problems.
432 * 82 7/30/97 11:01p Mike
433 * Set submode when setting mode from player order.
434 * Increase distance to circle when ignoring player's target.
436 * 81 7/28/97 10:28a Mike
437 * Use forward_interpolate() to prevent weird banking behavior.
439 * Suppress a couple annoying mprints and clarify another.
441 * 80 7/25/97 12:10p Mike
442 * Better default behavior.
444 * 79 7/24/97 4:55p Allender
445 * added ai-evade-ship to fred and to Freespace
447 * 78 7/24/97 4:20p Mike
448 * Add goal and Fred hook for evade behavior.
450 * 77 7/24/97 2:17p Jasen
451 * Fixed a bug with mission loading.
453 * 76 7/24/97 12:10a Mike
454 * Suppress problems when loadign pain.fsm.
456 * 75 7/23/97 6:49p Hoffoss
457 * Fixed bug in ai goal adding code. It was using a pointer that was
460 * 74 7/23/97 11:25a Allender
461 * more robust sexpression checking. Fixed problem with some ai goals not
462 * being named properly
468 #include "freespace.h"
471 #include "missionlog.h"
472 #include "missionparse.h"
473 #include "model.h" // for subsystem types
474 #include "linklist.h"
477 #include "multimsgs.h"
480 // all ai goals dealt with in this code are goals that are specified through
481 // sexpressions in the mission file. They are either specified as part of a
482 // ships goals in the #Object section of the mission file, or are created (and
483 // removed) dynamically using the #Events section. Default goal behaviour and
484 // dynamic goals are not handled here.
486 // defines for player issued goal priorities
487 #define PLAYER_PRIORITY_MIN 90
488 #define PLAYER_PRIORITY_SHIP 100
489 #define PLAYER_PRIORITY_WING 95
490 #define PLAYER_PRIORITY_SUPPORT_LOW 10
492 // define for which goals cause other goals to get purged
493 #define PURGE_GOALS (AI_GOAL_IGNORE | AI_GOAL_DISABLE_SHIP | AI_GOAL_DISARM_SHIP)
495 // goals given from the player to other ships in the game are also handled in this
499 #define AI_GOAL_ACHIEVABLE 1
500 #define AI_GOAL_NOT_ACHIEVABLE 2
501 #define AI_GOAL_NOT_KNOWN 3
502 #define AI_GOAL_SATISFIED 4
504 int Ai_goal_signature;
505 int Num_ai_dock_names = 0;
506 char Ai_dock_names[MAX_AI_DOCK_NAMES][NAME_LENGTH];
508 // AL 11-17-97: A text description of the AI goals. This is used for printing out on the
509 // HUD what a ship's current orders are. If the AI goal doesn't correspond to something that
510 // ought to be printable, then NULL is used.
511 // JAS: Converted to a function in order to externalize the strings
512 char *Ai_goal_text(int goal)
516 return XSTR( "attack ", 474);
518 return XSTR( "dock ", 475);
520 return XSTR( "waypoints", 476);
522 return XSTR( "waypoints", 476);
524 return XSTR( "destroy ", 477);
526 return XSTR( "form on ", 478);
528 return XSTR( "undock ", 479);
530 return XSTR( "attack ", 474);
532 return XSTR( "guard ", 480);
534 return XSTR( "disable ", 481);
536 return XSTR( "disarm ", 482);
538 return XSTR( "guard ", 480);
540 return XSTR( "evade ", 483);
542 return XSTR( "rearm ", 484);
545 // Avoid compiler warning
549 // function to maybe add the form on my wing goal for a player's starting wing. Called from below and when a
550 // player wing arrives.
551 void ai_maybe_add_form_goal( wing *wingp )
555 // iterate through the ship_index list of this wing and check for orders. We will do
556 // this for all ships in the wing instead of on a wing only basis in cases some ships
557 // in the wing actually have different orders than others
558 for ( j = 0; j < wingp->current_count; j++ ) {
561 Assert( wingp->ship_index[j] != -1 ); // get Allender
563 aip = &Ai_info[Ships[wingp->ship_index[j]].ai_index];
564 // don't process Player_ship
565 if ( aip == Player_ai )
568 // it is sufficient enough to check the first goal entry to see if it has a valid
570 if ( aip->goals[0].ai_mode == AI_GOAL_NONE ) {
571 // need to add a form on my wing goal here. Ships are always forming on the player's wing.
572 ai_add_ship_goal_player( AIG_TYPE_PLAYER_SHIP, AI_GOAL_FORM_ON_WING, -1, Player_ship->ship_name, aip );
577 void ai_post_process_mission()
582 // Check ships in player starting wings. Those ships should follow these rules:
583 // (1) if they have no orders, they should get a form on my wing order
584 // (2) if they have an order, they are free to act on it.
586 // So basically, we are checking for (1)
587 if ( !Fred_running ) {
588 for ( i = 0; i < 1; i++ ) { // MK, 5/9/98: Used to iterate through MAX_PLAYER_WINGS, but this was too many ships forming on player.
589 if ( Starting_wings[i] != -1 ) {
592 wingp = &Wings[Starting_wings[i]];
594 ai_maybe_add_form_goal( wingp );
600 // for every valid ship object, call process_mission_orders to be sure that ships start the
601 // mission following the orders in the mission file right away instead of waiting N seconds
602 // before following them. Do both the created list and the object list for safety
603 for ( objp = GET_FIRST(&obj_used_list); objp != END_OF_LIST(&obj_used_list); objp = GET_NEXT(objp) ) {
604 if ( objp->type != OBJ_SHIP )
606 ai_process_mission_orders( OBJ_INDEX(objp), &Ai_info[Ships[objp->instance].ai_index] );
608 for ( objp = GET_FIRST(&obj_create_list); objp != END_OF_LIST(&obj_create_list); objp = GET_NEXT(objp) ) {
609 if ( (objp->type != OBJ_SHIP) || Fred_running )
611 ai_process_mission_orders( OBJ_INDEX(objp), &Ai_info[Ships[objp->instance].ai_index] );
617 // function which determines is a goal is valid for a particular type of ship
618 int ai_query_goal_valid( int ship, int ai_goal )
622 if (ai_goal == AI_GOAL_NONE)
623 return 1; // anything can have no orders.
626 switch (Ship_info[Ships[ship].ship_info_index].flags & SIF_ALL_SHIP_TYPES) {
629 Int3(); // get Hoffoss or Allender -- cargo containers shouldn't have a goal!!!
633 if ( ai_goal & AI_GOAL_ACCEPT_FIGHTER ){
638 if ( ai_goal & AI_GOAL_ACCEPT_BOMBER ){
643 if ( ai_goal & AI_GOAL_ACCEPT_CRUISER ){
648 if ( ai_goal & AI_GOAL_ACCEPT_FREIGHTER ){
653 if ( ai_goal & AI_GOAL_ACCEPT_CAPITAL ){
658 if ( ai_goal & AI_GOAL_ACCEPT_TRANSPORT ){
663 if ( ai_goal & AI_GOAL_ACCEPT_SUPPORT ){
668 if ( ai_goal & AI_GOAL_ACCEPT_ESCAPEPOD ){
673 if ( ai_goal & AI_GOAL_ACCEPT_SUPERCAP ){
678 if ( ai_goal & AI_GOAL_ACCEPT_STEALTH ){
683 if ( ai_goal & AI_GOAL_ACCEPT_CORVETTE ){
688 if ( ai_goal & AI_GOAL_ACCEPT_GAS_MINER ){
693 if ( ai_goal & AI_GOAL_ACCEPT_AWACS ){
697 case SIF_NO_SHIP_TYPE:
699 Int3(); // HUH? doesn't make sense
704 Int3(); // get allender or hoffos -- unknown ship type
712 // remove an ai goal from it's list. Uses the active_goal member as the goal to remove
713 void ai_remove_ship_goal( ai_info *aip, int index )
715 // only need to set the ai_mode for the particular goal to AI_GOAL_NONE
716 // reset ai mode to default behavior. Might get changed next time through
718 Assert ( index >= 0 ); // must have a valid goal
720 aip->goals[index].ai_mode = AI_GOAL_NONE;
721 aip->goals[index].signature = -1;
722 aip->goals[index].priority = -1;
723 aip->goals[index].flags = 0; // must reset the flags since not doing so will screw up goal sorting.
724 if ( index == aip->active_goal )
725 aip->active_goal = AI_GOAL_NONE;
727 // mwa -- removed this line 8/5/97. Just because we remove a goal doesn't mean to do the default
728 // behavior. We will make the call commented out below in a more reasonable location
729 //ai_do_default_behavior( &Objects[Ships[aip->shipnum].objnum] );
732 void ai_clear_ship_goals( ai_info *aip )
736 for (i = 0; i < MAX_AI_GOALS; i++)
737 ai_remove_ship_goal( aip, i ); // resets active_goal and default behavior
739 aip->active_goal = AI_GOAL_NONE; // for good measure
741 // next line moved here on 8/5/97 by MWA
742 // Dont reset player ai (and hence target)
743 if ( !((Player_ship != NULL) && (&Ships[aip->shipnum] == Player_ship)) ) {
744 ai_do_default_behavior( &Objects[Ships[aip->shipnum].objnum] );
748 void ai_clear_wing_goals( int wingnum )
751 wing *wingp = &Wings[wingnum];
754 // clear the goals for all ships in the wing
755 for (i = 0; i < wingp->current_count; i++) {
756 int num = wingp->ship_index[i];
759 ai_clear_ship_goals( &Ai_info[Ships[num].ai_index] );
763 // clear out the goals for the wing now
764 for (i = 0; i < MAX_AI_GOALS; i++) {
765 wingp->ai_goals[i].ai_mode = AI_GOAL_NONE;
766 wingp->ai_goals[i].signature = -1;
767 wingp->ai_goals[i].priority = -1;
773 // routine which marks a wing goal as being complete. We get the wingnum and a pointer to the goal
774 // structure of the goal to be removed. This process is slightly tricky since some member of the wing
775 // might be pursuing a different goal. We will have to compare based on mode, submode, priority,
776 // and name.. This routine is only currently called from waypoint code!!!
777 void ai_mission_wing_goal_complete( int wingnum, ai_goal *remove_goalp )
779 int mode, submode, priority, i;
784 wingp = &Wings[wingnum];
786 // set up locals for faster access.
787 mode = remove_goalp->ai_mode;
788 submode = remove_goalp->ai_submode;
789 priority = remove_goalp->priority;
790 name = remove_goalp->ship_name;
792 Assert ( name ); // should not be NULL!!!!
794 // remove the goal from all the ships currently in the wing
795 for (i = 0; i < wingp->current_count; i++ ) {
799 num = wingp->ship_index[i];
801 aip = &Ai_info[Ships[num].ai_index];
802 for ( j = 0; j < MAX_AI_GOALS; j++ ) {
803 aigp = &(aip->goals[j]);
805 // don't need to worry about these types of goals since they can't possibly be a goal we are looking for.
806 if ( (aigp->ai_mode == AI_GOAL_NONE) || !aigp->ship_name )
809 if ( (aigp->ai_mode == mode) && (aigp->ai_submode == submode) && (aigp->priority == priority) && !stricmp(name, aigp->ship_name) ) {
810 ai_remove_ship_goal( aip, j );
811 ai_do_default_behavior( &Objects[Ships[aip->shipnum].objnum] ); // do the default behavior
812 break; // we are all done
817 // now remove the goal from the wing
818 for (i = 0; i < MAX_AI_GOALS; i++ ) {
819 aigp = &(wingp->ai_goals[i]);
820 if ( (aigp->ai_mode == AI_GOAL_NONE) || !aigp->ship_name )
823 if ( (aigp->ai_mode == mode) && (aigp->ai_submode == submode) && (aigp->priority == priority) && !stricmp(name, aigp->ship_name) ) {
824 wingp->ai_goals[i].ai_mode = AI_GOAL_NONE;
825 wingp->ai_goals[i].signature = -1;
826 wingp->ai_goals[i].priority = -1;
833 // routine which is called with an ai object complete it's goal. Do some action
834 // based on the goal what was just completed
836 void ai_mission_goal_complete( ai_info *aip )
838 // if the active goal is dynamic or none, just return. (AI_GOAL_NONE is probably an error, but
839 // I don't think that this is a problem)
840 if ( (aip->active_goal == AI_GOAL_NONE) || (aip->active_goal == AI_ACTIVE_GOAL_DYNAMIC) )
843 ai_remove_ship_goal( aip, aip->active_goal );
844 ai_do_default_behavior( &Objects[Ships[aip->shipnum].objnum] ); // do the default behavior
848 int ai_get_subsystem_type( char *subsystem )
850 if ( strstr(subsystem, "engine") ) {
851 return SUBSYSTEM_ENGINE;
852 } else if ( strstr(subsystem, "radar") ) {
853 return SUBSYSTEM_RADAR;
854 } else if ( strstr(subsystem, "turret") ) {
855 return SUBSYSTEM_TURRET;
856 } else if ( strstr(subsystem, "navigation") ) {
857 return SUBSYSTEM_NAVIGATION;
858 } else if ( !strnicmp(subsystem, NOX("communication"), 13) ) {
859 return SUBSYSTEM_COMMUNICATION;
860 } else if ( !strnicmp(subsystem, NOX("weapons"), 7) ) {
861 return SUBSYSTEM_WEAPONS;
862 } else if ( !strnicmp(subsystem, NOX("sensors"), 7) ) {
863 return SUBSYSTEM_SENSORS;
864 } else if ( !strnicmp(subsystem, NOX("solar"), 5) ) {
865 return SUBSYSTEM_SOLAR;
866 } else if ( !strnicmp(subsystem, NOX("gas"), 3) ) {
867 return SUBSYSTEM_GAS_COLLECT;
868 } else if ( !strnicmp(subsystem, NOX("activator"), 9) ) {
869 return SUBSYSTEM_ACTIVATION;
870 } else { // If unrecognized type, set to engine so artist can continue working...
872 // Int3(); // illegal subsystem type -- find allender
875 return SUBSYSTEM_UNKNOWN;
879 // function to prune out goals which are no longer valid, based on a goal pointer passed in.
880 // for instance, if we get passed a goal of "disable X", then any goals in the given goal array
881 // which are destroy, etc, should get removed. goal list is the list of goals to purge. It is
882 // always MAX_AI_GOALS in length. This function will only get called when the goal which causes
883 // purging becomes valid.
884 void ai_goal_purge_invalid_goals( ai_goal *aigp, ai_goal *goal_list )
889 int mode, ship_index, wingnum;
891 // get locals for easer access
892 name = aigp->ship_name;
893 mode = aigp->ai_mode;
895 // these goals cannot be associated to wings, but can to a ship in a wing. So, we should find out
896 // if the ship is in a wing so we can purge goals which might operate on that wing
897 ship_index = ship_name_lookup(name);
898 if ( ship_index == -1 ) {
899 Int3(); // get allender -- this is sort of odd
902 wingnum = Ships[ship_index].wingnum;
904 purge_goal = goal_list;
905 for ( i = 0; i < MAX_AI_GOALS; purge_goal++, i++ ) {
906 int purge_ai_mode, purge_wing;
908 purge_ai_mode = purge_goal->ai_mode;
910 // don't need to process AI_GOAL_NONE
911 if ( purge_ai_mode == AI_GOAL_NONE )
914 // goals must operate on something to be purged.
915 if ( purge_goal->ship_name == NULL )
918 // determine if the purge goal is acting either on the ship or the ship's wing.
919 purge_wing = wing_name_lookup( purge_goal->ship_name, 1 );
921 // if the target of the purge goal is a ship (purge_wing will be -1), then if the names
922 // don't match, we can continue; if the wing is valid, don't process if the wing numbers
924 if ( purge_wing == -1 ) {
925 if ( stricmp(purge_goal->ship_name, name ) )
927 } else if ( purge_wing != wingnum )
931 // ignore goals should get rid of any kind of attack goal
933 if ( purge_ai_mode & (AI_GOAL_DISABLE_SHIP | AI_GOAL_DISARM_SHIP | AI_GOAL_CHASE | AI_GOAL_CHASE_WING | AI_GOAL_DESTROY_SUBSYSTEM) )
934 purge_goal->flags |= AIGF_PURGE;
937 // disarm/disable goals should remove any general attack
938 case AI_GOAL_DISABLE_SHIP:
939 case AI_GOAL_DISARM_SHIP:
940 if ( purge_ai_mode & (AI_GOAL_CHASE | AI_GOAL_CHASE_WING) )
941 purge_goal->flags |= AIGF_PURGE;
947 // function to purge the goals of all ships in the game based on the incoming goal structure
948 void ai_goal_purge_all_invalid_goals( ai_goal *aigp )
953 mode = aigp->ai_mode;
955 // only purge goals if a new goal is one of the types in next statement
956 if ( !(mode & PURGE_GOALS) )
959 for ( sop = GET_FIRST(&Ship_obj_list); sop != END_OF_LIST(&Ship_obj_list); sop = GET_NEXT(sop) ) {
962 shipp = &Ships[Objects[sop->objnum].instance];
963 ai_goal_purge_invalid_goals( aigp, Ai_info[shipp->ai_index].goals );
966 // we must do the same for the wing goals
967 for (i = 0; i < num_wings; i++ )
968 ai_goal_purge_invalid_goals( aigp, Wings[i].ai_goals );
971 // function to fix up dock point references for objects.
972 // passed are the pointer to goal we are working with. aip if the ai_info pointer
973 // of the ship with the order. aigp is a pointer to the goal (of aip) of which we are
974 // fixing up the docking points
975 void ai_goal_fixup_dockpoints(ai_info *aip, ai_goal *aigp)
977 int shipnum, dockee_index, docker_index;
979 Assert ( aip->shipnum != -1 );
980 shipnum = ship_name_lookup( aigp->ship_name );
984 // look for docking points of the appriopriate type. Use cargo docks for cargo ships.
986 if ( Ship_info[Ships[shipnum].ship_info_index].flags & SIF_CARGO ) {
987 docker_index = model_find_dock_index(Ships[aip->shipnum].modelnum, DOCK_TYPE_CARGO );
988 dockee_index = model_find_dock_index(Ships[shipnum].modelnum, DOCK_TYPE_CARGO );
989 } else if ( Ship_info[Ships[aip->shipnum].ship_info_index].flags & SIF_SUPPORT ) {
990 docker_index = model_find_dock_index( Ships[aip->shipnum].modelnum, DOCK_TYPE_REARM );
991 dockee_index = model_find_dock_index( Ships[shipnum].modelnum, DOCK_TYPE_REARM );
994 // if we didn't find dockpoints above, then we should just look for generic docking points
995 if ( docker_index == -1 )
996 docker_index = model_find_dock_index(Ships[aip->shipnum].modelnum, DOCK_TYPE_GENERIC );
997 if ( dockee_index == -1 )
998 dockee_index = model_find_dock_index(Ships[shipnum].modelnum, DOCK_TYPE_GENERIC );
1000 aigp->docker.index = docker_index;
1001 aigp->dockee.index = dockee_index;
1002 aigp->flags &= ~(AIGF_DOCKER_NAME_VALID | AIGF_DOCKEE_NAME_VALID);
1005 // these functions deal with adding goals sent from the player. They are slightly different
1006 // from the mission goals (i.e. those goals which come from events) in that we don't
1007 // use sexpressions for goals from the player...so we enumerate all the parameters
1009 void ai_add_goal_sub_player(int type, int mode, int submode, char *shipname, ai_goal *aigp )
1011 Assert ( (type == AIG_TYPE_PLAYER_WING) || (type == AIG_TYPE_PLAYER_SHIP) );
1013 aigp->time = Missiontime;
1014 aigp->type = type; // from player for sure -- could be to ship or to wing
1015 aigp->ai_mode = mode; // major mode for this goal
1016 aigp->ai_submode = submode; // could mean different things depending on mode
1018 if ( mode == AI_GOAL_WARP )
1019 aigp->wp_index = submode;
1021 if ( mode == AI_GOAL_CHASE_WEAPON ) {
1022 aigp->wp_index = submode; // submode contains the instance of the weapon
1023 aigp->weapon_signature = Objects[Weapons[submode].objnum].signature;
1026 if ( shipname != NULL )
1027 aigp->ship_name = ai_get_goal_ship_name( shipname, &aigp->ship_name_index );
1029 aigp->ship_name = NULL;
1031 // special case certain orders from player so that ships continue to do the right thing
1033 // make priority for these two support ship orders low so that they will prefer repairing
1034 // a ship over staying near a ship.
1035 if ( (mode == AI_GOAL_STAY_NEAR_SHIP) || (mode == AI_GOAL_KEEP_SAFE_DISTANCE) )
1036 aigp->priority = PLAYER_PRIORITY_SUPPORT_LOW;
1038 else if ( aigp->type == AIG_TYPE_PLAYER_WING )
1039 aigp->priority = PLAYER_PRIORITY_WING; // player wing goals not as high as ship goals
1041 aigp->priority = PLAYER_PRIORITY_SHIP;
1044 int ai_goal_find_empty_slot( ai_goal *goals )
1046 int gindex, empty_index, oldest_index;
1050 for ( gindex = 0; gindex < MAX_AI_GOALS; gindex++ ) {
1051 if ( goals[gindex].time < goals[oldest_index].time )
1052 oldest_index = gindex;
1054 if ( (empty_index == -1) && (goals[gindex].ai_mode == AI_GOAL_NONE) ) // get the index for this goal
1055 empty_index = gindex;
1058 // if we didn't find an empty slot, find the oldest goal and use it's slot
1059 if ( empty_index == -1 )
1060 empty_index = oldest_index;
1062 Assert ( empty_index < MAX_AI_GOALS );
1067 // adds a goal from a player to the given ship's ai_info structure. 'type' tells us if goal
1068 // is issued to ship or wing (from player), mode is AI_GOAL_*. submode is the submode the
1069 // ship should go into. shipname is the object of the action. aip is the ai_info pointer
1070 // of the ship receiving the order
1071 void ai_add_ship_goal_player( int type, int mode, int submode, char *shipname, ai_info *aip )
1076 empty_index = ai_goal_find_empty_slot( aip->goals );
1078 // get a pointer to the goal structure
1079 aigp = &aip->goals[empty_index];
1080 ai_add_goal_sub_player( type, mode, submode, shipname, aigp );
1082 // if the goal is to dock, then we must determine which dock points on the two ships to use.
1083 // If the target of the dock is a cargo type container, then we should use DOCK_TYPE_CARGO
1084 // on both ships. Code is here instead of in ai_add_goal_sub_player() since a dock goal
1085 // should only occur to a specific ship.
1087 if ( (mode == AI_GOAL_REARM_REPAIR) || ((mode == AI_GOAL_DOCK) && (submode == AIS_DOCK_0)) ) {
1088 ai_goal_fixup_dockpoints( aip, aigp );
1091 aigp->signature = Ai_goal_signature++;
1095 // adds a goal from the player to the given wing (which in turn will add it to the proper
1096 // ships in the wing
1097 void ai_add_wing_goal_player( int type, int mode, int submode, char *shipname, int wingnum )
1100 wing *wingp = &Wings[wingnum];
1102 // add the ai goal for any ship that is currently arrived in the game.
1103 if ( !Fred_running ) { // only add goals to ships if fred isn't running
1104 for (i = 0; i < wingp->current_count; i++) {
1105 int num = wingp->ship_index[i];
1106 if ( num == -1 ) // ship must have been destroyed or departed
1108 ai_add_ship_goal_player( type, mode, submode, shipname, &Ai_info[Ships[num].ai_index] );
1112 // add the sexpression index into the wing's list of goal sexpressions if
1113 // there are more waves to come. We use the same method here as when adding a goal to
1114 // a ship -- find the first empty entry. If none exists, take the oldest entry and replace it.
1115 empty_index = ai_goal_find_empty_slot( wingp->ai_goals );
1116 ai_add_goal_sub_player( type, mode, submode, shipname, &wingp->ai_goals[empty_index] );
1120 // common routine to add a sexpression mission goal to the appropriate goal structure.
1121 void ai_add_goal_sub_sexp( int sexp, int type, ai_goal *aigp )
1123 int node, dummy, op;
1126 Assert ( Sexp_nodes[sexp].first != -1 );
1127 node = Sexp_nodes[sexp].first;
1130 aigp->signature = Ai_goal_signature++;
1132 aigp->time = Missiontime;
1136 op = find_operator( text );
1140 case OP_AI_WAYPOINTS_ONCE:
1141 case OP_AI_WAYPOINTS: {
1144 ref_type = Sexp_nodes[CDR(node)].subtype;
1145 if (ref_type == SEXP_ATOM_STRING) { // referenced by name
1146 // save the waypoint path name -- the index will get resolved when the goal is checked
1147 // for acheivability.
1148 aigp->ship_name = ai_get_goal_ship_name(CTEXT(CDR(node)), &aigp->ship_name_index); // waypoint path name;
1149 aigp->wp_index = -1;
1154 aigp->priority = atoi( CTEXT(CDR(CDR(node))) );
1155 aigp->ai_mode = AI_GOAL_WAYPOINTS;
1156 if ( op == OP_AI_WAYPOINTS_ONCE )
1157 aigp->ai_mode = AI_GOAL_WAYPOINTS_ONCE;
1161 case OP_AI_DESTROY_SUBSYS:
1162 aigp->ai_mode = AI_GOAL_DESTROY_SUBSYSTEM;
1163 aigp->ship_name = ai_get_goal_ship_name( CTEXT(CDR(node)), &aigp->ship_name_index );
1164 // store the name of the subsystem in the docker_name field for now -- this field must
1165 // get fixed up when the goal is valid since we need to locate the subsystem on the ship's
1167 aigp->docker.name = ai_get_goal_ship_name(CTEXT(CDR(CDR(node))), &dummy);
1168 aigp->flags |= AIGF_SUBSYS_NAME_VALID;
1169 aigp->priority = atoi( CTEXT(CDR(CDR(CDR(node)))) );
1172 case OP_AI_DISABLE_SHIP:
1173 aigp->ai_mode = AI_GOAL_DISABLE_SHIP;
1174 aigp->ship_name = ai_get_goal_ship_name( CTEXT(CDR(node)), &aigp->ship_name_index );
1175 aigp->ai_submode = -SUBSYSTEM_ENGINE;
1176 aigp->priority = atoi( CTEXT(CDR(CDR(node))) );
1179 case OP_AI_DISARM_SHIP:
1180 aigp->ai_mode = AI_GOAL_DISARM_SHIP;
1181 aigp->ship_name = ai_get_goal_ship_name( CTEXT(CDR(node)), &aigp->ship_name_index );
1182 aigp->ai_submode = -SUBSYSTEM_TURRET;
1183 aigp->priority = atoi( CTEXT(CDR(CDR(node))) );
1186 case OP_AI_WARP_OUT:
1187 aigp->ai_mode = AI_GOAL_WARP;
1188 aigp->priority = atoi( CTEXT(CDR(node)) );
1191 // the following goal is obsolete, but here for compatibility
1193 aigp->ai_mode = AI_GOAL_WARP;
1194 aigp->ship_name = ai_get_goal_ship_name(CTEXT(CDR(node)), &aigp->ship_name_index); // waypoint path name;
1195 //aigp->wp_index = atoi( CTEXT(CDR(node)) ); // this is the index into the warp points
1196 aigp->wp_index = -1;
1197 aigp->priority = atoi( CTEXT(CDR(CDR(node))) );
1201 aigp->ship_name = NULL;
1202 aigp->priority = atoi( CTEXT(CDR(node)) );
1203 aigp->ai_mode = AI_GOAL_UNDOCK;
1204 aigp->ai_submode = AIS_UNDOCK_0;
1207 case OP_AI_STAY_STILL:
1208 aigp->ai_mode = AI_GOAL_STAY_STILL;
1209 aigp->ship_name = ai_get_goal_ship_name(CTEXT(CDR(node)), &aigp->ship_name_index); // waypoint path name;
1210 aigp->priority = atoi( CTEXT(CDR(CDR(node))) );
1214 aigp->ship_name = ai_get_goal_ship_name( CTEXT(CDR(node)), &aigp->ship_name_index );
1215 aigp->docker.name = ai_add_dock_name(CTEXT(CDR(CDR(node))));
1216 aigp->dockee.name = ai_add_dock_name(CTEXT(CDR(CDR(CDR(node)))));
1217 aigp->flags |= ( AIGF_DOCKER_NAME_VALID | AIGF_DOCKEE_NAME_VALID );
1218 aigp->priority = atoi( CTEXT(CDR(CDR(CDR(CDR(node))))) );
1220 aigp->ai_mode = AI_GOAL_DOCK;
1221 aigp->ai_submode = AIS_DOCK_0; // be sure to set the submode
1224 case OP_AI_CHASE_ANY:
1225 aigp->priority = atoi( CTEXT(CDR(node)) );
1226 aigp->ai_mode = AI_GOAL_CHASE_ANY;
1229 case OP_AI_PLAY_DEAD:
1230 aigp->priority = atoi( CTEXT(CDR(node)) );
1231 aigp->ai_mode = AI_GOAL_PLAY_DEAD;
1234 case OP_AI_KEEP_SAFE_DISTANCE:
1235 aigp->priority = atoi( CTEXT(CDR(node)) );
1236 aigp->ai_mode = AI_GOAL_KEEP_SAFE_DISTANCE;
1241 case OP_AI_GUARD_WING:
1242 case OP_AI_CHASE_WING:
1243 case OP_AI_EVADE_SHIP:
1244 case OP_AI_STAY_NEAR_SHIP:
1246 aigp->ship_name = ai_get_goal_ship_name( CTEXT(CDR(node)), &aigp->ship_name_index );
1247 aigp->priority = atoi( CTEXT(CDR(CDR(node))) );
1249 if ( op == OP_AI_CHASE ) {
1250 aigp->ai_mode = AI_GOAL_CHASE;
1252 // in the case of ai_chase (and ai_guard) we must do a wing_name_lookup on the name
1253 // passed here to see if we could be chasing a wing. Hoffoss and I have consolidated
1254 // sexpression operators which makes this step necessary
1255 if ( wing_name_lookup(aigp->ship_name, 1) != -1 )
1256 aigp->ai_mode = AI_GOAL_CHASE_WING;
1258 } else if ( op == OP_AI_GUARD ) {
1259 aigp->ai_mode = AI_GOAL_GUARD;
1260 if ( wing_name_lookup(aigp->ship_name, 1) != -1 )
1261 aigp->ai_mode = AI_GOAL_GUARD_WING;
1263 } else if ( op == OP_AI_EVADE_SHIP ) {
1264 aigp->ai_mode = AI_GOAL_EVADE_SHIP;
1266 } else if ( op == OP_AI_GUARD_WING ) {
1267 aigp->ai_mode = AI_GOAL_GUARD_WING;
1268 } else if ( op == OP_AI_CHASE_WING ) {
1269 aigp->ai_mode = AI_GOAL_CHASE_WING;
1270 } else if ( op == OP_AI_STAY_NEAR_SHIP ) {
1271 aigp->ai_mode = AI_GOAL_STAY_NEAR_SHIP;
1272 } else if ( op == OP_AI_IGNORE ) {
1273 aigp->ai_mode = AI_GOAL_IGNORE;
1275 Int3(); // this is impossible
1280 Int3(); // get ALLENDER -- invalid ai-goal specified for ai object!!!!
1283 if ( aigp->priority >= PLAYER_PRIORITY_MIN ) {
1284 nprintf (("AI", "bashing sexpression priority of goal %s from %d to %d.\n", text, aigp->priority, PLAYER_PRIORITY_MIN-1));
1285 aigp->priority = PLAYER_PRIORITY_MIN-1;
1289 // adds an ai goal for an individual ship
1290 // type determines who has issues this ship a goal (i.e. the player/mission event/etc)
1291 void ai_add_ship_goal_sexp( int sexp, int type, ai_info *aip )
1295 gindex = ai_goal_find_empty_slot( aip->goals );
1296 ai_add_goal_sub_sexp( sexp, type, &aip->goals[gindex] );
1299 // code to add ai goals to wings.
1300 void ai_add_wing_goal_sexp(int sexp, int type, int wingnum)
1303 wing *wingp = &Wings[wingnum];
1305 // add the ai goal for any ship that is currently arrived in the game (only if fred isn't running
1306 if ( !Fred_running ) {
1307 for (i = 0; i < wingp->current_count; i++) {
1308 int num = wingp->ship_index[i];
1309 if ( num == -1 ) // ship must have been destroyed or departed
1311 ai_add_ship_goal_sexp( sexp, type, &Ai_info[Ships[num].ai_index] );
1315 // add the sexpression index into the wing's list of goal sexpressions if
1316 // there are more waves to come
1317 if ((wingp->num_waves - wingp->current_wave > 0) || Fred_running) {
1320 gindex = ai_goal_find_empty_slot( wingp->ai_goals );
1321 ai_add_goal_sub_sexp( sexp, type, &wingp->ai_goals[gindex] );
1325 // function for internal code to add a goal to a ship. Needed when the AI finds itself in a situation
1326 // that it must get out of by issuing itself an order.
1328 // objp is the object getting the goal
1329 // goal_type is one of AI_GOAL_*
1330 // other_name is a character string objp might act on (for docking, this is a shipname, for guarding
1331 // this name can be a shipname or a wingname)
1332 // docker_point and dockee_point are used for the AI_GOAL_DOCK command to tell two ships where to dock
1333 // immediate means to process this order right away
1334 void ai_add_goal_ship_internal( ai_info *aip, int goal_type, char *name, int docker_point, int dockee_point, int immediate )
1339 // find an empty slot to put this goal in.
1340 gindex = ai_goal_find_empty_slot( aip->goals );
1342 aigp = &(aip->goals[gindex]);
1344 aigp->signature = Ai_goal_signature++;
1346 aigp->time = Missiontime;
1347 aigp->type = AIG_TYPE_DYNAMIC;
1348 aigp->flags = AIGF_GOAL_OVERRIDE;
1350 switch ( goal_type ) {
1352 aigp->ship_name = name;
1353 aigp->docker.index = docker_point;
1354 aigp->dockee.index = dockee_point;
1355 aigp->priority = 100;
1357 aigp->ai_mode = AI_GOAL_DOCK;
1358 aigp->ai_submode = AIS_DOCK_0; // be sure to set the submode
1361 case AI_GOAL_UNDOCK:
1362 aigp->ship_name = NULL;
1363 aigp->priority = 100;
1364 aigp->ai_mode = AI_GOAL_UNDOCK;
1365 aigp->ai_submode = AIS_UNDOCK_0;
1369 aigp->ai_mode = AI_GOAL_GUARD;
1370 if ( wing_name_lookup(name, 1) != -1 )
1371 aigp->ai_mode = AI_GOAL_GUARD_WING;
1374 case AI_GOAL_REARM_REPAIR:
1375 aigp->ai_mode = AI_GOAL_REARM_REPAIR;
1376 aigp->ai_submode = 0;
1377 aigp->ship_name = name;
1378 aigp->priority = PLAYER_PRIORITY_MIN-1; // make the priority always less than what the player's is
1379 aigp->flags &= ~AIGF_GOAL_OVERRIDE; // don't override this goal. rearm repair requests should happen in order
1380 ai_goal_fixup_dockpoints( aip, aigp );
1384 Int3(); // unsupported internal goal -- see Mike K or Mark A.
1389 // process the orders immediately so that these goals take effect right away
1391 ai_process_mission_orders( Ships[aip->shipnum].objnum, aip );
1394 // function to add an internal goal to a wing. Mike K says that the goal doesn't need to persist
1395 // across waves of the wing so we merely need to add the goal to each ship in the wing. Certain
1396 // goal are simply not valid for wings (like dock, undock). Immediate parameter gets passed to add_ship_goal
1397 // to say whether or not we should process this goal right away
1398 void ai_add_goal_wing_internal( wing *wingp, int goal_type, char *name, int immediate )
1402 // be sure we are not trying to issue dock or undock goals to wings
1403 Assert ( (goal_type != AI_GOAL_DOCK) || (goal_type != AI_GOAL_UNDOCK) );
1405 for (i = 0; i < wingp->current_count; i++) {
1406 int num = wingp->ship_index[i];
1407 if ( num == -1 ) // ship must have been destroyed or departed
1409 ai_add_goal_ship_internal( &Ai_info[Ships[num].ai_index], goal_type, name, -1, -1, immediate);
1413 // this function copies goals from a wing to an ai_info * from a ship.
1414 void ai_copy_mission_wing_goal( ai_goal *aigp, ai_info *aip )
1418 for ( j = 0; j < MAX_AI_GOALS; j++ ) {
1419 if ( aip->goals[j].ai_mode == AI_GOAL_NONE )
1422 Assert ( j < MAX_AI_GOALS );
1423 aip->goals[j] = *aigp;
1427 #define SHIP_STATUS_GONE 1
1428 #define SHIP_STATUS_NOT_ARRIVED 2
1429 #define SHIP_STATUS_ARRIVED 3
1430 #define SHIP_STATUS_UNKNOWN 4
1432 // function to determine if an ai goal is achieveable or not. Will return
1433 // one of the AI_GOAL_* values. Also determines is a goal was successful.
1435 int ai_mission_goal_achievable( int objnum, ai_goal *aigp )
1443 // these orders are always achievable.
1444 if ( (aigp->ai_mode == AI_GOAL_KEEP_SAFE_DISTANCE) || (aigp->ai_mode == AI_GOAL_WARP)
1445 || (aigp->ai_mode == AI_GOAL_CHASE_ANY) || (aigp->ai_mode == AI_GOAL_STAY_STILL)
1446 || (aigp->ai_mode == AI_GOAL_PLAY_DEAD) )
1447 return AI_GOAL_ACHIEVABLE;
1449 // form on my wing is always achievable, but need to set the override bit so that it
1450 // always gets executed next
1451 if ( aigp->ai_mode == AI_GOAL_FORM_ON_WING ) {
1452 aigp->flags |= AIGF_GOAL_OVERRIDE;
1453 return AI_GOAL_ACHIEVABLE;
1456 // check to see if we have a valid index. If not, then try to set one up. If that
1457 // fails, then we must pitch this order
1458 if ( (aigp->ai_mode == AI_GOAL_WAYPOINTS_ONCE) || (aigp->ai_mode == AI_GOAL_WAYPOINTS) ) {
1459 if ( aigp->wp_index == -1 ) {
1462 for (i = 0; i < Num_waypoint_lists; i++) {
1463 if (!stricmp(aigp->ship_name, Waypoint_lists[i].name)) {
1468 if ( i == Num_waypoint_lists ) {
1469 Warning(LOCATION, "Unknown waypoint %s. not found in mission file. Killing ai goal", aigp->ship_name );
1470 return AI_GOAL_NOT_ACHIEVABLE;
1473 return AI_GOAL_ACHIEVABLE;
1476 objp = &Objects[objnum];
1477 Assert( objp->instance != -1 );
1478 ai_shipname = Ships[objp->instance].ship_name;
1479 aip = &Ai_info[Ships[objp->instance].ai_index];
1481 return_val = AI_GOAL_SATISFIED;
1483 // next, determine if the goal has been completed successfully
1484 switch ( aigp->ai_mode ) {
1487 case AI_GOAL_CHASE_WING:
1488 case AI_GOAL_UNDOCK:
1489 //status = mission_log_get_time( LOG_SHIP_DOCK, ai_shipname, aigp->ship_name, NULL);
1490 //status = mission_log_get_time( LOG_SHIP_UNDOCK, ai_shipname, aigp->ship_name, NULL );
1491 //MWA 3/20/97 -- cannot short circuit a dock or undock goal already succeeded -- we must
1492 // rely on the goal removal code to just remove this goal. This is because docking/undock
1493 // can happen > 1 time per mission per pair of ships. The above checks will find only
1494 // if the ships docked or undocked at all, which is not what we want.
1497 case AI_GOAL_DESTROY_SUBSYSTEM: {
1501 // shipnum could be -1 depending on if the ship hasn't arrived or died. only look for subsystem
1502 // destroyed when shipnum is valid
1503 shipnum = ship_name_lookup( aigp->ship_name );
1505 // can't determine the status of this goal if ship not valid or the subsystem
1506 // name *is* still valid (meaning we haven't found a valid index yet).
1507 if ( (shipnum == -1) || (aigp->flags & AIGF_SUBSYS_NAME_VALID) ) {
1512 // if the ship is not in the mission or the subsystem name is still being stored, mark the status
1513 // as 0 so we can continue. (The subsystem name must be turned into an index into the ship's subsystems
1514 // for this goal to be valid).
1515 Assert ( aigp->ai_submode >= 0 );
1516 ssp = ship_get_indexed_subsys( &Ships[shipnum], aigp->ai_submode );
1517 status = mission_log_get_time( LOG_SHIP_SUBSYS_DESTROYED, aigp->ship_name, ssp->system_info->name, NULL );
1521 case AI_GOAL_DISABLE_SHIP:
1522 status = mission_log_get_time( LOG_SHIP_DISABLED, aigp->ship_name, NULL, NULL );
1524 case AI_GOAL_DISARM_SHIP:
1525 status = mission_log_get_time( LOG_SHIP_DISARMED, aigp->ship_name, NULL, NULL );
1528 // to guard or ignore a ship, the goal cannot continue if the ship being guarded is either destroyed
1531 case AI_GOAL_IGNORE:
1532 case AI_GOAL_EVADE_SHIP:
1534 case AI_GOAL_STAY_NEAR_SHIP:
1535 case AI_GOAL_REARM_REPAIR: {
1538 // MWA -- 4/22/98. Check for the ship actually being in the mission before
1539 // checking departure and destroyed. In multiplayer, since ships can respawn,
1540 // they get log entries for being destroyed even though they have respawned.
1541 shipnum = ship_name_lookup( aigp->ship_name );
1542 if ( shipnum == -1 ) {
1543 status = mission_log_get_time( LOG_SHIP_DEPART, aigp->ship_name, NULL, NULL);
1545 status = mission_log_get_time( LOG_SHIP_DESTROYED, aigp->ship_name, NULL, NULL);
1547 return_val = AI_GOAL_NOT_ACHIEVABLE;
1555 case AI_GOAL_GUARD_WING:
1556 status = mission_log_get_time( LOG_WING_DEPART, aigp->ship_name, NULL, NULL );
1558 status = mission_log_get_time( LOG_WING_DESTROYED, aigp->ship_name, NULL, NULL);
1560 return_val = AI_GOAL_NOT_ACHIEVABLE;
1564 // the following case statement returns control to caller on all paths!!!!
1565 case AI_GOAL_CHASE_WEAPON:
1566 // for chase weapon, we simply need to look at the weapon instance that we are trying to
1567 // attack and see if the object still exists, and has the same signature that we expect.
1568 if ( Weapons[aigp->wp_index].objnum == -1 )
1569 return AI_GOAL_NOT_ACHIEVABLE;
1571 // if the signatures don't match, then goal isn't achievable.
1572 if ( Objects[Weapons[aigp->wp_index].objnum].signature != aigp->weapon_signature )
1573 return AI_GOAL_NOT_ACHIEVABLE;
1575 // otherwise, we should be good to go
1576 return AI_GOAL_ACHIEVABLE;
1586 // if status is true, then the mission log event was found and the goal was satisfied. return
1587 // AI_GOAL_SATISFIED which should allow this ai object to move onto the next order
1591 // determine the status of the shipname that this object is acting on. There are a couple of
1592 // special cases to deal with. Both the chase wing and undock commands will return from within
1593 // the if statement.
1594 if ( (aigp->ai_mode == AI_GOAL_CHASE_WING) || (aigp->ai_mode == AI_GOAL_GUARD_WING) ) {
1595 int num = wing_name_lookup( aigp->ship_name );
1596 wing *wingp = &Wings[num];
1598 if ( wingp->flags & WF_WING_GONE )
1599 return AI_GOAL_NOT_ACHIEVABLE;
1600 else if ( wingp->total_arrived_count == 0 )
1601 return AI_GOAL_NOT_KNOWN;
1603 return AI_GOAL_ACHIEVABLE;
1604 } else if ( aigp->ai_mode == AI_GOAL_UNDOCK ) {
1605 return AI_GOAL_ACHIEVABLE;
1607 if ( ship_name_lookup( aigp->ship_name ) != -1 )
1608 status = SHIP_STATUS_ARRIVED;
1609 else if ( !mission_parse_ship_arrived(aigp->ship_name) )
1610 status = SHIP_STATUS_NOT_ARRIVED;
1611 else if ( ship_find_exited_ship_by_name(aigp->ship_name) != -1 )
1612 status = SHIP_STATUS_GONE;
1614 Int3(); // get ALLENDER
1615 status = SHIP_STATUS_UNKNOWN;
1619 // if the goal is an ignore/disable/disarm goal, then
1620 if ( (status == SHIP_STATUS_ARRIVED) && (aigp->ai_mode & PURGE_GOALS) && !(aigp->flags & AIGF_GOALS_PURGED) ) {
1621 ai_goal_purge_all_invalid_goals( aigp );
1622 aigp->flags |= AIGF_GOALS_PURGED;
1626 // if we are docking, validate the docking indices on both ships. We might have to change names to indices.
1627 // only enter this calculation if the ship we are docking with has arrived. If the ship is gone, then
1628 // this goal will get removed.
1629 if ( (aigp->ai_mode == AI_GOAL_DOCK) && (status == SHIP_STATUS_ARRIVED) ) {
1630 int index, modelnum, shipnum;
1631 char docker_name[NAME_LENGTH], dockee_name[NAME_LENGTH];
1633 // debug code to save off the name of the dockpoints (if they exist).
1634 docker_name[0] = dockee_name[0] = '\0';
1635 if ( aigp->flags & AIGF_DOCKER_NAME_VALID ) {
1636 strcpy(docker_name, aigp->docker.name);
1637 modelnum = Ships[objp->instance].modelnum;
1638 index = model_find_dock_name_index(modelnum, aigp->docker.name);
1639 aigp->docker.index = index;
1640 aigp->flags &= ~AIGF_DOCKER_NAME_VALID;
1642 if ( aigp->flags & AIGF_DOCKEE_NAME_VALID ) {
1643 shipnum = ship_name_lookup(aigp->ship_name);
1644 if ( shipnum != -1 ) {
1645 strcpy(dockee_name, aigp->dockee.name);
1646 modelnum = Ships[shipnum].modelnum;
1647 index = model_find_dock_name_index(modelnum, aigp->dockee.name);
1648 aigp->dockee.index = index;
1649 aigp->flags &= ~AIGF_DOCKEE_NAME_VALID;
1651 aigp->dockee.index = -1; // this will force code into if statement below making goal not achievable.
1653 if ( (aigp->dockee.index == -1) || (aigp->docker.index == -1) ) {
1654 Int3(); // for now, allender wants to know about these things!!!!
1655 return AI_GOAL_NOT_ACHIEVABLE;
1658 // we must also determine if this ship which is supposed to dock with something is currently
1659 // docked with something else. If so, then return the ON_HOLD until it is not docked anymore
1660 shipnum = ship_name_lookup(aigp->ship_name);
1661 Assert( shipnum != -1 );
1663 // if ship is disabled, dont' know if it can dock or not
1664 if ( Ships[objp->instance].flags & SF_DISABLED )
1665 return AI_GOAL_NOT_KNOWN;
1667 // if the ship that I am supposed to dock with is docked with something else, then I need to put my
1669 // [MK, 4/23/98: With Mark, we believe this fixes the problem of Comet refusing to warp out after docking with Omega.
1670 // This bug occurred only when mission goals were validated in the frame in which Comet docked, which happened about
1671 // once in 10-20 tries.]
1672 if ( Ai_info[Ships[shipnum].ai_index].ai_flags & AIF_DOCKED )
1673 if (aip->dock_objnum != Ships[shipnum].objnum)
1674 return AI_GOAL_NOT_KNOWN;
1676 // if this ship is docked and needs to get docked with something else, then undock this
1678 if ( aip->ai_flags & AIF_DOCKED ) {
1680 // if we are trying to dock with a different ship, then force this ship to undock
1681 if ( aip->dock_objnum != Ships[shipnum].objnum ) {
1682 // if this goal isn't on hold yet, then issue the undock goal and return NOT_KNOWN
1683 // which will then place the goal on hold until the undocking is complete.
1684 if ( !(aigp->flags & AIGF_GOAL_ON_HOLD) )
1685 ai_add_goal_ship_internal( aip, AI_GOAL_UNDOCK, NULL, -1, -1, 0 );
1687 return AI_GOAL_NOT_KNOWN;
1689 // if this ship is already docked with the guy this order tells him to dock with,
1690 // then mark the goal as satisfied.
1691 // MWA 2/23/98 -- don't return anything. Since this item is a goal, the ai_dock code
1692 // should remove the goal!!!!
1693 //return AI_GOAL_SATISFIED;
1697 } else if ( (aigp->ai_mode == AI_GOAL_DESTROY_SUBSYSTEM) && (status == SHIP_STATUS_ARRIVED) ) {
1698 // if the ship has arrived, and the goal is destroy subsystem, then check to see that we
1699 // have fixed up the subsystem name (of the subsystem to destroy) into an index into
1700 // the ship's subsystem list
1701 if ( aigp->flags & AIGF_SUBSYS_NAME_VALID ) {
1704 shipnum = ship_name_lookup( aigp->ship_name );
1705 if ( shipnum != -1 ) {
1706 aigp->ai_submode = ship_get_subsys_index( &Ships[shipnum], aigp->docker.name );
1707 aigp->flags &= ~AIGF_SUBSYS_NAME_VALID;
1710 return AI_GOAL_NOT_ACHIEVABLE; // force this goal to be invalid
1713 } else if ( (aigp->ai_mode == AI_GOAL_IGNORE) && (status == SHIP_STATUS_ARRIVED) ) {
1717 // for ignoring a ship, call the ai_ignore object function, then declare the goal satisfied
1718 shipnum = ship_name_lookup( aigp->ship_name );
1719 Assert( shipnum != -1 ); // should be true because of above status
1720 ignored = &Objects[Ships[shipnum].objnum];
1721 ai_ignore_object(objp, ignored, 100);
1722 return AI_GOAL_SATISFIED;
1725 switch ( aigp->ai_mode ) {
1729 case AI_GOAL_DESTROY_SUBSYSTEM:
1730 case AI_GOAL_UNDOCK:
1732 case AI_GOAL_GUARD_WING:
1733 case AI_GOAL_DISABLE_SHIP:
1734 case AI_GOAL_DISARM_SHIP:
1735 case AI_GOAL_IGNORE:
1736 case AI_GOAL_EVADE_SHIP:
1737 case AI_GOAL_STAY_NEAR_SHIP:
1738 if ( status == SHIP_STATUS_ARRIVED )
1739 return AI_GOAL_ACHIEVABLE;
1740 else if ( status == SHIP_STATUS_NOT_ARRIVED )
1741 return AI_GOAL_NOT_KNOWN;
1742 else if ( status == SHIP_STATUS_GONE )
1743 return AI_GOAL_NOT_ACHIEVABLE;
1744 else if ( status == SHIP_STATUS_UNKNOWN )
1745 return AI_GOAL_NOT_KNOWN;
1746 Int3(); // get allender -- bad logic
1749 // for rearm repair ships, a goal is only achievable if the support ship isn't repairing anything
1750 // else at the time, or is set to repair the ship for this goal. All other goals should be placed
1751 // on hold by returning GOAL_NOT_KNOWN.
1752 case AI_GOAL_REARM_REPAIR: {
1755 // short circuit a couple of cases. Ship not arrived shouldn't happen. Ship gone means
1756 // we mark the goal as not achievable.
1757 if ( status == SHIP_STATUS_NOT_ARRIVED ) {
1758 Int3(); // get Allender. this shouldn't happen!!!
1759 return AI_GOAL_NOT_ACHIEVABLE;
1762 if ( status == SHIP_STATUS_GONE )
1763 return AI_GOAL_NOT_ACHIEVABLE;
1765 Assert( aigp->ship_name );
1766 shipnum = ship_name_lookup( aigp->ship_name );
1768 // if desitnation currently being repaired, then goal is stil active
1769 if ( Ai_info[Ships[shipnum].ai_index].ai_flags & AIF_BEING_REPAIRED )
1770 return AI_GOAL_ACHIEVABLE;
1772 // if the destination ship is dying or departing (but not completed yet), the mark goal as
1774 if ( Ships[shipnum].flags & (SF_DYING | SF_DEPARTING) )
1775 return AI_GOAL_NOT_ACHIEVABLE;
1777 // if the destination object is no longer awaiting repair, then remove the item
1778 if ( !(Ai_info[Ships[shipnum].ai_index].ai_flags & AIF_AWAITING_REPAIR) )
1779 return AI_GOAL_NOT_ACHIEVABLE;
1781 // not repairing anything means that he can do this goal!!!
1782 if ( !(aip->ai_flags & AIF_REPAIRING) )
1783 return AI_GOAL_ACHIEVABLE;
1786 if ( aip->goal_objnum == -1 ) {
1787 // -- MK, 11/9/97 -- I was always hitting this: Int3();
1788 return AI_GOAL_ACHIEVABLE;
1791 // if he is repairing something, he can satisfy his repair goal (his goal_objnum)
1792 // return GOAL_NOT_KNOWN which is kind of a hack which puts the goal on hold until it can be
1794 if ( aip->goal_objnum != Ships[shipnum].objnum )
1795 return AI_GOAL_NOT_KNOWN;
1797 return AI_GOAL_ACHIEVABLE;
1801 Int3(); // invalid case in switch:
1804 return AI_GOAL_NOT_KNOWN;
1807 // Compare function for system qsort() for sorting ai_goals based on priority.
1808 // Return values set to sort array in _decreasing_ order.
1809 int ai_goal_priority_compare(const void *a, const void *b)
1816 // first, sort based on whether or not the ON_HOLD flag is set for the goal.
1817 // If the flag is set, don't push the goal higher in the list even if priority
1818 // is higher since goal cannot currently be achieved.
1820 if ( (ga->flags & AIGF_GOAL_ON_HOLD) && !(gb->flags & AIGF_GOAL_ON_HOLD) )
1822 else if ( !(ga->flags & AIGF_GOAL_ON_HOLD) && (gb->flags & AIGF_GOAL_ON_HOLD) )
1825 // check whether or not the goal override flag is set. If it is set, then push this goal higher
1828 else if ( (ga->flags & AIGF_GOAL_OVERRIDE) && !(gb->flags & AIGF_GOAL_OVERRIDE) )
1830 else if ( !(ga->flags & AIGF_GOAL_OVERRIDE) && (gb->flags & AIGF_GOAL_OVERRIDE) )
1833 // now normal priority processing
1835 if (ga->priority > gb->priority)
1837 else if ( ga->priority < gb->priority )
1840 if ( ga->time > gb->time )
1843 else if ( ga->time > gb->time )
1848 else // if ( ga->time < gb->time ) // this way prevents element swapping if times happen to be equal (which they should not)
1854 // Prioritize goal list.
1855 // First sort on priority.
1856 // Then sort on time for goals of equivalent priority.
1857 // objnum The object number to act upon. Redundant with *aip.
1858 // *aip The AI info to act upon. Goals are stored at aip->goals
1859 void prioritize_goals(int objnum, ai_info *aip)
1862 // First sort based on priority field.
1863 qsort(aip->goals, MAX_AI_GOALS, sizeof(ai_goal), ai_goal_priority_compare);
1867 // Scan the list of goals at aip->goals.
1868 // Remove obsolete goals.
1869 // objnum Object of interest. Redundant with *aip.
1870 // *aip contains goals at aip->goals.
1871 void validate_mission_goals(int objnum, ai_info *aip)
1875 // loop through all of the goals to determine which goal should be followed.
1876 // This determination will be based on priority, and the time at which it was issued.
1877 for ( i = 0; i < MAX_AI_GOALS; i++ ) {
1881 aigp = &aip->goals[i];
1883 // quick check to see if this goal is valid or not, or if we are trying to process the
1885 if (aigp->ai_mode == AI_GOAL_NONE)
1888 // purge any goals which should get purged
1889 if ( aigp->flags & AIGF_PURGE ) {
1890 ai_remove_ship_goal( aip, i );
1894 state = ai_mission_goal_achievable( objnum, aigp );
1896 // if this order is no longer a valid one, remove it
1897 if ( (state == AI_GOAL_NOT_ACHIEVABLE) || (state == AI_GOAL_SATISFIED) ) {
1898 ai_remove_ship_goal( aip, i );
1902 // if the status is achievable, and the on_hold flag is set, clear the flagb
1903 if ( (state == AI_GOAL_ACHIEVABLE) && (aigp->flags & AIGF_GOAL_ON_HOLD) )
1904 aigp->flags &= ~AIGF_GOAL_ON_HOLD;
1906 // if the goal is not known, then set the ON_HOLD flag so that it doesn't get counted as
1907 // a goal to be pursued
1908 if ( state == AI_GOAL_NOT_KNOWN )
1909 aigp->flags |= AIGF_GOAL_ON_HOLD; // put this goal on hold until it becomes true
1912 // if we had an active goal, and that goal is now in hold, make the mode AIM_NONE. If a new valid
1913 // goal is produced after prioritizing, then the mode will get reset immediately. Otherwise, setting
1914 // the mode to none will force ship to do default behavior.
1915 if ( (aip->goals[0].ai_mode != AI_GOAL_NONE) && (aip->goals[0].flags & AIGF_GOAL_ON_HOLD) )
1916 aip->mode = AIM_NONE;
1918 // if the active goal is a rearm/repair goal, the put all other valid goals (which are not repair goals)
1920 if ( (aip->goals[0].ai_mode == AI_GOAL_REARM_REPAIR) && (aip->ai_flags & AIF_DOCKED) ) {
1921 for ( i = 1; i < MAX_AI_GOALS; i++ ) {
1922 if ( (aip->goals[i].ai_mode == AI_GOAL_NONE) || (aip->goals[i].ai_mode == AI_GOAL_REARM_REPAIR) )
1924 aip->goals[i].flags |= AIGF_GOAL_ON_HOLD;
1930 /* Not used, debugging stuff
1931 static char *Goal_text[5] = {
1941 extern char *Mode_text[MAX_AI_BEHAVIORS];
1943 // code to process ai "orders". Orders include those determined from the mission file and those
1944 // given by the player to a ship that is under his control. This function gets called for every
1945 // AI object every N seconds through the ai loop.
1946 void ai_process_mission_orders( int objnum, ai_info *aip )
1948 object *objp = &Objects[objnum];
1950 ai_goal *current_goal;
1951 int wingnum, shipnum;
1952 int original_signature;
1954 /* if (!stricmp(Ships[objp->instance].ship_name, "gtt comet")) {
1955 for (int i=0; i<MAX_AI_GOALS; i++) {
1956 if (aip->goals[i].signature != -1) {
1957 nprintf(("AI", "%6.1f: mode=%s, type=%s, ship=%s\n", f2fl(Missiontime), Mode_text[aip->goals[i].ai_mode], Goal_text[aip->goals[i].type], aip->goals[i].ship_name));
1960 nprintf(("AI", "\n"));
1964 // AL 12-12-97: If a ship is entering/leaving a docking bay, wait until path
1965 // following is finished before pursuing goals.
1966 if ( aip->mode == AIM_BAY_EMERGE || aip->mode == AIM_BAY_DEPART ) {
1970 // Goal #0 is always the active goal, as we maintain a sorted list.
1971 // Get the signature to see if sorting it again changes it.
1972 original_signature = aip->goals[0].signature;
1974 validate_mission_goals(objnum, aip);
1976 // Sort the goal array by priority and other factors.
1977 prioritize_goals(objnum, aip);
1979 // Make sure there's a goal to pursue, else return.
1980 if (aip->goals[0].signature == -1) {
1981 if (aip->mode == AIM_NONE)
1982 ai_do_default_behavior(objp);
1986 // If goal didn't change, return.
1987 if ((aip->active_goal != -1) && (aip->goals[0].signature == original_signature))
1990 // if the first goal in the list has the ON_HOLD flag, set, there is no current valid goal
1992 if ( aip->goals[0].flags & AIGF_GOAL_ON_HOLD )
1995 // Kind of a hack for now. active_goal means the goal currently being pursued.
1996 // It will always be #0 since the list is prioritized.
1997 aip->active_goal = 0;
1999 //nprintf(("AI", "New goal for %s = %i\n", Ships[objp->instance].ship_name, aip->goals[0].ai_mode));
2001 current_goal = &aip->goals[0];
2003 if ( MULTIPLAYER_MASTER ){
2004 send_ai_info_update_packet( objp, AI_UPDATE_ORDERS );
2007 // if this object was flying in formation off of another object, remove the flag that tells him
2008 // to do this. The form-on-my-wing command is removed from the goal list as soon as it is called, so
2009 // we are safe removing this bit here.
2010 aip->ai_flags &= ~AIF_FORMATION_OBJECT;
2012 // AL 3-7-98: If this is a player ship, and the goal is not a formation goal, then do a quick out
2013 if ( (objp->flags & OF_PLAYER_SHIP) && (current_goal->ai_mode != AI_GOAL_FORM_ON_WING) ) {
2017 switch ( current_goal->ai_mode ) {
2020 if ( current_goal->ship_name ) {
2021 shipnum = ship_name_lookup( current_goal->ship_name );
2022 Assert (shipnum != -1 ); // shouldn't get here if this is false!!!!
2023 other_obj = &Objects[Ships[shipnum].objnum];
2025 other_obj = NULL; // we get this case when we tell ship to engage enemy!
2027 // Mike -- debug code!
2028 // If a ship has a subobject on it, attack that instead of the main ship!
2029 ai_attack_object( objp, other_obj, current_goal->priority, NULL);
2032 case AI_GOAL_CHASE_WEAPON:
2033 Assert( Weapons[current_goal->wp_index].objnum != -1 );
2034 other_obj = &Objects[Weapons[current_goal->wp_index].objnum];
2035 ai_attack_object( objp, other_obj, current_goal->priority, NULL );
2039 shipnum = ship_name_lookup( current_goal->ship_name );
2040 Assert (shipnum != -1 ); // shouldn't get here if this is false!!!!
2041 other_obj = &Objects[Ships[shipnum].objnum];
2042 // shipnum and other_obj are the shipnumber and object pointer of the object that you should
2044 if (objp != other_obj) {
2045 ai_set_guard_object(objp, other_obj);
2046 aip->submode_start_time = Missiontime;
2048 mprintf(("Warning: Ship %s told to guard itself. Goal ignored.\n", Ships[objp->instance].ship_name));
2050 // -- What the hell is this doing here?? -- MK, 7/30/97 -- ai_do_default_behavior( objp );
2053 case AI_GOAL_GUARD_WING:
2054 wingnum = wing_name_lookup( current_goal->ship_name );
2055 Assert (wingnum != -1 ); // shouldn't get here if this is false!!!!
2056 ai_set_guard_wing(objp, wingnum);
2057 aip->submode_start_time = Missiontime;
2060 case AI_GOAL_WAYPOINTS: // do nothing for waypoints
2061 case AI_GOAL_WAYPOINTS_ONCE: {
2064 if ( current_goal->ai_mode == AI_GOAL_WAYPOINTS)
2065 flags |= WPF_REPEAT;
2066 ai_start_waypoints(objp, current_goal->wp_index, flags);
2070 case AI_GOAL_DOCK: {
2071 shipnum = ship_name_lookup( current_goal->ship_name );
2072 Assert (shipnum != -1 ); // shouldn't get here if this is false!!!!
2073 other_obj = &Objects[Ships[shipnum].objnum];
2075 // be sure that we have indices for docking points here! If we ever had names, they should
2076 // get fixed up in goal_achievable so that the points can be checked there for validity
2077 Assert ( !(current_goal->flags & AIGF_DOCKER_NAME_VALID) );
2078 Assert ( !(current_goal->flags & AIGF_DOCKEE_NAME_VALID) );
2079 ai_dock_with_object( objp, other_obj, current_goal->priority, AIDO_DOCK, current_goal->docker.index, current_goal->dockee.index );
2080 aip->submode_start_time = Missiontime;
2084 case AI_GOAL_UNDOCK:
2085 // try to find the object which which this object is docked with. Use that object as the
2086 // "other object" for the undocking proceedure. If "other object" isn't found, then the undock
2087 // goal cannot continue. Spit out a warning and remove the goal.
2088 other_obj = ai_find_docked_object( objp );
2089 if ( other_obj == NULL ) {
2091 // assume that the guy he was docked with doesn't exist anymore. (i.e. a cargo containuer
2092 // can get destroyed while docked with a freighter.) We should just remove this goal and
2093 // let this ship pick up it's next goal.
2094 ai_mission_goal_complete( aip ); // mark as complete, so we can remove it and move on!!!
2097 ai_dock_with_object( objp, other_obj, current_goal->priority, AIDO_UNDOCK, 0, 0 );
2098 aip->submode_start_time = Missiontime;
2102 // when destroying a subsystem, we can destroy a specific instance of a subsystem
2103 // or all instances of a type of subsystem (i.e. a specific engine or all engines).
2104 // the ai_submode value is > 0 for a specific instance of subsystem and < 0 for all
2105 // instances of a specific type
2106 case AI_GOAL_DESTROY_SUBSYSTEM:
2107 case AI_GOAL_DISABLE_SHIP:
2108 case AI_GOAL_DISARM_SHIP: {
2109 shipnum = ship_name_lookup( current_goal->ship_name );
2110 other_obj = &Objects[Ships[shipnum].objnum];
2111 ai_attack_object( objp, other_obj, current_goal->priority, NULL);
2112 ai_set_attack_subsystem( objp, current_goal->ai_submode ); // submode stored the subsystem type
2113 if (current_goal->ai_mode != AI_GOAL_DESTROY_SUBSYSTEM) {
2114 if (aip->target_objnum != -1) {
2115 // Only protect if _not_ a capital ship. We don't want the Lucifer accidentally getting protected.
2116 if (!(Ship_info[Ships[shipnum].ship_info_index].flags & SIF_HUGE_SHIP))
2117 Objects[aip->target_objnum].flags |= OF_PROTECTED;
2119 } else // Just in case this ship had been protected, unprotect it.
2120 if (aip->target_objnum != -1)
2121 Objects[aip->target_objnum].flags &= ~OF_PROTECTED;
2126 case AI_GOAL_CHASE_WING:
2127 wingnum = wing_name_lookup( current_goal->ship_name );
2128 ai_attack_wing(objp, wingnum, current_goal->priority);
2131 case AI_GOAL_CHASE_ANY:
2132 ai_attack_object( objp, NULL, current_goal->priority, NULL );
2135 case AI_GOAL_WARP: {
2138 index = current_goal->wp_index;
2139 ai_set_mode_warp_out( objp, aip );
2143 case AI_GOAL_EVADE_SHIP:
2144 shipnum = ship_name_lookup( current_goal->ship_name );
2145 other_obj = &Objects[Ships[shipnum].objnum];
2146 ai_evade_object( objp, other_obj, current_goal->priority );
2149 case AI_GOAL_STAY_STILL:
2150 // for now, ignore any other parameters!!!!
2151 // clear out the object's goals. Seems to me that if a ship is staying still for a purpose
2152 // then we need to clear everything out since there is not a real way to get rid of this goal
2153 // clearing out goals is okay here since we are now what mode to set this AI object to.
2154 ai_clear_ship_goals( aip );
2155 ai_stay_still( objp, NULL );
2158 case AI_GOAL_PLAY_DEAD:
2159 // if a ship is playing dead, MWA says that it shouldn't try to do anything else.
2160 // clearing out goals is okay here since we are now what mode to set this AI object to.
2161 ai_clear_ship_goals( aip );
2162 aip->mode = AIM_PLAY_DEAD;
2166 case AI_GOAL_FORM_ON_WING:
2167 // for form on wing, we need to clear out all goals for this ship, and then call the form
2169 // clearing out goals is okay here since we are now what mode to set this AI object to.
2170 ai_clear_ship_goals( aip );
2171 shipnum = ship_name_lookup( current_goal->ship_name );
2172 other_obj = &Objects[Ships[shipnum].objnum];
2173 ai_form_on_wing( objp, other_obj );
2176 // labels for support ship commands
2178 case AI_GOAL_STAY_NEAR_SHIP: {
2179 shipnum = ship_name_lookup( current_goal->ship_name );
2180 other_obj = &Objects[Ships[shipnum].objnum];
2181 // todo MK: hook to keep support ship near other_obj -- other_obj could be the player object!!!
2182 float dist = 300.0f; // How far away to stay from ship. Should be set in SEXP?
2183 ai_do_stay_near(objp, other_obj, dist);
2187 case AI_GOAL_KEEP_SAFE_DISTANCE:
2188 // todo MK: hook to keep support ship at a safe distance
2191 case AI_GOAL_REARM_REPAIR:
2192 shipnum = ship_name_lookup( current_goal->ship_name );
2193 other_obj = &Objects[Ships[shipnum].objnum];
2194 ai_rearm_repair( objp, other_obj, current_goal->priority, current_goal->docker.index, current_goal->dockee.index );
2204 void ai_update_goal_references(ai_goal *goals, int type, char *old_name, char *new_name)
2206 int i, mode, flag, dummy;
2208 for (i=0; i<MAX_AI_GOALS; i++) // loop through all the goals in the Ai_info entry
2210 mode = goals[i].ai_mode;
2215 case REF_TYPE_PLAYER:
2220 case AI_GOAL_DESTROY_SUBSYSTEM:
2222 case AI_GOAL_DISABLE_SHIP:
2223 case AI_GOAL_DISARM_SHIP:
2224 case AI_GOAL_IGNORE:
2225 case AI_GOAL_EVADE_SHIP:
2226 case AI_GOAL_STAY_NEAR_SHIP:
2234 case AI_GOAL_CHASE_WING:
2235 case AI_GOAL_GUARD_WING:
2240 case REF_TYPE_WAYPOINT:
2243 case AI_GOAL_WAYPOINTS:
2244 case AI_GOAL_WAYPOINTS_ONCE:
2252 case AI_GOAL_WAYPOINTS:
2253 case AI_GOAL_WAYPOINTS_ONCE:
2260 if (flag) // is this a valid goal to parse for this conversion?
2261 if (!stricmp(goals[i].ship_name, old_name)) {
2262 if (*new_name == '<') // target was just deleted..
2263 goals[i].ai_mode = AI_GOAL_NONE;
2265 goals[i].ship_name = ai_get_goal_ship_name(new_name, &dummy);
2270 int query_referenced_in_ai_goals(ai_goal *goals, int type, char *name)
2274 for (i=0; i<MAX_AI_GOALS; i++) // loop through all the goals in the Ai_info entry
2276 mode = goals[i].ai_mode;
2285 case AI_GOAL_DESTROY_SUBSYSTEM:
2287 case AI_GOAL_DISABLE_SHIP:
2288 case AI_GOAL_DISARM_SHIP:
2289 case AI_GOAL_IGNORE:
2290 case AI_GOAL_EVADE_SHIP:
2291 case AI_GOAL_STAY_NEAR_SHIP:
2299 case AI_GOAL_CHASE_WING:
2300 case AI_GOAL_GUARD_WING:
2305 case REF_TYPE_WAYPOINT:
2308 case AI_GOAL_WAYPOINTS:
2309 case AI_GOAL_WAYPOINTS_ONCE:
2317 case AI_GOAL_WAYPOINTS:
2318 case AI_GOAL_WAYPOINTS_ONCE:
2324 if (flag) // is this a valid goal to parse for this conversion?
2326 if (!stricmp(goals[i].ship_name, name))
2334 char *ai_add_dock_name(char *str)
2339 Assert(strlen(str) < NAME_LENGTH - 1);
2340 for (i=0; i<Num_ai_dock_names; i++)
2341 if (!stricmp(Ai_dock_names[i], str))
2342 return Ai_dock_names[i];
2344 Assert(Num_ai_dock_names < MAX_AI_DOCK_NAMES);
2345 ptr = Ai_dock_names[Num_ai_dock_names++];