1 /* $Id: mission.c,v 1.25 2004-08-28 23:17:45 schaffner Exp $ */
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.
17 * Code to handle multiple missions
44 mle Mission_list[MAX_MISSIONS];
46 int Current_mission_num;
47 int N_secret_levels; // Made a global by MK for scoring purposes. August 1, 1995.
48 char *Current_mission_filename,*Current_mission_longname;
50 int Builtin_mission_num;
51 char Builtin_mission_filename[9];
52 int Builtin_mission_hogsize;
54 int D1_Builtin_mission_num;
55 char D1_Builtin_mission_filename[9];
56 int D1_Builtin_mission_hogsize;
58 //this stuff should get defined elsewhere
60 char Level_names[MAX_LEVELS_PER_MISSION][FILENAME_LEN];
61 char Secret_level_names[MAX_SECRET_LEVELS_PER_MISSION][FILENAME_LEN];
63 //values for d1 built-in mission
64 #define BIM_LAST_LEVEL 27
65 #define BIM_LAST_SECRET_LEVEL -3
66 #define BIM_BRIEFING_FILE "briefing.tex"
67 #define BIM_ENDING_FILE "endreg.tex"
70 // Special versions of mission routines for d1 builtins
73 int load_mission_d1(int mission_num)
77 cfile_use_descent1_hogfile("descent.hog");
79 Current_mission_num = mission_num;
80 Current_mission_filename = Mission_list[mission_num].filename;
81 Current_mission_longname = Mission_list[mission_num].mission_name;
83 switch (D1_Builtin_mission_hogsize) {
84 case D1_SHAREWARE_MISSION_HOGSIZE:
85 case D1_SHAREWARE_10_MISSION_HOGSIZE:
89 Last_secret_level = 0;
92 for (i=0;i<Last_level;i++)
93 sprintf(Level_names[i], "level%02d.sdl", i+1);
96 case D1_MAC_SHARE_MISSION_HOGSIZE:
100 Last_secret_level = 0;
103 for (i=0;i<Last_level;i++)
104 sprintf(Level_names[i], "level%02d.sdl", i+1);
107 case D1_OEM_MISSION_HOGSIZE:
108 case D1_OEM_10_MISSION_HOGSIZE:
112 Last_secret_level = -1;
115 for (i=0; i < Last_level - 1; i++)
116 sprintf(Level_names[i], "level%02d.rdl", i+1);
117 sprintf(Level_names[i], "saturn%02d.rdl", i+1);
118 for (i=0; i < -Last_secret_level; i++)
119 sprintf(Secret_level_names[i], "levels%1d.rdl", i+1);
121 Secret_level_table[0] = 10;
125 Int3(); // fall through
126 case D1_MISSION_HOGSIZE:
127 case D1_10_MISSION_HOGSIZE:
128 case D1_MAC_MISSION_HOGSIZE:
131 Last_level = BIM_LAST_LEVEL;
132 Last_secret_level = BIM_LAST_SECRET_LEVEL;
135 for (i=0;i<Last_level;i++)
136 sprintf(Level_names[i], "level%02d.rdl", i+1);
137 for (i=0;i<-Last_secret_level;i++)
138 sprintf(Secret_level_names[i], "levels%1d.rdl", i+1);
140 Secret_level_table[0] = 10;
141 Secret_level_table[1] = 21;
142 Secret_level_table[2] = 24;
146 strcpy(Briefing_text_filename,BIM_BRIEFING_FILE);
147 strcpy(Ending_text_filename,BIM_ENDING_FILE);
154 // Special versions of mission routines for shareware
157 int load_mission_shareware(int mission_num)
159 Current_mission_num = mission_num;
160 Current_mission_filename = Mission_list[mission_num].filename;
161 Current_mission_longname = Mission_list[mission_num].mission_name;
163 switch (Builtin_mission_hogsize) {
164 case MAC_SHARE_MISSION_HOGSIZE:
168 Last_secret_level = -1;
170 // mac demo is using the regular hog and rl2 files
171 strcpy(Level_names[0],"d2leva-1.rl2");
172 strcpy(Level_names[1],"d2leva-2.rl2");
173 strcpy(Level_names[2],"d2leva-3.rl2");
174 strcpy(Level_names[3],"d2leva-4.rl2");
175 strcpy(Secret_level_names[0],"d2leva-s.rl2");
178 Int3(); // fall through
179 case SHAREWARE_MISSION_HOGSIZE:
183 Last_secret_level = 0;
185 strcpy(Level_names[0],"d2leva-1.sl2");
186 strcpy(Level_names[1],"d2leva-2.sl2");
187 strcpy(Level_names[2],"d2leva-3.sl2");
195 // Special versions of mission routines for Diamond/S3 version
198 int load_mission_oem(int mission_num)
200 Current_mission_num = mission_num;
201 Current_mission_filename = Mission_list[mission_num].filename;
202 Current_mission_longname = Mission_list[mission_num].mission_name;
207 Last_secret_level = -2;
209 strcpy(Level_names[0],"d2leva-1.rl2");
210 strcpy(Level_names[1],"d2leva-2.rl2");
211 strcpy(Level_names[2],"d2leva-3.rl2");
212 strcpy(Level_names[3],"d2leva-4.rl2");
214 strcpy(Secret_level_names[0],"d2leva-s.rl2");
216 strcpy(Level_names[4],"d2levb-1.rl2");
217 strcpy(Level_names[5],"d2levb-2.rl2");
218 strcpy(Level_names[6],"d2levb-3.rl2");
219 strcpy(Level_names[7],"d2levb-4.rl2");
221 strcpy(Secret_level_names[1],"d2levb-s.rl2");
223 Secret_level_table[0] = 1;
224 Secret_level_table[1] = 5;
230 //strips damn newline from end of line
231 char *mfgets(char *s,int n,CFILE *f)
236 if (r && s[strlen(s)-1] == '\n')
242 //compare a string for a token. returns true if match
243 int istok(char *buf,char *tok)
245 return strnicmp(buf,tok,strlen(tok)) == 0;
249 //adds a terminating 0 after a string at the first white space
250 void add_term(char *s)
252 while (*s && !isspace(*s)) s++;
257 //returns ptr to string after '=' & white space, or NULL if no '='
258 //adds 0 after parm at first white space
259 char *get_value(char *buf)
263 t = strchr(buf,'=')+1;
266 while (*t && isspace(*t)) t++;
272 return NULL; //error!
275 //reads a line, returns ptr to value of passed parm. returns NULL if none
276 char *get_parm_value(char *parm,CFILE *f)
280 if (!mfgets(buf,80,f))
284 return get_value(buf);
289 int ml_sort_func(mle *e0,mle *e1)
291 return stricmp(e0->mission_name,e1->mission_name);
295 extern char CDROM_dir[];
297 //returns 1 if file read ok, else 0
298 int read_mission_file(char *filename,int count,int location)
303 //printf("reading: %s\n", filename);
307 strcpy(filename2,MISSION_DIR);
311 songs_stop_redbook(); //so we can read from the CD
312 strcpy(filename2,CDROM_dir);
316 Int3(); //fall through
319 strcpy(filename2,"");
322 strcat(filename2,filename);
324 mfile = cfopen(filename2,"rb");
328 char temp[FILENAME_LEN],*t;
330 strcpy(temp,filename);
331 if ((t = strchr(temp,'.')) == NULL)
332 return 0; //missing extension
333 // look if it's .mn2 or .msn
334 Mission_list[count].descent_version = (t[3] == '2') ? 2 : 1;
335 *t = 0; //kill extension
337 strncpy( Mission_list[count].filename, temp, 9 );
338 Mission_list[count].anarchy_only_flag = 0;
339 Mission_list[count].location = location;
341 p = get_parm_value("name",mfile);
343 if (!p) { //try enhanced mission
344 cfseek(mfile,0,SEEK_SET);
345 p = get_parm_value("xname",mfile);
348 if (!p) { //try super-enhanced mission!
349 cfseek(mfile,0,SEEK_SET);
350 p = get_parm_value("zname",mfile);
355 if ((t=strchr(p,';'))!=NULL)
358 while (isspace(*t)) t--;
359 strncpy(Mission_list[count].mission_name,p,MISSION_NAME_LEN);
366 p = get_parm_value("type",mfile);
370 Mission_list[count].anarchy_only_flag = istok(p,"anarchy");
380 void add_d1_builtin_mission_to_list(int *count)
382 if (!cfexist("descent.hog"))
385 D1_Builtin_mission_hogsize = cfile_size("descent.hog");
387 switch (D1_Builtin_mission_hogsize) {
388 case D1_SHAREWARE_MISSION_HOGSIZE:
389 case D1_SHAREWARE_10_MISSION_HOGSIZE:
390 case D1_MAC_SHARE_MISSION_HOGSIZE:
391 strcpy(Mission_list[*count].filename, D1_MISSION_FILENAME);
392 strcpy(Mission_list[*count].mission_name, D1_SHAREWARE_MISSION_NAME);
393 Mission_list[*count].anarchy_only_flag = 0;
395 case D1_OEM_MISSION_HOGSIZE:
396 case D1_OEM_10_MISSION_HOGSIZE:
397 strcpy(Mission_list[*count].filename, D1_MISSION_FILENAME);
398 strcpy(Mission_list[*count].mission_name, D1_OEM_MISSION_NAME);
399 Mission_list[*count].anarchy_only_flag = 0;
402 Warning("Unknown D1 hogsize %d\n", D1_Builtin_mission_hogsize);
405 case D1_MISSION_HOGSIZE:
406 case D1_10_MISSION_HOGSIZE:
407 case D1_MAC_MISSION_HOGSIZE:
408 strcpy(Mission_list[*count].filename, D1_MISSION_FILENAME);
409 strcpy(Mission_list[*count].mission_name, D1_MISSION_NAME);
410 Mission_list[*count].anarchy_only_flag = 0;
414 strcpy(D1_Builtin_mission_filename, Mission_list[*count].filename);
415 Mission_list[*count].descent_version = 1;
416 Mission_list[*count].anarchy_only_flag = 0;
421 void add_builtin_mission_to_list(int *count)
423 Builtin_mission_hogsize = cfile_size("descent2.hog");
424 if (Builtin_mission_hogsize == -1)
425 Builtin_mission_hogsize = cfile_size("d2demo.hog");
427 switch (Builtin_mission_hogsize) {
428 case SHAREWARE_MISSION_HOGSIZE:
429 case MAC_SHARE_MISSION_HOGSIZE:
430 strcpy(Mission_list[*count].filename,SHAREWARE_MISSION_FILENAME);
431 strcpy(Mission_list[*count].mission_name,SHAREWARE_MISSION_NAME);
432 Mission_list[*count].anarchy_only_flag = 0;
434 case OEM_MISSION_HOGSIZE:
435 strcpy(Mission_list[*count].filename,OEM_MISSION_FILENAME);
436 strcpy(Mission_list[*count].mission_name,OEM_MISSION_NAME);
437 Mission_list[*count].anarchy_only_flag = 0;
440 Warning("Unknown hogsize %d, trying %s\n", Builtin_mission_hogsize, FULL_MISSION_FILENAME ".mn2");
441 Int3(); //fall through
442 case FULL_MISSION_HOGSIZE:
443 case FULL_10_MISSION_HOGSIZE:
444 case MAC_FULL_MISSION_HOGSIZE:
445 if (!read_mission_file(FULL_MISSION_FILENAME ".mn2", 0, ML_CURDIR))
446 Error("Could not find required mission file <%s>", FULL_MISSION_FILENAME ".mn2");
449 strcpy(Builtin_mission_filename, Mission_list[*count].filename);
450 Mission_list[*count].descent_version = 2;
451 Mission_list[*count].anarchy_only_flag = 0;
456 void add_missions_to_list(char *search_name, int *count, int anarchy_mode)
459 if( !FileFindFirst( search_name, &find ) ) {
461 if (read_mission_file( find.name, *count, ML_MISSIONDIR )) {
463 if (anarchy_mode || !Mission_list[*count].anarchy_only_flag)
467 } while( !FileFindNext( &find ) && *count < MAX_MISSIONS);
469 if (*count >= MAX_MISSIONS)
470 mprintf((0, "Warning: more missions than d2x can handle\n"));
474 /* move <mission_name> to <place> on mission list, increment <place> */
475 void promote (char * mission_name, int * top_place, int num_missions)
478 char name[FILENAME_LEN], * t;
479 strcpy(name, mission_name);
480 if ((t = strchr(name,'.')) != NULL)
481 *t = 0; //kill extension
482 //printf("promoting: %s\n", name);
483 for (i = *top_place; i < num_missions; i++)
484 if (!stricmp(Mission_list[i].filename, name)) {
485 //swap mission positions
488 temp = Mission_list[*top_place];
489 Mission_list[*top_place] = Mission_list[i];
490 Mission_list[i] = temp;
498 //fills in the global list of missions. Returns the number of missions
499 //in the list. If anarchy_mode set, don't include non-anarchy levels.
501 extern char CDROM_dir[];
502 extern char AltHogDir[];
503 extern char AltHogdir_initialized;
505 int build_mission_list(int anarchy_mode)
507 static int num_missions=-1;
511 //now search for levels on disk
513 //@@Took out this code because after this routine was called once for
514 //@@a list of single-player missions, a subsequent call for a list of
515 //@@anarchy missions would not scan again, and thus would not find the
516 //@@anarchy-only missions. If we retain the minimum level of install,
517 //@@we may want to put the code back in, having it always scan for all
518 //@@missions, and have the code that uses it sort out the ones it wants.
519 //@@ if (num_missions != -1) {
520 //@@ if (Current_mission_num != 0)
521 //@@ load_mission(0); //set built-in mission as default
522 //@@ return num_missions;
525 add_builtin_mission_to_list(&count); //read built-in first
526 add_d1_builtin_mission_to_list(&count);
527 add_missions_to_list(MISSION_DIR "*.mn2", &count, anarchy_mode);
528 add_missions_to_list(MISSION_DIR "*.msn", &count, anarchy_mode);
530 if (AltHogdir_initialized) {
531 char search_name[PATH_MAX + 5];
532 strcpy(search_name, AltHogDir);
533 strcat(search_name, "/" MISSION_DIR "*.mn2");
534 add_missions_to_list(search_name, &count, anarchy_mode);
535 strcpy(search_name, AltHogDir);
536 strcat(search_name, "/" MISSION_DIR "*.msn");
537 add_missions_to_list(search_name, &count, anarchy_mode);
540 // move original missions (in story-chronological order)
541 // to top of mission list
543 promote("descent", &top_place, count); // original descent 1 mission
544 D1_Builtin_mission_num = top_place - 1;
545 promote(Builtin_mission_filename, &top_place, count); // d2 or d2demo
546 Builtin_mission_num = top_place - 1;
547 promote("d2x", &top_place, count); // vertigo
549 if (count > top_place)
550 qsort(&Mission_list[top_place],
552 sizeof(*Mission_list),
553 (int (*)( const void *, const void * ))ml_sort_func);
556 if (count > top_place)
557 qsort(&Mission_list[top_place],
559 sizeof(*Mission_list),
560 (int (*)( const void *, const void * ))ml_sort_func);
562 //load_mission(0); //set built-in mission as default
564 num_missions = count;
569 void init_extra_robot_movie(char *filename);
571 //values for built-in mission
573 //loads the specfied mission from the mission list.
574 //build_mission_list() must have been called.
575 //Returns true if mission loaded ok, else false.
576 int load_mission(int mission_num)
581 int enhanced_mission = 0;
583 if (mission_num == D1_Builtin_mission_num) {
584 cfile_use_descent1_hogfile("descent.hog");
585 switch (D1_Builtin_mission_hogsize) {
587 Int3(); // fall through
588 case D1_MISSION_HOGSIZE:
589 case D1_10_MISSION_HOGSIZE:
590 case D1_MAC_MISSION_HOGSIZE:
591 case D1_OEM_MISSION_HOGSIZE:
592 case D1_OEM_10_MISSION_HOGSIZE:
593 case D1_SHAREWARE_MISSION_HOGSIZE:
594 case D1_SHAREWARE_10_MISSION_HOGSIZE:
595 case D1_MAC_SHARE_MISSION_HOGSIZE:
596 return load_mission_d1(mission_num);
601 if (mission_num == Builtin_mission_num) {
602 switch (Builtin_mission_hogsize) {
603 case SHAREWARE_MISSION_HOGSIZE:
604 case MAC_SHARE_MISSION_HOGSIZE:
605 return load_mission_shareware(mission_num);
607 case OEM_MISSION_HOGSIZE:
608 return load_mission_oem(mission_num);
611 Int3(); // fall through
612 case FULL_MISSION_HOGSIZE:
613 case FULL_10_MISSION_HOGSIZE:
614 case MAC_FULL_MISSION_HOGSIZE:
615 // continue on... (use d2.mn2 from hogfile)
620 Current_mission_num = mission_num;
622 mprintf(( 0, "Loading mission %d\n", mission_num ));
624 //read mission from file
626 switch (Mission_list[mission_num].location) {
628 strcpy(buf,MISSION_DIR);
631 strcpy(buf,CDROM_dir);
634 Int3(); //fall through
639 strcat(buf,Mission_list[mission_num].filename);
640 if (Mission_list[mission_num].descent_version == 2)
645 mfile = cfopen(buf,"rb");
647 Current_mission_num = -1;
651 //for non-builtin missions, load HOG
652 if (strcmp(Mission_list[mission_num].filename, Builtin_mission_filename)) {
654 strcpy(buf+strlen(buf)-4,".hog"); //change extension
656 found_hogfile = cfile_use_alternate_hogfile(buf);
658 #ifdef RELEASE //for release, require mission to be in hogfile
659 if (! found_hogfile) {
661 Current_mission_num = -1;
666 // for Descent 1 missions, load descent.hog
667 if (Mission_list[mission_num].descent_version == 1 && strcmp(buf, "descent.hog"))
668 if (!cfile_use_descent1_hogfile("descent.hog"))
669 Warning("descent.hog not available, this mission may be missing some files required for briefings and exit sequence\n");
674 Last_secret_level = 0;
675 Briefing_text_filename[0] = 0;
676 Ending_text_filename[0] = 0;
678 while (mfgets(buf,80,mfile)) {
680 if (istok(buf,"name"))
681 continue; //already have name, go to next line
682 if (istok(buf,"xname")) {
683 enhanced_mission = 1;
684 continue; //already have name, go to next line
686 if (istok(buf,"zname")) {
687 enhanced_mission = 2;
688 continue; //already have name, go to next line
690 else if (istok(buf,"type"))
691 continue; //already have name, go to next line
692 else if (istok(buf,"hog")) {
695 while (*(bufp++) != '=')
699 while (*(++bufp) == ' ')
702 cfile_use_alternate_hogfile(bufp);
703 mprintf((0, "Hog file override = [%s]\n", bufp));
705 else if (istok(buf,"briefing")) {
706 if ((v = get_value(buf)) != NULL) {
709 strcpy(Briefing_text_filename,v);
712 else if (istok(buf,"ending")) {
713 if ((v = get_value(buf)) != NULL) {
716 strcpy(Ending_text_filename,v);
719 else if (istok(buf,"num_levels")) {
721 if ((v=get_value(buf))!=NULL) {
726 for (i=0;i<n_levels && mfgets(buf,80,mfile);i++) {
729 if (strlen(buf) <= 12) {
730 strcpy(Level_names[i],buf);
739 else if (istok(buf,"num_secrets")) {
740 if ((v=get_value(buf))!=NULL) {
743 N_secret_levels = atoi(v);
745 Assert(N_secret_levels <= MAX_SECRET_LEVELS_PER_MISSION);
747 for (i=0;i<N_secret_levels && mfgets(buf,80,mfile);i++) {
751 if ((t=strchr(buf,','))!=NULL) *t++=0;
756 if (strlen(buf) <= 12) {
757 strcpy(Secret_level_names[i],buf);
758 Secret_level_table[i] = atoi(t);
759 if (Secret_level_table[i]<1 || Secret_level_table[i]>Last_level)
774 if (Last_level <= 0) {
775 Current_mission_num = -1; //no valid mission loaded
779 Current_mission_filename = Mission_list[Current_mission_num].filename;
780 Current_mission_longname = Mission_list[Current_mission_num].mission_name;
782 if (enhanced_mission) {
784 extern void bm_read_extra_robots();
785 sprintf(t,"%s.ham",Current_mission_filename);
786 bm_read_extra_robots(t,enhanced_mission);
787 strncpy(t,Current_mission_filename,6);
789 init_extra_robot_movie(t);
795 //loads the named mission if exists.
796 //Returns true if mission loaded ok, else false.
797 int load_mission_by_name(char *mission_name)
801 n = build_mission_list(1);
804 if (!stricmp(mission_name,Mission_list[i].filename))
805 return load_mission(i);
807 return 0; //couldn't find mission