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.
16 * Code to handle multiple missions
45 #include "ignorecase.h"
47 //values for d1 built-in mission
48 #define BIM_LAST_LEVEL 27
49 #define BIM_LAST_SECRET_LEVEL -3
50 #define BIM_BRIEFING_FILE "briefing.tex"
51 #define BIM_ENDING_FILE "endreg.tex"
55 char *filename; // filename without extension
56 int builtin_hogsize; // if it's the built-in mission, used for determining the version
57 char mission_name[MISSION_NAME_LEN+1];
58 ubyte descent_version; // descent 1 or descent 2?
59 ubyte anarchy_only_flag; // if true, mission is anarchy only
60 char *path; // relative file path
61 int location; // see defines below
64 //values that describe where a mission is located
66 #define ML_MISSIONDIR 1
68 int num_missions = -1;
70 Mission *Current_mission = NULL; // currently loaded mission
73 // Special versions of mission routines for d1 builtins
76 int load_mission_d1(void)
80 switch (cfile_size("descent.hog")) {
81 case D1_SHAREWARE_MISSION_HOGSIZE:
82 case D1_SHAREWARE_10_MISSION_HOGSIZE:
86 Last_secret_level = 0;
89 for (i=0;i<Last_level;i++)
90 sprintf(Level_names[i], "level%02d.sdl", i+1);
93 case D1_MAC_SHARE_MISSION_HOGSIZE:
97 Last_secret_level = 0;
100 for (i=0;i<Last_level;i++)
101 sprintf(Level_names[i], "level%02d.sdl", i+1);
104 case D1_OEM_MISSION_HOGSIZE:
105 case D1_OEM_10_MISSION_HOGSIZE:
109 Last_secret_level = -1;
112 for (i=0; i < Last_level - 1; i++)
113 sprintf(Level_names[i], "level%02d.rdl", i+1);
114 sprintf(Level_names[i], "saturn%02d.rdl", i+1);
115 for (i=0; i < -Last_secret_level; i++)
116 sprintf(Secret_level_names[i], "levels%1d.rdl", i+1);
118 Secret_level_table[0] = 10;
122 Int3(); // fall through
123 case D1_MISSION_HOGSIZE:
124 case D1_10_MISSION_HOGSIZE:
125 case D1_MAC_MISSION_HOGSIZE:
128 Last_level = BIM_LAST_LEVEL;
129 Last_secret_level = BIM_LAST_SECRET_LEVEL;
132 for (i=0;i<Last_level;i++)
133 sprintf(Level_names[i], "level%02d.rdl", i+1);
134 for (i=0;i<-Last_secret_level;i++)
135 sprintf(Secret_level_names[i], "levels%1d.rdl", i+1);
137 Secret_level_table[0] = 10;
138 Secret_level_table[1] = 21;
139 Secret_level_table[2] = 24;
143 strcpy(Briefing_text_filename,BIM_BRIEFING_FILE);
144 strcpy(Ending_text_filename,BIM_ENDING_FILE);
151 // Special versions of mission routines for shareware
154 int load_mission_shareware(void)
156 strcpy(Current_mission->mission_name, SHAREWARE_MISSION_NAME);
157 Current_mission->descent_version = 2;
158 Current_mission->anarchy_only_flag = 0;
160 switch (Current_mission->builtin_hogsize) {
161 case MAC_SHARE_MISSION_HOGSIZE:
165 Last_secret_level = -1;
167 // mac demo is using the regular hog and rl2 files
168 strcpy(Level_names[0],"d2leva-1.rl2");
169 strcpy(Level_names[1],"d2leva-2.rl2");
170 strcpy(Level_names[2],"d2leva-3.rl2");
171 strcpy(Level_names[3],"d2leva-4.rl2");
172 strcpy(Secret_level_names[0],"d2leva-s.rl2");
175 Int3(); // fall through
176 case SHAREWARE_MISSION_HOGSIZE:
180 Last_secret_level = 0;
182 strcpy(Level_names[0],"d2leva-1.sl2");
183 strcpy(Level_names[1],"d2leva-2.sl2");
184 strcpy(Level_names[2],"d2leva-3.sl2");
192 // Special versions of mission routines for Diamond/S3 version
195 int load_mission_oem(void)
197 strcpy(Current_mission->mission_name, OEM_MISSION_NAME);
198 Current_mission->descent_version = 2;
199 Current_mission->anarchy_only_flag = 0;
204 Last_secret_level = -2;
206 strcpy(Level_names[0],"d2leva-1.rl2");
207 strcpy(Level_names[1],"d2leva-2.rl2");
208 strcpy(Level_names[2],"d2leva-3.rl2");
209 strcpy(Level_names[3],"d2leva-4.rl2");
211 strcpy(Secret_level_names[0],"d2leva-s.rl2");
213 strcpy(Level_names[4],"d2levb-1.rl2");
214 strcpy(Level_names[5],"d2levb-2.rl2");
215 strcpy(Level_names[6],"d2levb-3.rl2");
216 strcpy(Level_names[7],"d2levb-4.rl2");
218 strcpy(Secret_level_names[1],"d2levb-s.rl2");
220 Secret_level_table[0] = 1;
221 Secret_level_table[1] = 5;
227 //compare a string for a token. returns true if match
228 int istok(char *buf,char *tok)
230 return strnicmp(buf,tok,strlen(tok)) == 0;
234 //adds a terminating 0 after a string at the first white space
235 void add_term(char *s)
237 while (*s && !isspace(*s)) s++;
242 //returns ptr to string after '=' & white space, or NULL if no '='
243 //adds 0 after parm at first white space
244 char *get_value(char *buf)
248 t = strchr(buf,'=')+1;
251 while (*t && isspace(*t)) t++;
257 return NULL; //error!
260 //reads a line, returns ptr to value of passed parm. returns NULL if none
261 char *get_parm_value(char *parm,CFILE *f)
265 if (!cfgets(buf,80,f))
269 return get_value(buf);
274 int ml_sort_func(mle *e0,mle *e1)
276 return stricmp(e0->mission_name,e1->mission_name);
281 //returns 1 if file read ok, else 0
282 int read_mission_file(mle *mission, char *filename, int location)
287 //printf("reading: %s\n", filename);
291 strcpy(filename2,MISSION_DIR);
295 Int3(); //fall through
298 strcpy(filename2,"");
301 strcat(filename2,filename);
303 mfile = cfopen(filename2,"rb");
307 char temp[PATH_MAX], *ext;
309 strcpy(temp,filename);
310 p = strrchr(temp, '/'); // get the filename at the end of the path
315 if ((ext = strchr(p, '.')) == NULL)
316 return 0; //missing extension
317 // look if it's .mn2 or .msn
318 mission->descent_version = (ext[3] == '2') ? 2 : 1;
319 *ext = 0; //kill extension
321 mission->path = d_strdup(temp);
322 mission->anarchy_only_flag = 0;
323 mission->filename = mission->path + (p - temp);
324 mission->location = location;
326 p = get_parm_value("name",mfile);
328 if (!p) { //try enhanced mission
329 cfseek(mfile,0,SEEK_SET);
330 p = get_parm_value("xname",mfile);
333 if (!p) { //try super-enhanced mission!
334 cfseek(mfile,0,SEEK_SET);
335 p = get_parm_value("zname",mfile);
340 if ((t=strchr(p,';'))!=NULL)
344 *t-- = 0; // remove trailing whitespace
345 if (strlen(p) > MISSION_NAME_LEN)
346 p[MISSION_NAME_LEN] = 0;
347 strncpy(mission->mission_name, p, MISSION_NAME_LEN + 1);
351 d_free(mission->path);
355 p = get_parm_value("type",mfile);
359 mission->anarchy_only_flag = istok(p,"anarchy");
369 void add_d1_builtin_mission_to_list(mle *mission)
373 if (!cfexist("descent.hog"))
376 size = cfile_size("descent.hog");
379 case D1_SHAREWARE_MISSION_HOGSIZE:
380 case D1_SHAREWARE_10_MISSION_HOGSIZE:
381 case D1_MAC_SHARE_MISSION_HOGSIZE:
382 mission->filename = d_strdup(D1_MISSION_FILENAME);
383 strcpy(mission->mission_name, D1_SHAREWARE_MISSION_NAME);
384 mission->anarchy_only_flag = 0;
386 case D1_OEM_MISSION_HOGSIZE:
387 case D1_OEM_10_MISSION_HOGSIZE:
388 mission->filename = d_strdup(D1_MISSION_FILENAME);
389 strcpy(mission->mission_name, D1_OEM_MISSION_NAME);
390 mission->anarchy_only_flag = 0;
393 Warning("Unknown D1 hogsize %d\n", size);
396 case D1_MISSION_HOGSIZE:
397 case D1_10_MISSION_HOGSIZE:
398 case D1_MAC_MISSION_HOGSIZE:
399 mission->filename = d_strdup(D1_MISSION_FILENAME);
400 strcpy(mission->mission_name, D1_MISSION_NAME);
401 mission->anarchy_only_flag = 0;
405 mission->descent_version = 1;
406 mission->anarchy_only_flag = 0;
407 mission->builtin_hogsize = 0;
408 mission->path = mission->filename;
413 void add_builtin_mission_to_list(mle *mission, char *name)
415 int size = cfile_size("descent2.hog");
418 size = cfile_size("d2demo.hog");
421 case SHAREWARE_MISSION_HOGSIZE:
422 case MAC_SHARE_MISSION_HOGSIZE:
423 mission->filename = d_strdup(SHAREWARE_MISSION_FILENAME);
424 strcpy(mission->mission_name,SHAREWARE_MISSION_NAME);
425 mission->anarchy_only_flag = 0;
427 case OEM_MISSION_HOGSIZE:
428 mission->filename = d_strdup(OEM_MISSION_FILENAME);
429 strcpy(mission->mission_name,OEM_MISSION_NAME);
430 mission->anarchy_only_flag = 0;
433 Warning("Unknown hogsize %d, trying %s\n", size, FULL_MISSION_FILENAME ".mn2");
434 Int3(); //fall through
435 case FULL_MISSION_HOGSIZE:
436 case FULL_10_MISSION_HOGSIZE:
437 case MAC_FULL_MISSION_HOGSIZE:
438 if (!read_mission_file(mission, FULL_MISSION_FILENAME ".mn2", ML_CURDIR))
439 Error("Could not find required mission file <%s>", FULL_MISSION_FILENAME ".mn2");
442 mission->path = mission->filename;
443 strcpy(name, mission->filename);
444 mission->builtin_hogsize = size;
445 mission->descent_version = 2;
446 mission->anarchy_only_flag = 0;
451 void add_missions_to_list(mle *mission_list, char *path, char *rel_path, int anarchy_mode)
453 char **find, **i, *ext;
455 find = PHYSFS_enumerateFiles(path);
457 for (i = find; *i != NULL; i++)
459 if (strlen(path) + strlen(*i) + 1 >= PATH_MAX)
460 continue; // path is too long
462 strcat(rel_path, *i);
463 if (PHYSFS_isDirectory(path))
465 strcat(rel_path, "/");
466 add_missions_to_list(mission_list, path, rel_path, anarchy_mode);
467 *(strrchr(path, '/')) = 0;
469 else if ((ext = strrchr(*i, '.')) && (!strnicmp(ext, ".msn", 4) || !strnicmp(ext, ".mn2", 4)))
470 if (read_mission_file(&mission_list[num_missions], rel_path, ML_MISSIONDIR))
472 if (anarchy_mode || !mission_list[num_missions].anarchy_only_flag)
474 mission_list[num_missions].builtin_hogsize = 0;
478 d_free(mission_list[num_missions].path);
481 if (num_missions >= MAX_MISSIONS)
483 mprintf((0, "Warning: more missions than d2x can handle\n"));
487 (strrchr(path, '/'))[1] = 0; // chop off the entry
490 PHYSFS_freeList(find);
493 /* move <mission_name> to <place> on mission list, increment <place> */
494 void promote (mle *mission_list, char * mission_name, int * top_place)
497 char name[FILENAME_LEN], * t;
498 strcpy(name, mission_name);
499 if ((t = strchr(name,'.')) != NULL)
500 *t = 0; //kill extension
501 //printf("promoting: %s\n", name);
502 for (i = *top_place; i < num_missions; i++)
503 if (!stricmp(mission_list[i].filename, name)) {
504 //swap mission positions
507 temp = mission_list[*top_place];
508 mission_list[*top_place] = mission_list[i];
509 mission_list[i] = temp;
515 void free_mission(void)
517 // May become more complex with the editor
518 if (Current_mission) {
519 d_free(Current_mission->filename);
520 d_free(Current_mission);
526 //fills in the global list of missions. Returns the number of missions
527 //in the list. If anarchy_mode is set, then also add anarchy-only missions.
530 extern char AltHogDir[];
531 extern char AltHogdir_initialized;
534 mle *build_mission_list(int anarchy_mode)
538 char builtin_mission_filename[FILENAME_LEN];
539 char search_str[PATH_MAX] = MISSION_DIR;
541 //now search for levels on disk
543 //@@Took out this code because after this routine was called once for
544 //@@a list of single-player missions, a subsequent call for a list of
545 //@@anarchy missions would not scan again, and thus would not find the
546 //@@anarchy-only missions. If we retain the minimum level of install,
547 //@@we may want to put the code back in, having it always scan for all
548 //@@missions, and have the code that uses it sort out the ones it wants.
549 //@@ if (num_missions != -1) {
550 //@@ if (Current_mission_num != 0)
551 //@@ load_mission(0); //set built-in mission as default
552 //@@ return num_missions;
555 MALLOC(mission_list, mle, MAX_MISSIONS);
558 add_builtin_mission_to_list(mission_list + num_missions, builtin_mission_filename); //read built-in first
559 add_d1_builtin_mission_to_list(mission_list + num_missions);
560 add_missions_to_list(mission_list, search_str, search_str + strlen(search_str), anarchy_mode);
562 // move original missions (in story-chronological order)
563 // to top of mission list
565 promote(mission_list, "descent", &top_place); // original descent 1 mission
566 promote(mission_list, builtin_mission_filename, &top_place); // d2 or d2demo
567 promote(mission_list, "d2x", &top_place); // vertigo
569 if (num_missions > top_place)
570 qsort(&mission_list[top_place],
571 num_missions - top_place,
572 sizeof(*mission_list),
573 (int (*)( const void *, const void * ))ml_sort_func);
576 if (num_missions > top_place)
577 qsort(&mission_list[top_place],
578 num_missions - top_place,
579 sizeof(*mission_list),
580 (int (*)( const void *, const void * ))ml_sort_func);
582 //load_mission(0); //set built-in mission as default
584 atexit(free_mission);
589 void free_mission_list(mle *mission_list)
593 for (i = 0; i < num_missions; i++)
594 d_free(mission_list[i].path);
596 d_free(mission_list);
600 void init_extra_robot_movie(char *filename);
602 //values for built-in mission
604 //loads the specfied mission from the mission list.
605 //build_mission_list() must have been called.
606 //Returns true if mission loaded ok, else false.
607 int load_mission(mle *mission)
610 char buf[PATH_MAX], *v;
615 Current_mission = d_malloc(sizeof(Mission));
616 if (!Current_mission) return 0;
617 *(mle *) Current_mission = *mission;
618 Current_mission->filename = d_strdup(mission->filename); // don't want to lose it
620 // for Descent 1 missions, load descent.hog
622 if (!cfile_init("descent.hog"))
623 Warning("descent.hog not available, this mission may be missing some files required for briefings and exit sequence\n");
624 if (!stricmp(Current_mission_filename, D1_MISSION_FILENAME))
625 return load_mission_d1();
628 if (PLAYING_BUILTIN_MISSION) {
629 switch (Current_mission->builtin_hogsize) {
630 case SHAREWARE_MISSION_HOGSIZE:
631 case MAC_SHARE_MISSION_HOGSIZE:
632 return load_mission_shareware();
634 case OEM_MISSION_HOGSIZE:
635 return load_mission_oem();
638 Int3(); // fall through
639 case FULL_MISSION_HOGSIZE:
640 case FULL_10_MISSION_HOGSIZE:
641 case MAC_FULL_MISSION_HOGSIZE:
642 // continue on... (use d2.mn2 from hogfile)
647 mprintf(( 0, "Loading mission %s\n", Current_mission_filename ));
649 //read mission from file
651 switch (mission->location) {
653 strcpy(buf,MISSION_DIR);
656 Int3(); //fall through
661 strcat(buf, mission->path);
662 if (mission->descent_version == 2)
667 PHYSFSEXT_locateCorrectCase(buf);
669 mfile = cfopen(buf,"rb");
675 //for non-builtin missions, load HOG
676 if (!PLAYING_BUILTIN_MISSION) {
678 strcpy(buf+strlen(buf)-4,".hog"); //change extension
680 PHYSFSEXT_locateCorrectCase(buf);
682 found_hogfile = cfile_init(buf);
684 #ifdef RELEASE //for release, require mission to be in hogfile
685 if (! found_hogfile) {
695 Last_secret_level = 0;
696 Briefing_text_filename[0] = 0;
697 Ending_text_filename[0] = 0;
699 while (cfgets(buf,80,mfile)) {
701 if (istok(buf,"name")) {
702 Current_mission->enhanced = 0;
703 continue; //already have name, go to next line
705 if (istok(buf,"xname")) {
706 Current_mission->enhanced = 1;
707 continue; //already have name, go to next line
709 if (istok(buf,"zname")) {
710 Current_mission->enhanced = 2;
711 continue; //already have name, go to next line
713 else if (istok(buf,"type"))
714 continue; //already have name, go to next line
715 else if (istok(buf,"hog")) {
718 while (*(bufp++) != '=')
722 while (*(++bufp) == ' ')
726 mprintf((0, "Hog file override = [%s]\n", bufp));
728 else if (istok(buf,"briefing")) {
729 if ((v = get_value(buf)) != NULL) {
732 strcpy(Briefing_text_filename,v);
735 else if (istok(buf,"ending")) {
736 if ((v = get_value(buf)) != NULL) {
739 strcpy(Ending_text_filename,v);
742 else if (istok(buf,"num_levels")) {
744 if ((v=get_value(buf))!=NULL) {
749 for (i=0;i<n_levels && cfgets(buf,80,mfile);i++) {
752 if (strlen(buf) <= 12) {
753 strcpy(Level_names[i],buf);
762 else if (istok(buf,"num_secrets")) {
763 if ((v=get_value(buf))!=NULL) {
766 N_secret_levels = atoi(v);
768 Assert(N_secret_levels <= MAX_SECRET_LEVELS_PER_MISSION);
770 for (i=0;i<N_secret_levels && cfgets(buf,80,mfile);i++) {
774 if ((t=strchr(buf,','))!=NULL) *t++=0;
779 if (strlen(buf) <= 12) {
780 strcpy(Secret_level_names[i],buf);
781 Secret_level_table[i] = atoi(t);
782 if (Secret_level_table[i]<1 || Secret_level_table[i]>Last_level)
797 if (Last_level <= 0) {
798 free_mission(); //no valid mission loaded
802 if (Current_mission->enhanced) {
804 extern void bm_read_extra_robots();
805 sprintf(t,"%s.ham",Current_mission_filename);
806 bm_read_extra_robots(t, Current_mission->enhanced);
807 strncpy(t,Current_mission_filename,6);
808 init_extra_robot_movie(t);
814 //loads the named mission if exists.
815 //Returns true if mission loaded ok, else false.
816 int load_mission_by_name(char *mission_name)
819 mle *mission_list = build_mission_list(1);
822 for (i = 0; i < num_missions; i++)
823 if (!stricmp(mission_name, mission_list[i].filename))
824 found = load_mission(mission_list + i);
826 free_mission_list(mission_list);
830 int select_mission(int anarchy_mode, char *message)
832 mle *mission_list = build_mission_list(anarchy_mode);
835 if (num_missions <= 1) {
836 new_mission_num = load_mission(mission_list) ? 0 : -1;
838 int i, default_mission;
839 char * m[MAX_MISSIONS];
842 for (i = 0; i < num_missions; i++) {
843 m[i] = mission_list[i].mission_name;
844 if ( !stricmp( m[i], config_last_mission.string ) )
848 new_mission_num = newmenu_listbox1( message, num_missions, m, 1, default_mission, NULL );
850 if (new_mission_num >= 0) {
852 cvar_set_cvar( &config_last_mission, m[new_mission_num] );
854 if (!load_mission(mission_list + new_mission_num)) {
855 nm_messagebox( NULL, 1, TXT_OK, TXT_MISSION_ERROR);
856 new_mission_num = -1;
861 free_mission_list(mission_list);
862 return (new_mission_num >= 0);
866 //set a new highest level for player for this mission
867 int mission_write_config(void)
869 char filename[FILENAME_LEN+15];
872 PHYSFS_mkdir(MISSION_DIR);
874 sprintf(filename, MISSION_DIR "%s.cfg", Current_mission_filename);
875 file = PHYSFSX_openWriteBuffered(filename);
879 nm_messagebox(NULL, 1, TXT_OK, "Cannot open mission config file");
883 PHYSFSX_printf(file, "%s=%d\n", Player_highest_level.name, Current_level_num);
891 //gets the player's highest level from the file for this mission
892 int mission_read_config(void)
894 cvar_setint(&Player_highest_level, 0);
896 cmd_appendf("exec " MISSION_DIR "%s.cfg", Current_mission_filename);