main/mission.c

   1 /* $Id: mission.c,v 1.5 2002-08-06 05:12:09 btb Exp $ */
   2 /*
   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.
  13 */
  14
  15 /*
  16  *
  17  * Stuff for loading missions
  18  *
  19  *
  20  */
  21
  22 #ifdef HAVE_CONFIG_H
  23 #include <conf.h>
  24 #endif
  25
  26 #include <stdio.h>
  27 #include <stdlib.h>
  28 #include <string.h>
  29 #include <ctype.h>
  30 #include <limits.h>
  31
  32 #include "pstypes.h"
  33 #include "cfile.h"
  34
  35 #include "strutil.h"
  36 #include "inferno.h"
  37 #include "mission.h"
  38 #include "gameseq.h"
  39 #include "titles.h"
  40 #include "songs.h"
  41 #include "mono.h"
  42 #include "error.h"
  43 #include "findfile.h"
  44
  45 mle Mission_list[MAX_MISSIONS];
  46
  47 int Current_mission_num;
  48 int     N_secret_levels;                //      Made a global by MK for scoring purposes.  August 1, 1995.
  49 char *Current_mission_filename,*Current_mission_longname;
  50
  51 //this stuff should get defined elsewhere
  52
  53 char Level_names[MAX_LEVELS_PER_MISSION][FILENAME_LEN];
  54 char Secret_level_names[MAX_SECRET_LEVELS_PER_MISSION][FILENAME_LEN];
  55
  56 //where the missions go
  57 #ifndef EDITOR
  58 #define MISSION_DIR "missions/"
  59 #else
  60 #define MISSION_DIR "./"
  61 #endif
  62
  63 #ifdef SHAREWARE
  64
  65 //
  66 //  Special versions of mission routines for shareware
  67 //
  68
  69 #define SHAREWARE_MISSION_FILENAME      "d2demo"
  70 #define SHAREWARE_MISSION_NAME          "Descent 2 Demo"
  71
  72 int build_mission_list(int anarchy_mode)
  73 {
  74         anarchy_mode++;         //kill warning
  75
  76         strcpy(Mission_list[0].filename,SHAREWARE_MISSION_FILENAME);
  77         strcpy(Mission_list[0].mission_name,SHAREWARE_MISSION_NAME);
  78         Mission_list[0].anarchy_only_flag = 0;
  79
  80         return load_mission(0);
  81 }
  82
  83 int load_mission(int mission_num)
  84 {
  85         Assert(mission_num == 0);
  86
  87         Current_mission_num = 0;
  88         Current_mission_filename = Mission_list[0].filename;
  89         Current_mission_longname = Mission_list[0].mission_name;
  90
  91         N_secret_levels = 0;
  92
  93         Assert(Last_level == 3);
  94
  95 #ifdef MACINTOSH        // mac demo is using the regular hog and rl2 files
  96         strcpy(Level_names[0],"d2leva-1.rl2");
  97         strcpy(Level_names[1],"d2leva-2.rl2");
  98         strcpy(Level_names[2],"d2leva-3.rl2");
  99 #else
 100         strcpy(Level_names[0],"d2leva-1.sl2");
 101         strcpy(Level_names[1],"d2leva-2.sl2");
 102         strcpy(Level_names[2],"d2leva-3.sl2");
 103 #endif  // end of ifdef macintosh
 104
 105         return 1;
 106 }
 107
 108 int load_mission_by_name(char *mission_name)
 109 {
 110         if (strcmp(mission_name,SHAREWARE_MISSION_FILENAME))
 111                 return 0;               //cannot load requested mission
 112         else
 113                 return load_mission(0);
 114
 115 }
 116
 117
 118
 119 #else
 120
 121 #if defined(D2_OEM)
 122
 123 //
 124 //  Special versions of mission routines for Diamond/S3 version
 125 //
 126
 127 #define OEM_MISSION_FILENAME    "d2"
 128 #define OEM_MISSION_NAME                "D2 Destination:Quartzon"
 129
 130 int build_mission_list(int anarchy_mode)
 131 {
 132         anarchy_mode++;         //kill warning
 133
 134         strcpy(Mission_list[0].filename,OEM_MISSION_FILENAME);
 135         strcpy(Mission_list[0].mission_name,OEM_MISSION_NAME);
 136         Mission_list[0].anarchy_only_flag = 0;
 137
 138         return load_mission(0);
 139 }
 140
 141 int load_mission(int mission_num)
 142 {
 143         Assert(mission_num == 0);
 144
 145         Current_mission_num = 0;
 146         Current_mission_filename = Mission_list[0].filename;
 147         Current_mission_longname = Mission_list[0].mission_name;
 148
 149         N_secret_levels = 2;
 150
 151         Assert(Last_level == 8);
 152
 153         strcpy(Level_names[0],"d2leva-1.rl2");
 154         strcpy(Level_names[1],"d2leva-2.rl2");
 155         strcpy(Level_names[2],"d2leva-3.rl2");
 156         strcpy(Level_names[3],"d2leva-4.rl2");
 157
 158         strcpy(Secret_level_names[0],"d2leva-s.rl2");
 159
 160         strcpy(Level_names[4],"d2levb-1.rl2");
 161         strcpy(Level_names[5],"d2levb-2.rl2");
 162         strcpy(Level_names[6],"d2levb-3.rl2");
 163         strcpy(Level_names[7],"d2levb-4.rl2");
 164
 165         strcpy(Secret_level_names[1],"d2levb-s.rl2");
 166
 167         Secret_level_table[0] = 1;
 168         Secret_level_table[1] = 5;
 169
 170         return 1;
 171 }
 172
 173 int load_mission_by_name(char *mission_name)
 174 {
 175         if (strcmp(mission_name,OEM_MISSION_FILENAME))
 176                 return 0;               //cannot load requested mission
 177         else
 178                 return load_mission(0);
 179
 180 }
 181
 182 #else
 183
 184 //strips damn newline from end of line
 185 char *mfgets(char *s,int n,CFILE *f)
 186 {
 187         char *r;
 188
 189         r = cfgets(s,n,f);
 190         if (r && s[strlen(s)-1] == '\n')
 191                 s[strlen(s)-1] = 0;
 192
 193         return r;
 194 }
 195
 196 //compare a string for a token. returns true if match
 197 int istok(char *buf,char *tok)
 198 {
 199         return strnicmp(buf,tok,strlen(tok)) == 0;
 200
 201 }
 202
 203 //adds a terminating 0 after a string at the first white space
 204 void add_term(char *s)
 205 {
 206         while (*s && !isspace(*s)) s++;
 207
 208         *s = 0;         //terminate!
 209 }
 210
 211 //returns ptr to string after '=' & white space, or NULL if no '='
 212 //adds 0 after parm at first white space
 213 char *get_value(char *buf)
 214 {
 215         char *t;
 216
 217         t = strchr(buf,'=')+1;
 218
 219         if (t) {
 220                 while (*t && isspace(*t)) t++;
 221
 222                 if (*t)
 223                         return t;
 224         }
 225
 226         return NULL;            //error!
 227 }
 228
 229 //reads a line, returns ptr to value of passed parm.  returns NULL if none
 230 char *get_parm_value(char *parm,CFILE *f)
 231 {
 232         static char buf[80];
 233
 234         if (!mfgets(buf,80,f))
 235                 return NULL;
 236
 237         if (istok(buf,parm))
 238                 return get_value(buf);
 239         else
 240                 return NULL;
 241 }
 242
 243 int ml_sort_func(mle *e0,mle *e1)
 244 {
 245         return stricmp(e0->mission_name,e1->mission_name);
 246
 247 }
 248
 249 extern char CDROM_dir[];
 250 extern int HoardEquipped();
 251
 252 #define BUILTIN_MISSION (cfexist("d2.mn2")?"d2.mn2":"d2demo.mn2")
 253
 254 //returns 1 if file read ok, else 0
 255 int read_mission_file(char *filename,int count,int location)
 256 {
 257         char filename2[100];
 258         CFILE *mfile;
 259
 260         switch (location) {
 261                 case ML_MISSIONDIR:
 262                         strcpy(filename2,MISSION_DIR);
 263                         break;
 264
 265                 case ML_CDROM:
 266                         songs_stop_redbook();           //so we can read from the CD
 267                         strcpy(filename2,CDROM_dir);
 268                         break;
 269
 270                 default:
 271                         Int3();         //fall through
 272
 273                 case ML_CURDIR:
 274                         strcpy(filename2,"");
 275                         break;
 276         }
 277         strcat(filename2,filename);
 278
 279         mfile = cfopen(filename2,"rb");
 280
 281         if (mfile) {
 282                 char *p;
 283                 char temp[FILENAME_LEN],*t;
 284
 285                 strcpy(temp,filename);
 286                 if ((t = strchr(temp,'.')) == NULL)
 287                         return 0;       //missing extension
 288                 *t = 0;                 //kill extension
 289
 290                 strncpy( Mission_list[count].filename, temp, 9 );
 291                 Mission_list[count].anarchy_only_flag = 0;
 292                 Mission_list[count].location = location;
 293
 294                 p = get_parm_value("name",mfile);
 295
 296                 if (!p) {               //try enhanced mission
 297                         cfseek(mfile,0,SEEK_SET);
 298                         p = get_parm_value("xname",mfile);
 299                 }
 300
 301 #ifdef NETWORK
 302                 if (HoardEquipped())
 303                 {
 304                         if (!p) {               //try super-enhanced mission!
 305                                 cfseek(mfile,0,SEEK_SET);
 306                                 p = get_parm_value("zname",mfile);
 307                         }
 308                 }
 309 #endif
 310
 311                 if (p) {
 312                         char *t;
 313                         if ((t=strchr(p,';'))!=NULL)
 314                                 *t=0;
 315                         t = p + strlen(p)-1;
 316                         while (isspace(*t)) t--;
 317                         strncpy(Mission_list[count].mission_name,p,MISSION_NAME_LEN);
 318                 }
 319                 else {
 320                         cfclose(mfile);
 321                         return 0;
 322                 }
 323
 324                 p = get_parm_value("type",mfile);
 325
 326                 //get mission type
 327                 if (p)
 328                         Mission_list[count].anarchy_only_flag = istok(p,"anarchy");
 329
 330                 cfclose(mfile);
 331
 332                 return 1;
 333         }
 334
 335         return 0;
 336 }
 337
 338
 339 //fills in the global list of missions.  Returns the number of missions
 340 //in the list.  If anarchy_mode set, don't include non-anarchy levels.
 341 //if there is only one mission, this function will call load_mission on it.
 342
 343 extern char CDROM_dir[];
 344 extern char AltHogDir[];
 345 extern char AltHogdir_initialized;
 346
 347 int build_mission_list(int anarchy_mode)
 348 {
 349         static int num_missions=-1;
 350         int count=0,special_count=0;
 351         FILEFINDSTRUCT find;
 352         char search_name[PATH_MAX + 5] = MISSION_DIR "*.mn2";
 353
 354         //now search for levels on disk
 355
 356 //@@Took out this code because after this routine was called once for
 357 //@@a list of single-player missions, a subsequent call for a list of
 358 //@@anarchy missions would not scan again, and thus would not find the
 359 //@@anarchy-only missions.  If we retain the minimum level of install,
 360 //@@we may want to put the code back in, having it always scan for all
 361 //@@missions, and have the code that uses it sort out the ones it wants.
 362 //@@    if (num_missions != -1) {
 363 //@@            if (Current_mission_num != 0)
 364 //@@                    load_mission(0);                                //set built-in mission as default
 365 //@@            return num_missions;
 366 //@@    }
 367
 368         if (!read_mission_file(BUILTIN_MISSION,0,ML_CURDIR))            //read built-in first
 369                 Error("Could not find required mission file <%s>",BUILTIN_MISSION);
 370
 371         special_count = count=1;
 372
 373         if( !FileFindFirst( search_name, &find ) ) {
 374                 do      {
 375                         if (stricmp(find.name,BUILTIN_MISSION)==0)
 376                                 continue;               //skip the built-in
 377
 378                         if (read_mission_file(find.name,count,ML_MISSIONDIR)) {
 379
 380                                 if (anarchy_mode || !Mission_list[count].anarchy_only_flag)
 381                                         count++;
 382                         }
 383
 384                 } while( !FileFindNext( &find ) && count<MAX_MISSIONS);
 385                 FileFindClose();
 386         }
 387
 388         if (AltHogdir_initialized) {
 389                 strcpy(search_name, AltHogDir);
 390                 strcat(search_name, "/" MISSION_DIR "*.mn2");
 391                 if( !FileFindFirst( search_name, &find ) ) {
 392                         do      {
 393                                 if (stricmp(find.name,BUILTIN_MISSION)==0)
 394                                         continue;               //skip the built-in
 395
 396                                 if (read_mission_file(find.name,count,ML_MISSIONDIR)) {
 397
 398                                         if (anarchy_mode || !Mission_list[count].anarchy_only_flag)
 399                                                 count++;
 400                                 }
 401
 402                         } while( !FileFindNext( &find ) && count<MAX_MISSIONS);
 403                         FileFindClose();
 404                 }
 405         }
 406
 407         //move vertigo to top of mission list
 408         {
 409                 int i;
 410
 411                 for (i=special_count;i<count;i++)
 412                         if (!stricmp(Mission_list[i].filename,"D2X")) {         //swap!
 413                                 mle temp;
 414
 415                                 temp = Mission_list[special_count];
 416                                 Mission_list[special_count] = Mission_list[i];
 417                                 Mission_list[i] = temp;
 418
 419                                 special_count++;
 420
 421                                 break;
 422                         }
 423         }
 424
 425
 426         if (count>special_count)
 427                 qsort(&Mission_list[special_count],count-special_count,sizeof(*Mission_list),
 428                                 (int (*)( const void *, const void * ))ml_sort_func);
 429
 430         load_mission(0);                        //set built-in mission as default
 431
 432         num_missions = count;
 433
 434         return count;
 435 }
 436
 437 void init_extra_robot_movie(char *filename);
 438
 439 //values for built-in mission
 440
 441 //loads the specfied mission from the mission list.  build_mission_list()
 442 //must have been called.  If build_mission_list() returns 0, this function
 443 //does not need to be called.  Returns true if mission loaded ok, else false.
 444 int load_mission(int mission_num)
 445 {
 446         CFILE *mfile;
 447         char buf[80], *v;
 448         int found_hogfile;
 449         int enhanced_mission = 0;
 450
 451         Current_mission_num = mission_num;
 452
 453         mprintf(( 0, "Loading mission %d\n", mission_num ));
 454
 455         //read mission from file
 456
 457         switch (Mission_list[mission_num].location) {
 458                 case ML_MISSIONDIR:     strcpy(buf,MISSION_DIR);        break;
 459                 case ML_CDROM:                  strcpy(buf,CDROM_dir);          break;
 460                 default:                                        Int3();                                                 //fall through
 461                 case ML_CURDIR:         strcpy(buf,"");                         break;
 462         }
 463         strcat(buf,Mission_list[mission_num].filename);
 464         strcat(buf,".mn2");
 465
 466         mfile = cfopen(buf,"rb");
 467         if (mfile == NULL) {
 468                 Current_mission_num = -1;
 469                 return 0;               //error!
 470         }
 471
 472         if (mission_num != 0) {         //for non-builtin missions, load HOG
 473
 474                 strcpy(buf+strlen(buf)-4,".hog");               //change extension
 475
 476                 found_hogfile = cfile_use_alternate_hogfile(buf);
 477
 478                 #ifdef RELEASE                          //for release, require mission to be in hogfile
 479                 if (! found_hogfile) {
 480                         cfclose(mfile);
 481                         Current_mission_num = -1;
 482                         return 0;
 483                 }
 484                 #endif
 485         }
 486
 487         //init vars
 488         Last_level =            0;
 489         Last_secret_level = 0;
 490
 491         while (mfgets(buf,80,mfile)) {
 492
 493                 if (istok(buf,"name"))
 494                         continue;                                               //already have name, go to next line
 495                 if (istok(buf,"xname")) {
 496                         enhanced_mission = 1;
 497                         continue;                                               //already have name, go to next line
 498                 }
 499                 if (istok(buf,"zname")) {
 500                         enhanced_mission = 2;
 501                         continue;                                               //already have name, go to next line
 502                 }
 503                 else if (istok(buf,"type"))
 504                         continue;                                               //already have name, go to next line
 505                 else if (istok(buf,"hog")) {
 506                         char    *bufp = buf;
 507
 508                         while (*(bufp++) != '=')
 509                                 ;
 510
 511                         if (*bufp == ' ')
 512                                 while (*(++bufp) == ' ')
 513                                         ;
 514
 515                         cfile_use_alternate_hogfile(bufp);
 516                         mprintf((0, "Hog file override = [%s]\n", bufp));
 517                 }
 518                 else if (istok(buf,"num_levels")) {
 519
 520                         if ((v=get_value(buf))!=NULL) {
 521                                 int n_levels,i;
 522
 523                                 n_levels = atoi(v);
 524
 525                                 for (i=0;i<n_levels && mfgets(buf,80,mfile);i++) {
 526
 527                                         add_term(buf);
 528                                         if (strlen(buf) <= 12) {
 529                                                 strcpy(Level_names[i],buf);
 530                                                 Last_level++;
 531                                         }
 532                                         else
 533                                                 break;
 534                                 }
 535
 536                         }
 537                 }
 538                 else if (istok(buf,"num_secrets")) {
 539                         if ((v=get_value(buf))!=NULL) {
 540                                 int i;
 541
 542                                 N_secret_levels = atoi(v);
 543
 544                                 Assert(N_secret_levels <= MAX_SECRET_LEVELS_PER_MISSION);
 545
 546                                 for (i=0;i<N_secret_levels && mfgets(buf,80,mfile);i++) {
 547                                         char *t;
 548
 549
 550                                         if ((t=strchr(buf,','))!=NULL) *t++=0;
 551                                         else
 552                                                 break;
 553
 554                                         add_term(buf);
 555                                         if (strlen(buf) <= 12) {
 556                                                 strcpy(Secret_level_names[i],buf);
 557                                                 Secret_level_table[i] = atoi(t);
 558                                                 if (Secret_level_table[i]<1 || Secret_level_table[i]>Last_level)
 559                                                         break;
 560                                                 Last_secret_level--;
 561                                         }
 562                                         else
 563                                                 break;
 564                                 }
 565
 566                         }
 567                 }
 568
 569         }
 570
 571         cfclose(mfile);
 572
 573         if (Last_level <= 0) {
 574                 Current_mission_num = -1;               //no valid mission loaded
 575                 return 0;
 576         }
 577
 578         Current_mission_filename = Mission_list[Current_mission_num].filename;
 579         Current_mission_longname = Mission_list[Current_mission_num].mission_name;
 580
 581         if (enhanced_mission) {
 582                 char t[50];
 583                 extern void bm_read_extra_robots();
 584                 sprintf(t,"%s.ham",Current_mission_filename);
 585                 bm_read_extra_robots(t,enhanced_mission);
 586                 strncpy(t,Current_mission_filename,6);
 587                 strcat(t,"-l.mvl");
 588                 init_extra_robot_movie(t);
 589         }
 590
 591         return 1;
 592 }
 593
 594 //loads the named mission if exists.
 595 //Returns true if mission loaded ok, else false.
 596 int load_mission_by_name(char *mission_name)
 597 {
 598         int n,i;
 599
 600         n = build_mission_list(1);
 601
 602         for (i=0;i<n;i++)
 603                 if (!stricmp(mission_name,Mission_list[i].filename))
 604                         return load_mission(i);
 605
 606         return 0;               //couldn't find mission
 607 }
 608
 609 #endif
 610 #endif
 611