1 /* $Id: mission.c,v 1.33 2004-12-02 16:41:54 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
46 #include "ignorecase.h"
48 //values for d1 built-in mission
49 #define BIM_LAST_LEVEL 27
50 #define BIM_LAST_SECRET_LEVEL -3
51 #define BIM_BRIEFING_FILE "briefing.tex"
52 #define BIM_ENDING_FILE "endreg.tex"
56 char mission_name[MISSION_NAME_LEN+1];
57 char filename[9]; // filename without extension
58 ubyte descent_version; // descent 1 or descent 2?
59 bool anarchy_only_flag; // if true, mission is anarchy only
60 int builtin_hogsize; // This is used to determine the version. Only for the built in mission.
61 ubyte location; // see defines below
64 //values that describe where a mission is located
66 #define ML_MISSIONDIR 1
69 mle Mission_list[MAX_MISSIONS];
71 int num_missions = -1;
73 Mission *Current_mission = NULL; // currently loaded mission
76 // Special versions of mission routines for d1 builtins
79 int load_mission_d1(void)
83 switch (cfile_size("descent.hog")) {
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(void)
159 strcpy(Current_mission->mission_name, SHAREWARE_MISSION_NAME);
160 Current_mission->descent_version = 2;
161 Current_mission->anarchy_only_flag = 0;
163 switch (Current_mission->builtin_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(void)
200 strcpy(Current_mission->mission_name, OEM_MISSION_NAME);
201 Current_mission->descent_version = 2;
202 Current_mission->anarchy_only_flag = 0;
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 //compare a string for a token. returns true if match
231 int istok(char *buf,char *tok)
233 return strnicmp(buf,tok,strlen(tok)) == 0;
237 //adds a terminating 0 after a string at the first white space
238 void add_term(char *s)
240 while (*s && !isspace(*s)) s++;
245 //returns ptr to string after '=' & white space, or NULL if no '='
246 //adds 0 after parm at first white space
247 char *get_value(char *buf)
251 t = strchr(buf,'=')+1;
254 while (*t && isspace(*t)) t++;
260 return NULL; //error!
263 //reads a line, returns ptr to value of passed parm. returns NULL if none
264 char *get_parm_value(char *parm,CFILE *f)
268 if (!cfgets(buf,80,f))
272 return get_value(buf);
277 int ml_sort_func(mle *e0,mle *e1)
279 return stricmp(e0->mission_name,e1->mission_name);
283 extern char CDROM_dir[];
285 //returns 1 if file read ok, else 0
286 int read_mission_file(char *filename,int count,int location)
291 //printf("reading: %s\n", filename);
295 strcpy(filename2,MISSION_DIR);
299 songs_stop_redbook(); //so we can read from the CD
300 strcpy(filename2,CDROM_dir);
304 Int3(); //fall through
307 strcpy(filename2,"");
310 strcat(filename2,filename);
312 mfile = cfopen(filename2,"rb");
316 char temp[FILENAME_LEN],*t;
318 strcpy(temp,filename);
319 if ((t = strchr(temp,'.')) == NULL)
320 return 0; //missing extension
321 // look if it's .mn2 or .msn
322 Mission_list[count].descent_version = (t[3] == '2') ? 2 : 1;
323 *t = 0; //kill extension
325 strncpy( Mission_list[count].filename, temp, 9 );
326 Mission_list[count].anarchy_only_flag = 0;
327 Mission_list[count].location = location;
329 p = get_parm_value("name",mfile);
331 if (!p) { //try enhanced mission
332 cfseek(mfile,0,SEEK_SET);
333 p = get_parm_value("xname",mfile);
336 if (!p) { //try super-enhanced mission!
337 cfseek(mfile,0,SEEK_SET);
338 p = get_parm_value("zname",mfile);
343 if ((t=strchr(p,';'))!=NULL)
346 while (isspace(*t)) t--;
347 strncpy(Mission_list[count].mission_name,p,MISSION_NAME_LEN);
354 p = get_parm_value("type",mfile);
358 Mission_list[count].anarchy_only_flag = istok(p,"anarchy");
368 void add_d1_builtin_mission_to_list(int *count)
372 if (!cfexist("descent.hog"))
375 size = cfile_size("descent.hog");
378 case D1_SHAREWARE_MISSION_HOGSIZE:
379 case D1_SHAREWARE_10_MISSION_HOGSIZE:
380 case D1_MAC_SHARE_MISSION_HOGSIZE:
381 strcpy(Mission_list[*count].filename, D1_MISSION_FILENAME);
382 strcpy(Mission_list[*count].mission_name, D1_SHAREWARE_MISSION_NAME);
383 Mission_list[*count].anarchy_only_flag = 0;
385 case D1_OEM_MISSION_HOGSIZE:
386 case D1_OEM_10_MISSION_HOGSIZE:
387 strcpy(Mission_list[*count].filename, D1_MISSION_FILENAME);
388 strcpy(Mission_list[*count].mission_name, D1_OEM_MISSION_NAME);
389 Mission_list[*count].anarchy_only_flag = 0;
392 Warning("Unknown D1 hogsize %d\n", size);
395 case D1_MISSION_HOGSIZE:
396 case D1_10_MISSION_HOGSIZE:
397 case D1_MAC_MISSION_HOGSIZE:
398 strcpy(Mission_list[*count].filename, D1_MISSION_FILENAME);
399 strcpy(Mission_list[*count].mission_name, D1_MISSION_NAME);
400 Mission_list[*count].anarchy_only_flag = 0;
404 Mission_list[*count].builtin_hogsize = 0;
405 Mission_list[*count].descent_version = 1;
406 Mission_list[*count].anarchy_only_flag = 0;
411 void add_builtin_mission_to_list(int *count, char *name)
413 int size = cfile_size("descent2.hog");
416 size = cfile_size("d2demo.hog");
419 case SHAREWARE_MISSION_HOGSIZE:
420 case MAC_SHARE_MISSION_HOGSIZE:
421 strcpy(Mission_list[*count].filename,SHAREWARE_MISSION_FILENAME);
422 strcpy(Mission_list[*count].mission_name,SHAREWARE_MISSION_NAME);
423 Mission_list[*count].anarchy_only_flag = 0;
425 case OEM_MISSION_HOGSIZE:
426 strcpy(Mission_list[*count].filename,OEM_MISSION_FILENAME);
427 strcpy(Mission_list[*count].mission_name,OEM_MISSION_NAME);
428 Mission_list[*count].anarchy_only_flag = 0;
431 Warning("Unknown hogsize %d, trying %s\n", size, FULL_MISSION_FILENAME ".mn2");
432 Int3(); //fall through
433 case FULL_MISSION_HOGSIZE:
434 case FULL_10_MISSION_HOGSIZE:
435 case MAC_FULL_MISSION_HOGSIZE:
436 if (!read_mission_file(FULL_MISSION_FILENAME ".mn2", 0, ML_CURDIR))
437 Error("Could not find required mission file <%s>", FULL_MISSION_FILENAME ".mn2");
440 strcpy(name, Mission_list[*count].filename);
441 Mission_list[*count].builtin_hogsize = size;
442 Mission_list[*count].descent_version = 2;
443 Mission_list[*count].anarchy_only_flag = 0;
448 void add_missions_to_list(int *count, int anarchy_mode)
450 char **find, **i, *ext;
452 find = PHYSFS_enumerateFiles(MISSION_DIR);
454 for (i = find; *i != NULL; i++)
456 ext = strrchr(*i, '.');
457 if (ext && (!strnicmp(ext, ".msn", 4) || !strnicmp(ext, ".mn2", 4)))
458 if (read_mission_file(*i, *count, ML_MISSIONDIR))
459 if (anarchy_mode || !Mission_list[*count].anarchy_only_flag) {
461 Mission_list[*count].builtin_hogsize = 0;
463 if (*count >= MAX_MISSIONS)
465 mprintf((0, "Warning: more missions than d2x can handle\n"));
470 PHYSFS_freeList(find);
473 /* move <mission_name> to <place> on mission list, increment <place> */
474 void promote (char * mission_name, int * top_place, int num_missions)
477 char name[FILENAME_LEN], * t;
478 strcpy(name, mission_name);
479 if ((t = strchr(name,'.')) != NULL)
480 *t = 0; //kill extension
481 //printf("promoting: %s\n", name);
482 for (i = *top_place; i < num_missions; i++)
483 if (!stricmp(Mission_list[i].filename, name)) {
484 //swap mission positions
487 temp = Mission_list[*top_place];
488 Mission_list[*top_place] = Mission_list[i];
489 Mission_list[i] = temp;
495 void free_mission(void)
497 // May become more complex with the editor
498 if (Current_mission) {
499 d_free(Current_mission);
505 //fills in the global list of missions. Returns the number of missions
506 //in the list. If anarchy_mode is set, then also add anarchy-only missions.
508 extern char CDROM_dir[];
510 extern char AltHogDir[];
511 extern char AltHogdir_initialized;
514 int build_mission_list(int anarchy_mode)
516 static int num_missions=-1;
519 char builtin_mission_filename[FILENAME_LEN];
521 //now search for levels on disk
523 //@@Took out this code because after this routine was called once for
524 //@@a list of single-player missions, a subsequent call for a list of
525 //@@anarchy missions would not scan again, and thus would not find the
526 //@@anarchy-only missions. If we retain the minimum level of install,
527 //@@we may want to put the code back in, having it always scan for all
528 //@@missions, and have the code that uses it sort out the ones it wants.
529 //@@ if (num_missions != -1) {
530 //@@ if (Current_mission_num != 0)
531 //@@ load_mission(0); //set built-in mission as default
532 //@@ return num_missions;
535 add_builtin_mission_to_list(&count, builtin_mission_filename); //read built-in first
536 add_d1_builtin_mission_to_list(&count);
537 add_missions_to_list(&count, anarchy_mode);
539 // move original missions (in story-chronological order)
540 // to top of mission list
542 promote("descent", &top_place, count); // original descent 1 mission
543 promote(builtin_mission_filename, &top_place, count); // d2 or d2demo
544 promote("d2x", &top_place, count); // vertigo
546 if (count > top_place)
547 qsort(&Mission_list[top_place],
549 sizeof(*Mission_list),
550 (int (*)( const void *, const void * ))ml_sort_func);
553 if (count > top_place)
554 qsort(&Mission_list[top_place],
556 sizeof(*Mission_list),
557 (int (*)( const void *, const void * ))ml_sort_func);
559 //load_mission(0); //set built-in mission as default
561 num_missions = count;
563 atexit(free_mission);
568 void init_extra_robot_movie(char *filename);
570 //values for built-in mission
572 //loads the specfied mission from the mission list.
573 //build_mission_list() must have been called.
574 //Returns true if mission loaded ok, else false.
575 int load_mission(int mission_num)
583 Current_mission = d_malloc(sizeof(Mission));
584 if (!Current_mission) return 0;
585 *(mle *) Current_mission = Mission_list[mission_num];
587 // for Descent 1 missions, load descent.hog
589 if (!cfile_init("descent.hog"))
590 Warning("descent.hog not available, this mission may be missing some files required for briefings and exit sequence\n");
591 if (!stricmp(Current_mission_filename, D1_MISSION_FILENAME))
592 return load_mission_d1();
595 if (PLAYING_BUILTIN_MISSION) {
596 switch (Current_mission->builtin_hogsize) {
597 case SHAREWARE_MISSION_HOGSIZE:
598 case MAC_SHARE_MISSION_HOGSIZE:
599 return load_mission_shareware();
601 case OEM_MISSION_HOGSIZE:
602 return load_mission_oem();
605 Int3(); // fall through
606 case FULL_MISSION_HOGSIZE:
607 case FULL_10_MISSION_HOGSIZE:
608 case MAC_FULL_MISSION_HOGSIZE:
609 // continue on... (use d2.mn2 from hogfile)
614 mprintf(( 0, "Loading mission %s\n", Current_mission_filename ));
616 //read mission from file
618 switch (Mission_list[mission_num].location) {
620 strcpy(buf,MISSION_DIR);
623 strcpy(buf,CDROM_dir);
626 Int3(); //fall through
631 strcat(buf,Mission_list[mission_num].filename);
632 if (Mission_list[mission_num].descent_version == 2)
637 PHYSFSEXT_locateCorrectCase(buf);
639 mfile = cfopen(buf,"rb");
645 //for non-builtin missions, load HOG
646 if (!PLAYING_BUILTIN_MISSION) {
648 strcpy(buf+strlen(buf)-4,".hog"); //change extension
650 PHYSFSEXT_locateCorrectCase(buf);
652 found_hogfile = cfile_init(buf);
654 #ifdef RELEASE //for release, require mission to be in hogfile
655 if (! found_hogfile) {
665 Last_secret_level = 0;
666 Briefing_text_filename[0] = 0;
667 Ending_text_filename[0] = 0;
669 while (cfgets(buf,80,mfile)) {
671 if (istok(buf,"name")) {
672 Current_mission->enhanced = 0;
673 continue; //already have name, go to next line
675 if (istok(buf,"xname")) {
676 Current_mission->enhanced = 1;
677 continue; //already have name, go to next line
679 if (istok(buf,"zname")) {
680 Current_mission->enhanced = 2;
681 continue; //already have name, go to next line
683 else if (istok(buf,"type"))
684 continue; //already have name, go to next line
685 else if (istok(buf,"hog")) {
688 while (*(bufp++) != '=')
692 while (*(++bufp) == ' ')
696 mprintf((0, "Hog file override = [%s]\n", bufp));
698 else if (istok(buf,"briefing")) {
699 if ((v = get_value(buf)) != NULL) {
702 strcpy(Briefing_text_filename,v);
705 else if (istok(buf,"ending")) {
706 if ((v = get_value(buf)) != NULL) {
709 strcpy(Ending_text_filename,v);
712 else if (istok(buf,"num_levels")) {
714 if ((v=get_value(buf))!=NULL) {
719 for (i=0;i<n_levels && cfgets(buf,80,mfile);i++) {
722 if (strlen(buf) <= 12) {
723 strcpy(Level_names[i],buf);
732 else if (istok(buf,"num_secrets")) {
733 if ((v=get_value(buf))!=NULL) {
736 N_secret_levels = atoi(v);
738 Assert(N_secret_levels <= MAX_SECRET_LEVELS_PER_MISSION);
740 for (i=0;i<N_secret_levels && cfgets(buf,80,mfile);i++) {
744 if ((t=strchr(buf,','))!=NULL) *t++=0;
749 if (strlen(buf) <= 12) {
750 strcpy(Secret_level_names[i],buf);
751 Secret_level_table[i] = atoi(t);
752 if (Secret_level_table[i]<1 || Secret_level_table[i]>Last_level)
767 if (Last_level <= 0) {
768 free_mission(); //no valid mission loaded
772 if (Current_mission->enhanced) {
774 extern void bm_read_extra_robots();
775 sprintf(t,"%s.ham",Current_mission_filename);
776 bm_read_extra_robots(t, Current_mission->enhanced);
777 strncpy(t,Current_mission_filename,6);
778 init_extra_robot_movie(t);
784 //loads the named mission if exists.
785 //Returns true if mission loaded ok, else false.
786 int load_mission_by_name(char *mission_name)
790 n = build_mission_list(1);
793 if (!stricmp(mission_name,Mission_list[i].filename))
794 return load_mission(i);
796 return 0; //couldn't find mission
799 int select_mission(int anarchy_mode, char *message)
803 n_missions = build_mission_list(anarchy_mode);
805 if (n_missions <= 1) {
808 int new_mission_num,i, default_mission;
809 char * m[MAX_MISSIONS];
812 for (i=0;i<n_missions;i++) {
813 m[i] = Mission_list[i].mission_name;
814 if ( !stricmp( m[i], config_last_mission ) )
818 new_mission_num = newmenu_listbox1( message, n_missions, m, 1, default_mission, NULL );
820 if (new_mission_num == -1)
823 strcpy(config_last_mission, m[new_mission_num] );
825 if (!load_mission(new_mission_num)) {
826 nm_messagebox( NULL, 1, TXT_OK, TXT_MISSION_ERROR);