1 /* $Id: mission.c,v 1.37 2004-12-17 14:28:41 btb 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 *filename; // filename without extension
57 int builtin_hogsize; // if it's the built-in mission, used for determining the version
58 char mission_name[MISSION_NAME_LEN+1];
59 ubyte descent_version; // descent 1 or descent 2?
60 ubyte anarchy_only_flag; // if true, mission is anarchy only
61 ubyte location; // see defines below
64 //values that describe where a mission is located
66 #define ML_MISSIONDIR 1
69 int num_missions = -1;
71 Mission *Current_mission = NULL; // currently loaded mission
74 // Special versions of mission routines for d1 builtins
77 int load_mission_d1(void)
81 switch (cfile_size("descent.hog")) {
82 case D1_SHAREWARE_MISSION_HOGSIZE:
83 case D1_SHAREWARE_10_MISSION_HOGSIZE:
87 Last_secret_level = 0;
90 for (i=0;i<Last_level;i++)
91 sprintf(Level_names[i], "level%02d.sdl", i+1);
94 case D1_MAC_SHARE_MISSION_HOGSIZE:
98 Last_secret_level = 0;
101 for (i=0;i<Last_level;i++)
102 sprintf(Level_names[i], "level%02d.sdl", i+1);
105 case D1_OEM_MISSION_HOGSIZE:
106 case D1_OEM_10_MISSION_HOGSIZE:
110 Last_secret_level = -1;
113 for (i=0; i < Last_level - 1; i++)
114 sprintf(Level_names[i], "level%02d.rdl", i+1);
115 sprintf(Level_names[i], "saturn%02d.rdl", i+1);
116 for (i=0; i < -Last_secret_level; i++)
117 sprintf(Secret_level_names[i], "levels%1d.rdl", i+1);
119 Secret_level_table[0] = 10;
123 Int3(); // fall through
124 case D1_MISSION_HOGSIZE:
125 case D1_10_MISSION_HOGSIZE:
126 case D1_MAC_MISSION_HOGSIZE:
129 Last_level = BIM_LAST_LEVEL;
130 Last_secret_level = BIM_LAST_SECRET_LEVEL;
133 for (i=0;i<Last_level;i++)
134 sprintf(Level_names[i], "level%02d.rdl", i+1);
135 for (i=0;i<-Last_secret_level;i++)
136 sprintf(Secret_level_names[i], "levels%1d.rdl", i+1);
138 Secret_level_table[0] = 10;
139 Secret_level_table[1] = 21;
140 Secret_level_table[2] = 24;
144 strcpy(Briefing_text_filename,BIM_BRIEFING_FILE);
145 strcpy(Ending_text_filename,BIM_ENDING_FILE);
152 // Special versions of mission routines for shareware
155 int load_mission_shareware(void)
157 strcpy(Current_mission->mission_name, SHAREWARE_MISSION_NAME);
158 Current_mission->descent_version = 2;
159 Current_mission->anarchy_only_flag = 0;
161 switch (Current_mission->builtin_hogsize) {
162 case MAC_SHARE_MISSION_HOGSIZE:
166 Last_secret_level = -1;
168 // mac demo is using the regular hog and rl2 files
169 strcpy(Level_names[0],"d2leva-1.rl2");
170 strcpy(Level_names[1],"d2leva-2.rl2");
171 strcpy(Level_names[2],"d2leva-3.rl2");
172 strcpy(Level_names[3],"d2leva-4.rl2");
173 strcpy(Secret_level_names[0],"d2leva-s.rl2");
176 Int3(); // fall through
177 case SHAREWARE_MISSION_HOGSIZE:
181 Last_secret_level = 0;
183 strcpy(Level_names[0],"d2leva-1.sl2");
184 strcpy(Level_names[1],"d2leva-2.sl2");
185 strcpy(Level_names[2],"d2leva-3.sl2");
193 // Special versions of mission routines for Diamond/S3 version
196 int load_mission_oem(void)
198 strcpy(Current_mission->mission_name, OEM_MISSION_NAME);
199 Current_mission->descent_version = 2;
200 Current_mission->anarchy_only_flag = 0;
205 Last_secret_level = -2;
207 strcpy(Level_names[0],"d2leva-1.rl2");
208 strcpy(Level_names[1],"d2leva-2.rl2");
209 strcpy(Level_names[2],"d2leva-3.rl2");
210 strcpy(Level_names[3],"d2leva-4.rl2");
212 strcpy(Secret_level_names[0],"d2leva-s.rl2");
214 strcpy(Level_names[4],"d2levb-1.rl2");
215 strcpy(Level_names[5],"d2levb-2.rl2");
216 strcpy(Level_names[6],"d2levb-3.rl2");
217 strcpy(Level_names[7],"d2levb-4.rl2");
219 strcpy(Secret_level_names[1],"d2levb-s.rl2");
221 Secret_level_table[0] = 1;
222 Secret_level_table[1] = 5;
228 //compare a string for a token. returns true if match
229 int istok(char *buf,char *tok)
231 return strnicmp(buf,tok,strlen(tok)) == 0;
235 //adds a terminating 0 after a string at the first white space
236 void add_term(char *s)
238 while (*s && !isspace(*s)) s++;
243 //returns ptr to string after '=' & white space, or NULL if no '='
244 //adds 0 after parm at first white space
245 char *get_value(char *buf)
249 t = strchr(buf,'=')+1;
252 while (*t && isspace(*t)) t++;
258 return NULL; //error!
261 //reads a line, returns ptr to value of passed parm. returns NULL if none
262 char *get_parm_value(char *parm,CFILE *f)
266 if (!cfgets(buf,80,f))
270 return get_value(buf);
275 int ml_sort_func(mle *e0,mle *e1)
277 return stricmp(e0->mission_name,e1->mission_name);
281 extern char CDROM_dir[];
283 //returns 1 if file read ok, else 0
284 int read_mission_file(mle *mission, char *filename, int location)
289 //printf("reading: %s\n", filename);
293 strcpy(filename2,MISSION_DIR);
297 songs_stop_redbook(); //so we can read from the CD
298 strcpy(filename2,CDROM_dir);
302 Int3(); //fall through
305 strcpy(filename2,"");
308 strcat(filename2,filename);
310 mfile = cfopen(filename2,"rb");
314 char temp[FILENAME_LEN],*t;
316 strcpy(temp,filename);
317 if ((t = strchr(temp,'.')) == NULL)
318 return 0; //missing extension
319 // look if it's .mn2 or .msn
320 mission->descent_version = (t[3] == '2') ? 2 : 1;
321 *t = 0; //kill extension
323 mission->filename = d_strdup(temp);
324 mission->anarchy_only_flag = 0;
325 mission->location = location;
327 p = get_parm_value("name",mfile);
329 if (!p) { //try enhanced mission
330 cfseek(mfile,0,SEEK_SET);
331 p = get_parm_value("xname",mfile);
334 if (!p) { //try super-enhanced mission!
335 cfseek(mfile,0,SEEK_SET);
336 p = get_parm_value("zname",mfile);
341 if ((t=strchr(p,';'))!=NULL)
344 while (isspace(*t)) t--;
345 strncpy(mission->mission_name,p,MISSION_NAME_LEN);
349 d_free(mission->filename);
353 p = get_parm_value("type",mfile);
357 mission->anarchy_only_flag = istok(p,"anarchy");
367 void add_d1_builtin_mission_to_list(mle *mission)
371 if (!cfexist("descent.hog"))
374 size = cfile_size("descent.hog");
377 case D1_SHAREWARE_MISSION_HOGSIZE:
378 case D1_SHAREWARE_10_MISSION_HOGSIZE:
379 case D1_MAC_SHARE_MISSION_HOGSIZE:
380 mission->filename = d_strdup(D1_MISSION_FILENAME);
381 strcpy(mission->mission_name, D1_SHAREWARE_MISSION_NAME);
382 mission->anarchy_only_flag = 0;
384 case D1_OEM_MISSION_HOGSIZE:
385 case D1_OEM_10_MISSION_HOGSIZE:
386 mission->filename = d_strdup(D1_MISSION_FILENAME);
387 strcpy(mission->mission_name, D1_OEM_MISSION_NAME);
388 mission->anarchy_only_flag = 0;
391 Warning("Unknown D1 hogsize %d\n", size);
394 case D1_MISSION_HOGSIZE:
395 case D1_10_MISSION_HOGSIZE:
396 case D1_MAC_MISSION_HOGSIZE:
397 mission->filename = d_strdup(D1_MISSION_FILENAME);
398 strcpy(mission->mission_name, D1_MISSION_NAME);
399 mission->anarchy_only_flag = 0;
403 mission->descent_version = 1;
404 mission->anarchy_only_flag = 0;
405 mission->builtin_hogsize = 0;
410 void add_builtin_mission_to_list(mle *mission, char *name)
412 int size = cfile_size("descent2.hog");
415 size = cfile_size("d2demo.hog");
418 case SHAREWARE_MISSION_HOGSIZE:
419 case MAC_SHARE_MISSION_HOGSIZE:
420 mission->filename = d_strdup(SHAREWARE_MISSION_FILENAME);
421 strcpy(mission->mission_name,SHAREWARE_MISSION_NAME);
422 mission->anarchy_only_flag = 0;
424 case OEM_MISSION_HOGSIZE:
425 mission->filename = d_strdup(OEM_MISSION_FILENAME);
426 strcpy(mission->mission_name,OEM_MISSION_NAME);
427 mission->anarchy_only_flag = 0;
430 Warning("Unknown hogsize %d, trying %s\n", size, FULL_MISSION_FILENAME ".mn2");
431 Int3(); //fall through
432 case FULL_MISSION_HOGSIZE:
433 case FULL_10_MISSION_HOGSIZE:
434 case MAC_FULL_MISSION_HOGSIZE:
435 if (!read_mission_file(mission, FULL_MISSION_FILENAME ".mn2", ML_CURDIR))
436 Error("Could not find required mission file <%s>", FULL_MISSION_FILENAME ".mn2");
439 strcpy(name, mission->filename);
440 mission->builtin_hogsize = size;
441 mission->descent_version = 2;
442 mission->anarchy_only_flag = 0;
447 void add_missions_to_list(mle *mission, int anarchy_mode)
449 char **find, **i, *ext;
451 find = PHYSFS_enumerateFiles(MISSION_DIR);
453 for (i = find; *i != NULL; i++)
455 ext = strrchr(*i, '.');
456 if (ext && (!strnicmp(ext, ".msn", 4) || !strnicmp(ext, ".mn2", 4)))
457 if (read_mission_file(mission, *i, ML_MISSIONDIR))
458 if (anarchy_mode || !mission->anarchy_only_flag) {
461 mission->builtin_hogsize = 0;
464 d_free(mission->filename);
465 if (num_missions >= MAX_MISSIONS)
467 mprintf((0, "Warning: more missions than d2x can handle\n"));
472 PHYSFS_freeList(find);
475 /* move <mission_name> to <place> on mission list, increment <place> */
476 void promote (mle *mission_list, char * mission_name, int * top_place)
479 char name[FILENAME_LEN], * t;
480 strcpy(name, mission_name);
481 if ((t = strchr(name,'.')) != NULL)
482 *t = 0; //kill extension
483 //printf("promoting: %s\n", name);
484 for (i = *top_place; i < num_missions; i++)
485 if (!stricmp(mission_list[i].filename, name)) {
486 //swap mission positions
489 temp = mission_list[*top_place];
490 mission_list[*top_place] = mission_list[i];
491 mission_list[i] = temp;
497 void free_mission(void)
499 // May become more complex with the editor
500 if (Current_mission) {
501 d_free(Current_mission->filename);
502 d_free(Current_mission);
508 //fills in the global list of missions. Returns the number of missions
509 //in the list. If anarchy_mode is set, then also add anarchy-only missions.
511 extern char CDROM_dir[];
513 extern char AltHogDir[];
514 extern char AltHogdir_initialized;
517 mle *build_mission_list(int anarchy_mode)
521 char builtin_mission_filename[FILENAME_LEN];
523 //now search for levels on disk
525 //@@Took out this code because after this routine was called once for
526 //@@a list of single-player missions, a subsequent call for a list of
527 //@@anarchy missions would not scan again, and thus would not find the
528 //@@anarchy-only missions. If we retain the minimum level of install,
529 //@@we may want to put the code back in, having it always scan for all
530 //@@missions, and have the code that uses it sort out the ones it wants.
531 //@@ if (num_missions != -1) {
532 //@@ if (Current_mission_num != 0)
533 //@@ load_mission(0); //set built-in mission as default
534 //@@ return num_missions;
537 MALLOC(mission_list, mle, MAX_MISSIONS);
540 add_builtin_mission_to_list(mission_list + num_missions, builtin_mission_filename); //read built-in first
541 add_d1_builtin_mission_to_list(mission_list + num_missions);
542 add_missions_to_list(mission_list + num_missions, anarchy_mode);
544 // move original missions (in story-chronological order)
545 // to top of mission list
547 promote(mission_list, "descent", &top_place); // original descent 1 mission
548 promote(mission_list, builtin_mission_filename, &top_place); // d2 or d2demo
549 promote(mission_list, "d2x", &top_place); // vertigo
551 if (num_missions > top_place)
552 qsort(&mission_list[top_place],
553 num_missions - top_place,
554 sizeof(*mission_list),
555 (int (*)( const void *, const void * ))ml_sort_func);
558 if (num_missions > top_place)
559 qsort(&mission_list[top_place],
560 num_missions - top_place,
561 sizeof(*mission_list),
562 (int (*)( const void *, const void * ))ml_sort_func);
564 //load_mission(0); //set built-in mission as default
566 atexit(free_mission);
571 void free_mission_list(mle *mission_list)
575 for (i = 0; i < num_missions; i++)
576 d_free(mission_list[i].filename);
578 d_free(mission_list);
582 void init_extra_robot_movie(char *filename);
584 //values for built-in mission
586 //loads the specfied mission from the mission list.
587 //build_mission_list() must have been called.
588 //Returns true if mission loaded ok, else false.
589 int load_mission(mle *mission)
597 Current_mission = d_malloc(sizeof(Mission));
598 if (!Current_mission) return 0;
599 *(mle *) Current_mission = *mission;
600 Current_mission->filename = d_strdup(mission->filename); // don't want to lose it
602 // for Descent 1 missions, load descent.hog
604 if (!cfile_init("descent.hog"))
605 Warning("descent.hog not available, this mission may be missing some files required for briefings and exit sequence\n");
606 if (!stricmp(Current_mission_filename, D1_MISSION_FILENAME))
607 return load_mission_d1();
610 if (PLAYING_BUILTIN_MISSION) {
611 switch (Current_mission->builtin_hogsize) {
612 case SHAREWARE_MISSION_HOGSIZE:
613 case MAC_SHARE_MISSION_HOGSIZE:
614 return load_mission_shareware();
616 case OEM_MISSION_HOGSIZE:
617 return load_mission_oem();
620 Int3(); // fall through
621 case FULL_MISSION_HOGSIZE:
622 case FULL_10_MISSION_HOGSIZE:
623 case MAC_FULL_MISSION_HOGSIZE:
624 // continue on... (use d2.mn2 from hogfile)
629 mprintf(( 0, "Loading mission %s\n", Current_mission_filename ));
631 //read mission from file
633 switch (mission->location) {
635 strcpy(buf,MISSION_DIR);
638 strcpy(buf,CDROM_dir);
641 Int3(); //fall through
646 strcat(buf, mission->filename);
647 if (mission->descent_version == 2)
652 PHYSFSEXT_locateCorrectCase(buf);
654 mfile = cfopen(buf,"rb");
660 //for non-builtin missions, load HOG
661 if (!PLAYING_BUILTIN_MISSION) {
663 strcpy(buf+strlen(buf)-4,".hog"); //change extension
665 PHYSFSEXT_locateCorrectCase(buf);
667 found_hogfile = cfile_init(buf);
669 #ifdef RELEASE //for release, require mission to be in hogfile
670 if (! found_hogfile) {
680 Last_secret_level = 0;
681 Briefing_text_filename[0] = 0;
682 Ending_text_filename[0] = 0;
684 while (cfgets(buf,80,mfile)) {
686 if (istok(buf,"name")) {
687 Current_mission->enhanced = 0;
688 continue; //already have name, go to next line
690 if (istok(buf,"xname")) {
691 Current_mission->enhanced = 1;
692 continue; //already have name, go to next line
694 if (istok(buf,"zname")) {
695 Current_mission->enhanced = 2;
696 continue; //already have name, go to next line
698 else if (istok(buf,"type"))
699 continue; //already have name, go to next line
700 else if (istok(buf,"hog")) {
703 while (*(bufp++) != '=')
707 while (*(++bufp) == ' ')
711 mprintf((0, "Hog file override = [%s]\n", bufp));
713 else if (istok(buf,"briefing")) {
714 if ((v = get_value(buf)) != NULL) {
717 strcpy(Briefing_text_filename,v);
720 else if (istok(buf,"ending")) {
721 if ((v = get_value(buf)) != NULL) {
724 strcpy(Ending_text_filename,v);
727 else if (istok(buf,"num_levels")) {
729 if ((v=get_value(buf))!=NULL) {
734 for (i=0;i<n_levels && cfgets(buf,80,mfile);i++) {
737 if (strlen(buf) <= 12) {
738 strcpy(Level_names[i],buf);
747 else if (istok(buf,"num_secrets")) {
748 if ((v=get_value(buf))!=NULL) {
751 N_secret_levels = atoi(v);
753 Assert(N_secret_levels <= MAX_SECRET_LEVELS_PER_MISSION);
755 for (i=0;i<N_secret_levels && cfgets(buf,80,mfile);i++) {
759 if ((t=strchr(buf,','))!=NULL) *t++=0;
764 if (strlen(buf) <= 12) {
765 strcpy(Secret_level_names[i],buf);
766 Secret_level_table[i] = atoi(t);
767 if (Secret_level_table[i]<1 || Secret_level_table[i]>Last_level)
782 if (Last_level <= 0) {
783 free_mission(); //no valid mission loaded
787 if (Current_mission->enhanced) {
789 extern void bm_read_extra_robots();
790 sprintf(t,"%s.ham",Current_mission_filename);
791 bm_read_extra_robots(t, Current_mission->enhanced);
792 strncpy(t,Current_mission_filename,6);
793 init_extra_robot_movie(t);
799 //loads the named mission if exists.
800 //Returns true if mission loaded ok, else false.
801 int load_mission_by_name(char *mission_name)
804 mle *mission_list = build_mission_list(1);
807 for (i = 0; i < num_missions; i++)
808 if (!stricmp(mission_name, mission_list[i].filename))
809 found = load_mission(mission_list + i);
811 free_mission_list(mission_list);
815 int select_mission(int anarchy_mode, char *message)
817 mle *mission_list = build_mission_list(anarchy_mode);
820 if (num_missions <= 1) {
821 new_mission_num = load_mission(mission_list) ? 0 : -1;
823 int i, default_mission;
824 char * m[MAX_MISSIONS];
827 for (i = 0; i < num_missions; i++) {
828 m[i] = mission_list[i].mission_name;
829 if ( !stricmp( m[i], config_last_mission ) )
833 new_mission_num = newmenu_listbox1( message, num_missions, m, 1, default_mission, NULL );
835 if (new_mission_num >= 0) {
837 strcpy(config_last_mission, m[new_mission_num] );
839 if (!load_mission(mission_list + new_mission_num)) {
840 nm_messagebox( NULL, 1, TXT_OK, TXT_MISSION_ERROR);
841 new_mission_num = -1;
846 free_mission_list(mission_list);
847 return (new_mission_num >= 0);