This commit was generated by cvs2svn to compensate for changes in r2,
[btb/d2x.git] / main / mission.h
1 /*
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.
12 */
13
14 #ifndef _MISSION_H
15 #define _MISSION_H
16
17 #include <pstypes.h>
18
19 #define MAX_MISSIONS                                            300
20 #define MAX_LEVELS_PER_MISSION                  30
21 #define MAX_SECRET_LEVELS_PER_MISSION   6
22 #define MISSION_NAME_LEN                                        25
23
24 //mission list entry
25 typedef struct mle {
26         char    filename[9];                    //path and filename without extension
27         char    mission_name[MISSION_NAME_LEN+1];
28         ubyte   anarchy_only_flag;                                      //if true, mission is anarchy only
29         ubyte   location;                                                               //see defines below
30 } mle;
31
32 //values that describe where a mission is located
33 #define ML_CURDIR                       0
34 #define ML_MISSIONDIR   1
35 #define ML_CDROM                        2
36
37 extern mle Mission_list[MAX_MISSIONS];
38
39 extern int Current_mission_num;
40 extern char *Current_mission_filename,*Current_mission_longname;
41
42 //arrays of name of the level files
43 extern char Level_names[MAX_LEVELS_PER_MISSION][FILENAME_LEN];
44 extern char Secret_level_names[MAX_SECRET_LEVELS_PER_MISSION][FILENAME_LEN];
45
46 //fills in the global list of missions.  Returns the number of missions
47 //in the list.  If anarchy_mode set, don't include non-anarchy levels.
48 //if there is only one mission, this function will call load_mission on it.
49 int build_mission_list(int anarchy_mode);
50
51 //loads the specfied mission from the mission list.  build_mission_list()
52 //must have been called.  If build_mission_list() returns 0, this function
53 //does not need to be called.  Returns true if mission loaded ok, else false.
54 int load_mission(int mission_num);
55
56 //loads the named mission if exists.
57 //Returns true if mission loaded ok, else false.
58 int load_mission_by_name(char *mission_name);
59
60 #endif