main/ai.h

   1 /*
   2 THE COMPUTER CODE CONTAINED HEREIN IS THE SOLE PROPERTY OF PARALLAX
   3 SOFTWARE CORPORATION ("PARALLAX").  PARALLAX, IN DISTRIBUTING THE CODE TO
   4 END-USERS, AND SUBJECT TO ALL OF THE TERMS AND CONDITIONS HEREIN, GRANTS A
   5 ROYALTY-FREE, PERPETUAL LICENSE TO SUCH END-USERS FOR USE BY SUCH END-USERS
   6 IN USING, DISPLAYING,  AND CREATING DERIVATIVE WORKS THEREOF, SO LONG AS
   7 SUCH USE, DISPLAY OR CREATION IS FOR NON-COMMERCIAL, ROYALTY OR REVENUE
   8 FREE PURPOSES.  IN NO EVENT SHALL THE END-USER USE THE COMPUTER CODE
   9 CONTAINED HEREIN FOR REVENUE-BEARING PURPOSES.  THE END-USER UNDERSTANDS
  10 AND AGREES TO THE TERMS HEREIN AND ACCEPTS THE SAME BY USE OF THIS FILE.
  11 COPYRIGHT 1993-1999 PARALLAX SOFTWARE CORPORATION.  ALL RIGHTS RESERVED.
  12 */
  13
  14 /*
  15  *
  16  * Header file for AI system.
  17  *
  18  */
  19
  20 #ifndef _AI_H
  21 #define _AI_H
  22
  23 #include <stdio.h>
  24
  25 #include "object.h"
  26 #include "fvi.h"
  27 #include "robot.h"
  28
  29 #define PLAYER_AWARENESS_INITIAL_TIME   (3*F1_0)
  30 #define MAX_PATH_LENGTH                 30          // Maximum length of path in ai path following.
  31 #define MAX_DEPTH_TO_SEARCH_FOR_PLAYER  10
  32 #define BOSS_GATE_MATCEN_NUM            -1
  33 #define MAX_BOSS_TELEPORT_SEGS          100
  34 #define BOSS_ECLIP_NUM                  53
  35
  36 #define ROBOT_BRAIN 7
  37 #define ROBOT_BOSS1 17
  38
  39 #define ROBOT_FIRE_AGITATION 94
  40
  41 #define BOSS_D2     21 // Minimum D2 boss value.
  42 #define BOSS_COOL   21
  43 #define BOSS_WATER  22
  44 #define BOSS_FIRE   23
  45 #define BOSS_ICE    24
  46 #define BOSS_ALIEN1 25
  47 #define BOSS_ALIEN2 26
  48
  49 #define NUM_D2_BOSSES 8
  50
  51 extern ubyte Boss_teleports[NUM_D2_BOSSES];     // Set byte if this boss can teleport
  52 extern ubyte Boss_spew_more[NUM_D2_BOSSES];     // Set byte if this boss can teleport
  53 //extern ubyte Boss_cloaks[NUM_D2_BOSSES];        // Set byte if this boss can cloak
  54 extern ubyte Boss_spews_bots_energy[NUM_D2_BOSSES];     // Set byte if boss spews bots when hit by energy weapon.
  55 extern ubyte Boss_spews_bots_matter[NUM_D2_BOSSES];     // Set byte if boss spews bots when hit by matter weapon.
  56 extern ubyte Boss_invulnerable_energy[NUM_D2_BOSSES];   // Set byte if boss is invulnerable to energy weapons.
  57 extern ubyte Boss_invulnerable_matter[NUM_D2_BOSSES];   // Set byte if boss is invulnerable to matter weapons.
  58 extern ubyte Boss_invulnerable_spot[NUM_D2_BOSSES];     // Set byte if boss is invulnerable in all but a certain spot.  (Dot product fvec|vec_to_collision < BOSS_INVULNERABLE_DOT)
  59
  60 extern fix Boss_cloak_start_time, Boss_cloak_end_time;
  61 extern int Num_boss_teleport_segs;
  62 extern short Boss_teleport_segs[MAX_BOSS_TELEPORT_SEGS];
  63 extern fix Last_teleport_time;
  64 extern fix Boss_cloak_duration;
  65
  66 extern ai_local Ai_local_info[MAX_OBJECTS];
  67 extern vms_vector Believed_player_pos;
  68 extern int Believed_player_seg;
  69
  70 extern void move_towards_segment_center(object *objp);
  71 extern int gate_in_robot(int type, int segnum);
  72 extern void do_ai_movement(object *objp);
  73 extern void ai_move_to_new_segment( object * obj, short newseg, int first_time );
  74 // extern void ai_follow_path( object * obj, short newseg, int first_time );
  75 extern void ai_recover_from_wall_hit(object *obj, int segnum);
  76 extern void ai_move_one(object *objp);
  77 extern void do_ai_frame(object *objp);
  78 extern void init_ai_object(int objnum, int initial_mode, int hide_segment);
  79 extern void update_player_awareness(object *objp, fix new_awareness);
  80 extern void create_awareness_event(object *objp, int type);         // object *objp can create awareness of player, amount based on "type"
  81 extern void do_ai_frame_all(void);
  82 extern void init_ai_system(void);
  83 extern void reset_ai_states(object *objp);
  84 extern int create_path_points(object *objp, int start_seg, int end_seg, point_seg *point_segs, short *num_points, int max_depth, int random_flag, int safety_flag, int avoid_seg);
  85 extern void create_all_paths(void);
  86 extern void create_path_to_station(object *objp, int max_length);
  87 extern void ai_follow_path(object *objp, int player_visibility, int previous_visibility, vms_vector *vec_to_player);
  88 extern void ai_turn_towards_vector(vms_vector *vec_to_player, object *obj, fix rate);
  89 extern void ai_turn_towards_vel_vec(object *objp, fix rate);
  90 extern void init_ai_objects(void);
  91 extern void do_ai_robot_hit(object *robot, int type);
  92 extern void create_n_segment_path(object *objp, int path_length, int avoid_seg);
  93 extern void create_n_segment_path_to_door(object *objp, int path_length, int avoid_seg);
  94 extern void make_random_vector(vms_vector *vec);
  95 extern void init_robots_for_level(void);
  96 extern int ai_behavior_to_mode(int behavior);
  97 extern int Robot_firing_enabled;
  98 extern void create_path_to_segment(object *objp, int goalseg, int max_length, int safety_flag);
  99 extern int ready_to_fire(robot_info *robptr, ai_local *ailp);
 100 extern int polish_path(object *objp, point_seg *psegs, int num_points);
 101 extern void move_towards_player(object *objp, vms_vector *vec_to_player);
 102
 103 // max_length is maximum depth of path to create.
 104 // If -1, use default: MAX_DEPTH_TO_SEARCH_FOR_PLAYER
 105 extern void create_path_to_player(object *objp, int max_length, int safety_flag);
 106 extern void attempt_to_resume_path(object *objp);
 107
 108 // When a robot and a player collide, some robots attack!
 109 extern void do_ai_robot_hit_attack(object *robot, object *player, vms_vector *collision_point);
 110 extern void ai_open_doors_in_segment(object *robot);
 111 extern int ai_door_is_openable(object *objp, segment *segp, int sidenum);
 112 extern int player_is_visible_from_object(object *objp, vms_vector *pos, fix field_of_view, vms_vector *vec_to_player);
 113 extern void ai_reset_all_paths(void);   // Reset all paths.  Call at the start of a level.
 114 extern int ai_multiplayer_awareness(object *objp, int awareness_level);
 115
 116 // In escort.c
 117 extern void do_escort_frame(object *objp, fix dist_to_player, int player_visibility);
 118 extern void do_snipe_frame(object *objp, fix dist_to_player, int player_visibility, vms_vector *vec_to_player);
 119 extern void do_thief_frame(object *objp, fix dist_to_player, int player_visibility, vms_vector *vec_to_player);
 120
 121 #ifndef NDEBUG
 122 extern void force_dump_ai_objects_all(char *msg);
 123 #else
 124 #define force_dump_ai_objects_all(msg)
 125 #endif
 126
 127 extern void start_boss_death_sequence(object *objp);
 128 extern void ai_init_boss_for_ship(void);
 129 extern int Boss_been_hit;
 130 extern fix AI_proc_time;
 131
 132 // Stuff moved from ai.c by MK on 05/25/95.
 133 #define ANIM_RATE       (F1_0/16)
 134 #define DELTA_ANG_SCALE 16
 135
 136 #define OVERALL_AGITATION_MAX   100
 137 #define MAX_AI_CLOAK_INFO       8   // Must be a power of 2!
 138
 139 typedef struct {
 140         fix         last_time;
 141         int         last_segment;
 142         vms_vector  last_position;
 143 } ai_cloak_info;
 144
 145 #define BOSS_CLOAK_DURATION (F1_0*7)
 146 #define BOSS_DEATH_DURATION (F1_0*6)
 147
 148 #define CHASE_TIME_LENGTH   (F1_0*8)
 149 #define DEFAULT_ROBOT_SOUND_VOLUME F1_0
 150
 151 extern fix Dist_to_last_fired_upon_player_pos;
 152 extern vms_vector Last_fired_upon_player_pos;
 153 extern int Laser_rapid_fire;
 154
 155 #define MAX_AWARENESS_EVENTS 64
 156 typedef struct awareness_event {
 157         short       segnum; // segment the event occurred in
 158         short       type;   // type of event, defines behavior
 159         vms_vector  pos;    // absolute 3 space location of event
 160 } awareness_event;
 161
 162 #define AIS_MAX 8
 163 #define AIE_MAX 4
 164
 165 #define ESCORT_GOAL_UNSPECIFIED -1
 166
 167 #define ESCORT_GOAL_UNSPECIFIED -1
 168 #define ESCORT_GOAL_BLUE_KEY    1
 169 #define ESCORT_GOAL_GOLD_KEY    2
 170 #define ESCORT_GOAL_RED_KEY     3
 171 #define ESCORT_GOAL_CONTROLCEN  4
 172 #define ESCORT_GOAL_EXIT        5
 173
 174 // Custom escort goals.
 175 #define ESCORT_GOAL_ENERGY      6
 176 #define ESCORT_GOAL_ENERGYCEN   7
 177 #define ESCORT_GOAL_SHIELD      8
 178 #define ESCORT_GOAL_POWERUP     9
 179 #define ESCORT_GOAL_ROBOT       10
 180 #define ESCORT_GOAL_HOSTAGE     11
 181 #define ESCORT_GOAL_PLAYER_SPEW 12
 182 #define ESCORT_GOAL_SCRAM       13
 183 #define ESCORT_GOAL_EXIT2       14
 184 #define ESCORT_GOAL_BOSS        15
 185 #define ESCORT_GOAL_MARKER1     16
 186 #define ESCORT_GOAL_MARKER2     17
 187 #define ESCORT_GOAL_MARKER3     18
 188 #define ESCORT_GOAL_MARKER4     19
 189 #define ESCORT_GOAL_MARKER5     20
 190 #define ESCORT_GOAL_MARKER6     21
 191 #define ESCORT_GOAL_MARKER7     22
 192 #define ESCORT_GOAL_MARKER8     23
 193 #define ESCORT_GOAL_MARKER9     24
 194
 195 #define MAX_ESCORT_GOALS        25
 196
 197 #define MAX_ESCORT_DISTANCE     (F1_0*80)
 198 #define MIN_ESCORT_DISTANCE     (F1_0*40)
 199
 200 #define FUELCEN_CHECK           1000
 201
 202 extern fix Escort_last_path_created;
 203 extern int Escort_goal_object, Escort_special_goal, Escort_goal_index;
 204
 205 #define GOAL_WIDTH 11
 206
 207 #define SNIPE_RETREAT_TIME  (F1_0*5)
 208 #define SNIPE_ABORT_RETREAT_TIME (SNIPE_RETREAT_TIME/2) // Can abort a retreat with this amount of time left in retreat
 209 #define SNIPE_ATTACK_TIME   (F1_0*10)
 210 #define SNIPE_WAIT_TIME     (F1_0*5)
 211 #define SNIPE_FIRE_TIME     (F1_0*2)
 212
 213 #define THIEF_PROBABILITY   16384   // 50% chance of stealing an item at each attempt
 214 #define MAX_STOLEN_ITEMS    10      // Maximum number kept track of, will keep stealing, causes stolen weapons to be lost!
 215
 216 extern int   Max_escort_length;
 217 extern int   Escort_kill_object;
 218 extern ubyte Stolen_items[MAX_STOLEN_ITEMS];
 219 extern fix   Escort_last_path_created;
 220 extern int   Escort_goal_object, Escort_special_goal, Escort_goal_index;
 221
 222 extern void  create_buddy_bot(void);
 223
 224 extern int   Max_escort_length;
 225
 226 extern char  *Escort_goal_text[MAX_ESCORT_GOALS];
 227
 228 extern void  ai_multi_send_robot_position(int objnum, int force);
 229
 230 extern int   Flinch_scale;
 231 extern int   Attack_scale;
 232 extern sbyte Mike_to_matt_xlate[];
 233
 234 // Amount of time since the current robot was last processed for things such as movement.
 235 // It is not valid to use FrameTime because robots do not get moved every frame.
 236
 237 extern int   Num_boss_teleport_segs;
 238 extern short Boss_teleport_segs[];
 239 extern int   Num_boss_gate_segs;
 240 extern short Boss_gate_segs[];
 241
 242
 243 // --------- John: These variables must be saved as part of gamesave. ---------
 244 extern int              Ai_initialized;
 245 extern int              Overall_agitation;
 246 extern ai_local         Ai_local_info[MAX_OBJECTS];
 247 extern point_seg        Point_segs[MAX_POINT_SEGS];
 248 extern point_seg        *Point_segs_free_ptr;
 249 extern ai_cloak_info    Ai_cloak_info[MAX_AI_CLOAK_INFO];
 250 extern fix              Boss_cloak_start_time;
 251 extern fix              Boss_cloak_end_time;
 252 extern fix              Last_teleport_time;
 253 extern fix              Boss_teleport_interval;
 254 extern fix              Boss_cloak_interval;        // Time between cloaks
 255 extern fix              Boss_cloak_duration;
 256 extern fix              Last_gate_time;
 257 extern fix              Gate_interval;
 258 extern fix              Boss_dying_start_time;
 259 extern sbyte            Boss_dying, Boss_dying_sound_playing;
 260 extern fix              Boss_hit_time;
 261 // -- extern int              Boss_been_hit;
 262 // ------ John: End of variables which must be saved as part of gamesave. -----
 263
 264 extern int  ai_evaded;
 265
 266 extern sbyte Super_boss_gate_list[];
 267 #define MAX_GATE_INDEX  25
 268
 269 extern int  Ai_info_enabled;
 270 extern int  Robot_firing_enabled;
 271
 272
 273 // These globals are set by a call to find_vector_intersection, which is a slow routine,
 274 // so we don't want to call it again (for this object) unless we have to.
 275 extern vms_vector   Hit_pos;
 276 extern int          Hit_type, Hit_seg;
 277 extern fvi_info     Hit_data;
 278
 279 extern int              Num_awareness_events;
 280 extern awareness_event  Awareness_events[MAX_AWARENESS_EVENTS];
 281
 282 extern vms_vector       Believed_player_pos;
 283
 284 #ifndef NDEBUG
 285 // Index into this array with ailp->mode
 286 extern char *mode_text[18];
 287
 288 // Index into this array with aip->behavior
 289 extern char behavior_text[6][9];
 290
 291 // Index into this array with aip->GOAL_STATE or aip->CURRENT_STATE
 292 extern char state_text[8][5];
 293
 294 extern int Do_ai_flag, Break_on_object;
 295
 296 extern void mprintf_animation_info(object *objp);
 297
 298 #endif //ifndef NDEBUG
 299
 300 extern int Stolen_item_index;   // Used in ai.c for controlling rate of Thief flare firing.
 301
 302 extern void ai_frame_animation(object *objp);
 303 extern int do_silly_animation(object *objp);
 304 extern int openable_doors_in_segment(int segnum);
 305 extern void compute_vis_and_vec(object *objp, vms_vector *pos, ai_local *ailp, vms_vector *vec_to_player, int *player_visibility, robot_info *robptr, int *flag);
 306 extern void do_firing_stuff(object *obj, int player_visibility, vms_vector *vec_to_player);
 307 extern int maybe_ai_do_actual_firing_stuff(object *obj, ai_static *aip);
 308 extern void ai_do_actual_firing_stuff(object *obj, ai_static *aip, ai_local *ailp, robot_info *robptr, vms_vector *vec_to_player, fix dist_to_player, vms_vector *gun_point, int player_visibility, int object_animates, int gun_num);
 309 extern void do_super_boss_stuff(object *objp, fix dist_to_player, int player_visibility);
 310 extern void do_boss_stuff(object *objp, int player_visibility);
 311 // -- unused, 08/07/95 -- extern void ai_turn_randomly(vms_vector *vec_to_player, object *obj, fix rate, int previous_visibility);
 312 extern void ai_move_relative_to_player(object *objp, ai_local *ailp, fix dist_to_player, vms_vector *vec_to_player, fix circle_distance, int evade_only, int player_visibility);
 313 extern void move_away_from_player(object *objp, vms_vector *vec_to_player, int attack_type);
 314 extern void move_towards_vector(object *objp, vms_vector *vec_goal, int dot_based);
 315 extern void init_ai_frame(void);
 316
 317 extern void create_bfs_list(int start_seg, short bfs_list[], int *length, int max_segs);
 318 extern void init_thief_for_level();
 319
 320
 321 extern int Escort_goal_object;
 322
 323 extern int ai_save_state(PHYSFS_file * fp);
 324 extern int ai_restore_state(PHYSFS_file *fp, int version);
 325
 326 extern int Buddy_objnum, Buddy_allowed_to_talk;
 327
 328 extern void start_robot_death_sequence(object *objp);
 329 extern int do_any_robot_dying_frame(object *objp);
 330 extern void buddy_message(char * format, ... );
 331
 332 #define SPECIAL_REACTOR_ROBOT   65
 333 extern void special_reactor_stuff(void);
 334
 335 #endif /* _AI_H */