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