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