1 /* $Id: mission.c,v 1.40 2005-02-25 10:28:42 chris 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)
345 *t-- = 0; // remove trailing whitespace
346 if (strlen(p) > MISSION_NAME_LEN)
347 p[MISSION_NAME_LEN] = 0;
348 strncpy(mission->mission_name, p, MISSION_NAME_LEN + 1);
352 d_free(mission->filename);
356 p = get_parm_value("type",mfile);
360 mission->anarchy_only_flag = istok(p,"anarchy");
370 void add_d1_builtin_mission_to_list(mle *mission)
374 if (!cfexist("descent.hog"))
377 size = cfile_size("descent.hog");
380 case D1_SHAREWARE_MISSION_HOGSIZE:
381 case D1_SHAREWARE_10_MISSION_HOGSIZE:
382 case D1_MAC_SHARE_MISSION_HOGSIZE:
383 mission->filename = d_strdup(D1_MISSION_FILENAME);
384 strcpy(mission->mission_name, D1_SHAREWARE_MISSION_NAME);
385 mission->anarchy_only_flag = 0;
387 case D1_OEM_MISSION_HOGSIZE:
388 case D1_OEM_10_MISSION_HOGSIZE:
389 mission->filename = d_strdup(D1_MISSION_FILENAME);
390 strcpy(mission->mission_name, D1_OEM_MISSION_NAME);
391 mission->anarchy_only_flag = 0;
394 Warning("Unknown D1 hogsize %d\n", size);
397 case D1_MISSION_HOGSIZE:
398 case D1_10_MISSION_HOGSIZE:
399 case D1_MAC_MISSION_HOGSIZE:
400 mission->filename = d_strdup(D1_MISSION_FILENAME);
401 strcpy(mission->mission_name, D1_MISSION_NAME);
402 mission->anarchy_only_flag = 0;
406 mission->descent_version = 1;
407 mission->anarchy_only_flag = 0;
408 mission->builtin_hogsize = 0;
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 strcpy(name, mission->filename);
443 mission->builtin_hogsize = size;
444 mission->descent_version = 2;
445 mission->anarchy_only_flag = 0;
450 void add_missions_to_list(mle *mission, int anarchy_mode)
452 char **find, **i, *ext;
454 find = PHYSFS_enumerateFiles(MISSION_DIR);
456 for (i = find; *i != NULL; i++)
458 ext = strrchr(*i, '.');
459 if (ext && (!strnicmp(ext, ".msn", 4) || !strnicmp(ext, ".mn2", 4)))
460 if (read_mission_file(mission, *i, ML_MISSIONDIR))
462 if (anarchy_mode || !mission->anarchy_only_flag) {
463 mission->builtin_hogsize = 0;
468 d_free(mission->filename);
470 if (num_missions >= MAX_MISSIONS)
472 mprintf((0, "Warning: more missions than d2x can handle\n"));
477 PHYSFS_freeList(find);
480 /* move <mission_name> to <place> on mission list, increment <place> */
481 void promote (mle *mission_list, char * mission_name, int * top_place)
484 char name[FILENAME_LEN], * t;
485 strcpy(name, mission_name);
486 if ((t = strchr(name,'.')) != NULL)
487 *t = 0; //kill extension
488 //printf("promoting: %s\n", name);
489 for (i = *top_place; i < num_missions; i++)
490 if (!stricmp(mission_list[i].filename, name)) {
491 //swap mission positions
494 temp = mission_list[*top_place];
495 mission_list[*top_place] = mission_list[i];
496 mission_list[i] = temp;
502 void free_mission(void)
504 // May become more complex with the editor
505 if (Current_mission) {
506 d_free(Current_mission->filename);
507 d_free(Current_mission);
513 //fills in the global list of missions. Returns the number of missions
514 //in the list. If anarchy_mode is set, then also add anarchy-only missions.
516 extern char CDROM_dir[];
518 extern char AltHogDir[];
519 extern char AltHogdir_initialized;
522 mle *build_mission_list(int anarchy_mode)
526 char builtin_mission_filename[FILENAME_LEN];
528 //now search for levels on disk
530 //@@Took out this code because after this routine was called once for
531 //@@a list of single-player missions, a subsequent call for a list of
532 //@@anarchy missions would not scan again, and thus would not find the
533 //@@anarchy-only missions. If we retain the minimum level of install,
534 //@@we may want to put the code back in, having it always scan for all
535 //@@missions, and have the code that uses it sort out the ones it wants.
536 //@@ if (num_missions != -1) {
537 //@@ if (Current_mission_num != 0)
538 //@@ load_mission(0); //set built-in mission as default
539 //@@ return num_missions;
542 MALLOC(mission_list, mle, MAX_MISSIONS);
545 add_builtin_mission_to_list(mission_list + num_missions, builtin_mission_filename); //read built-in first
546 add_d1_builtin_mission_to_list(mission_list + num_missions);
547 add_missions_to_list(mission_list + num_missions, anarchy_mode);
549 // move original missions (in story-chronological order)
550 // to top of mission list
552 promote(mission_list, "descent", &top_place); // original descent 1 mission
553 promote(mission_list, builtin_mission_filename, &top_place); // d2 or d2demo
554 promote(mission_list, "d2x", &top_place); // vertigo
556 if (num_missions > top_place)
557 qsort(&mission_list[top_place],
558 num_missions - top_place,
559 sizeof(*mission_list),
560 (int (*)( const void *, const void * ))ml_sort_func);
563 if (num_missions > top_place)
564 qsort(&mission_list[top_place],
565 num_missions - top_place,
566 sizeof(*mission_list),
567 (int (*)( const void *, const void * ))ml_sort_func);
569 //load_mission(0); //set built-in mission as default
571 atexit(free_mission);
576 void free_mission_list(mle *mission_list)
580 for (i = 0; i < num_missions; i++)
581 d_free(mission_list[i].filename);
583 d_free(mission_list);
587 void init_extra_robot_movie(char *filename);
589 //values for built-in mission
591 //loads the specfied mission from the mission list.
592 //build_mission_list() must have been called.
593 //Returns true if mission loaded ok, else false.
594 int load_mission(mle *mission)
602 Current_mission = d_malloc(sizeof(Mission));
603 if (!Current_mission) return 0;
604 *(mle *) Current_mission = *mission;
605 Current_mission->filename = d_strdup(mission->filename); // don't want to lose it
607 // for Descent 1 missions, load descent.hog
609 if (!cfile_init("descent.hog"))
610 Warning("descent.hog not available, this mission may be missing some files required for briefings and exit sequence\n");
611 if (!stricmp(Current_mission_filename, D1_MISSION_FILENAME))
612 return load_mission_d1();
615 if (PLAYING_BUILTIN_MISSION) {
616 switch (Current_mission->builtin_hogsize) {
617 case SHAREWARE_MISSION_HOGSIZE:
618 case MAC_SHARE_MISSION_HOGSIZE:
619 return load_mission_shareware();
621 case OEM_MISSION_HOGSIZE:
622 return load_mission_oem();
625 Int3(); // fall through
626 case FULL_MISSION_HOGSIZE:
627 case FULL_10_MISSION_HOGSIZE:
628 case MAC_FULL_MISSION_HOGSIZE:
629 // continue on... (use d2.mn2 from hogfile)
634 mprintf(( 0, "Loading mission %s\n", Current_mission_filename ));
636 //read mission from file
638 switch (mission->location) {
640 strcpy(buf,MISSION_DIR);
643 strcpy(buf,CDROM_dir);
646 Int3(); //fall through
651 strcat(buf, mission->filename);
652 if (mission->descent_version == 2)
657 PHYSFSEXT_locateCorrectCase(buf);
659 mfile = cfopen(buf,"rb");
665 //for non-builtin missions, load HOG
666 if (!PLAYING_BUILTIN_MISSION) {
668 strcpy(buf+strlen(buf)-4,".hog"); //change extension
670 PHYSFSEXT_locateCorrectCase(buf);
672 found_hogfile = cfile_init(buf);
674 #ifdef RELEASE //for release, require mission to be in hogfile
675 if (! found_hogfile) {
685 Last_secret_level = 0;
686 Briefing_text_filename[0] = 0;
687 Ending_text_filename[0] = 0;
689 while (cfgets(buf,80,mfile)) {
691 if (istok(buf,"name")) {
692 Current_mission->enhanced = 0;
693 continue; //already have name, go to next line
695 if (istok(buf,"xname")) {
696 Current_mission->enhanced = 1;
697 continue; //already have name, go to next line
699 if (istok(buf,"zname")) {
700 Current_mission->enhanced = 2;
701 continue; //already have name, go to next line
703 else if (istok(buf,"type"))
704 continue; //already have name, go to next line
705 else if (istok(buf,"hog")) {
708 while (*(bufp++) != '=')
712 while (*(++bufp) == ' ')
716 mprintf((0, "Hog file override = [%s]\n", bufp));
718 else if (istok(buf,"briefing")) {
719 if ((v = get_value(buf)) != NULL) {
722 strcpy(Briefing_text_filename,v);
725 else if (istok(buf,"ending")) {
726 if ((v = get_value(buf)) != NULL) {
729 strcpy(Ending_text_filename,v);
732 else if (istok(buf,"num_levels")) {
734 if ((v=get_value(buf))!=NULL) {
739 for (i=0;i<n_levels && cfgets(buf,80,mfile);i++) {
742 if (strlen(buf) <= 12) {
743 strcpy(Level_names[i],buf);
752 else if (istok(buf,"num_secrets")) {
753 if ((v=get_value(buf))!=NULL) {
756 N_secret_levels = atoi(v);
758 Assert(N_secret_levels <= MAX_SECRET_LEVELS_PER_MISSION);
760 for (i=0;i<N_secret_levels && cfgets(buf,80,mfile);i++) {
764 if ((t=strchr(buf,','))!=NULL) *t++=0;
769 if (strlen(buf) <= 12) {
770 strcpy(Secret_level_names[i],buf);
771 Secret_level_table[i] = atoi(t);
772 if (Secret_level_table[i]<1 || Secret_level_table[i]>Last_level)
787 if (Last_level <= 0) {
788 free_mission(); //no valid mission loaded
792 if (Current_mission->enhanced) {
794 extern void bm_read_extra_robots();
795 sprintf(t,"%s.ham",Current_mission_filename);
796 bm_read_extra_robots(t, Current_mission->enhanced);
797 strncpy(t,Current_mission_filename,6);
798 init_extra_robot_movie(t);
804 //loads the named mission if exists.
805 //Returns true if mission loaded ok, else false.
806 int load_mission_by_name(char *mission_name)
809 mle *mission_list = build_mission_list(1);
812 for (i = 0; i < num_missions; i++)
813 if (!stricmp(mission_name, mission_list[i].filename))
814 found = load_mission(mission_list + i);
816 free_mission_list(mission_list);
820 int select_mission(int anarchy_mode, char *message)
822 mle *mission_list = build_mission_list(anarchy_mode);
825 if (num_missions <= 1) {
826 new_mission_num = load_mission(mission_list) ? 0 : -1;
828 int i, default_mission;
829 char * m[MAX_MISSIONS];
832 for (i = 0; i < num_missions; i++) {
833 m[i] = mission_list[i].mission_name;
834 if ( !stricmp( m[i], config_last_mission ) )
838 new_mission_num = newmenu_listbox1( message, num_missions, m, 1, default_mission, NULL );
840 if (new_mission_num >= 0) {
842 strcpy(config_last_mission, m[new_mission_num] );
844 if (!load_mission(mission_list + new_mission_num)) {
845 nm_messagebox( NULL, 1, TXT_OK, TXT_MISSION_ERROR);
846 new_mission_num = -1;
851 free_mission_list(mission_list);
852 return (new_mission_num >= 0);