730fbde4ccab5c68cbaabbe1a05702411040bf0b
[divverent/darkplaces.git] / bspfile.h
1 /*
2 Copyright (C) 1996-1997 Id Software, Inc.
3
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12
13 See the GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18
19 */
20
21
22 #define MAX_MAP_HULLS           16              // was 4
23 #define MAX_MAP_LEAFS           65536   // was 8192
24
25 // key / value pair sizes
26
27 #define MAX_KEY         32
28 #define MAX_VALUE       1024
29
30 //=============================================================================
31
32
33 #define BSPVERSION      29
34 #define MCBSPVERSION 2
35
36 typedef struct
37 {
38         int             fileofs, filelen;
39 } lump_t;
40
41 #define LUMP_ENTITIES   0
42 #define LUMP_PLANES             1
43 #define LUMP_TEXTURES   2
44 #define LUMP_VERTEXES   3
45 #define LUMP_VISIBILITY 4
46 #define LUMP_NODES              5
47 #define LUMP_TEXINFO    6
48 #define LUMP_FACES              7
49 #define LUMP_LIGHTING   8
50 #define LUMP_CLIPNODES  9
51 #define LUMP_LEAFS              10
52 #define LUMP_MARKSURFACES 11
53 #define LUMP_EDGES              12
54 #define LUMP_SURFEDGES  13
55 #define LUMP_MODELS             14
56 #define HEADER_LUMPS    15
57
58 typedef struct
59 {
60         int                     numhulls;
61         int                     filehulls;
62         float           hullsizes[MAX_MAP_HULLS][2][3];
63 } dhullinfo_t;
64
65 typedef struct
66 {
67         float           mins[3], maxs[3];
68         float           origin[3];
69         int                     headnode[MAX_MAP_HULLS];
70         int                     visleafs;               // not including the solid leaf 0
71         int                     firstface, numfaces;
72 } dmodel_t;
73
74 typedef struct
75 {
76         int                     version;
77         lump_t          lumps[HEADER_LUMPS];
78 } dheader_t;
79
80 typedef struct
81 {
82         int                     nummiptex;
83         int                     dataofs[4];             // [nummiptex]
84 } dmiptexlump_t;
85
86 #define MIPLEVELS       4
87 typedef struct miptex_s
88 {
89         char            name[16];
90         unsigned        width, height;
91         unsigned        offsets[MIPLEVELS];             // four mip maps stored
92 } miptex_t;
93
94
95 typedef struct
96 {
97         float   point[3];
98 } dvertex_t;
99
100
101 // 0-2 are axial planes
102 #define PLANE_X                 0
103 #define PLANE_Y                 1
104 #define PLANE_Z                 2
105
106 // 3-5 are non-axial planes snapped to the nearest
107 #define PLANE_ANYX              3
108 #define PLANE_ANYY              4
109 #define PLANE_ANYZ              5
110
111 typedef struct
112 {
113         float   normal[3];
114         float   dist;
115         int             type;           // PLANE_X - PLANE_ANYZ ?remove? trivial to regenerate
116 } dplane_t;
117
118
119 // contents values in Q1 maps
120 #define CONTENTS_EMPTY                  -1
121 #define CONTENTS_SOLID                  -2
122 #define CONTENTS_WATER                  -3
123 #define CONTENTS_SLIME                  -4
124 #define CONTENTS_LAVA                           -5
125 #define CONTENTS_SKY                            -6
126 // these were #ifdef QUAKE2 in the quake source
127 #define CONTENTS_ORIGIN                 -7 // removed at csg time
128 #define CONTENTS_CLIP                           -8 // changed to contents_solid
129 #define CONTENTS_CURRENT_0              -9
130 #define CONTENTS_CURRENT_90             -10
131 #define CONTENTS_CURRENT_180            -11
132 #define CONTENTS_CURRENT_270            -12
133 #define CONTENTS_CURRENT_UP             -13
134 #define CONTENTS_CURRENT_DOWN           -14
135
136 //contents flags in Q2 maps
137 #define CONTENTSQ2_SOLID                        0x00000001 // an eye is never valid in a solid
138 #define CONTENTSQ2_WINDOW                       0x00000002 // translucent, but not watery
139 #define CONTENTSQ2_AUX                          0x00000004
140 #define CONTENTSQ2_LAVA                         0x00000008
141 #define CONTENTSQ2_SLIME                        0x00000010
142 #define CONTENTSQ2_WATER                        0x00000020
143 #define CONTENTSQ2_MIST                         0x00000040
144 #define CONTENTSQ2_AREAPORTAL           0x00008000
145 #define CONTENTSQ2_PLAYERCLIP           0x00010000
146 #define CONTENTSQ2_MONSTERCLIP          0x00020000
147 #define CONTENTSQ2_CURRENT_0            0x00040000
148 #define CONTENTSQ2_CURRENT_90           0x00080000
149 #define CONTENTSQ2_CURRENT_180          0x00100000
150 #define CONTENTSQ2_CURRENT_270          0x00200000
151 #define CONTENTSQ2_CURRENT_UP           0x00400000
152 #define CONTENTSQ2_CURRENT_DOWN         0x00800000
153 #define CONTENTSQ2_ORIGIN                       0x01000000 // removed before bsping an entity
154 #define CONTENTSQ2_MONSTER                      0x02000000 // should never be on a brush, only in game
155 #define CONTENTSQ2_DEADMONSTER          0x04000000
156 #define CONTENTSQ2_DETAIL                       0x08000000 // brushes to be added after vis leafs
157 #define CONTENTSQ2_TRANSLUCENT          0x10000000 // auto set if any surface has trans
158 #define CONTENTSQ2_LADDER                       0x20000000
159
160 //contents flags in Q3 maps
161 #define CONTENTSQ3_SOLID                        0x00000001 // solid (opaque and transparent)
162 #define CONTENTSQ3_LAVA                         0x00000008 // lava
163 #define CONTENTSQ3_SLIME                        0x00000010 // slime
164 #define CONTENTSQ3_WATER                        0x00000020 // water
165 #define CONTENTSQ3_FOG                          0x00000040 // unused?
166 #define CONTENTSQ3_AREAPORTAL           0x00008000 // areaportal (separates areas)
167 #define CONTENTSQ3_PLAYERCLIP           0x00010000 // block players
168 #define CONTENTSQ3_MONSTERCLIP          0x00020000 // block monsters
169 #define CONTENTSQ3_TELEPORTER           0x00040000 // hint for Q3's bots
170 #define CONTENTSQ3_JUMPPAD                      0x00080000 // hint for Q3's bots
171 #define CONTENTSQ3_CLUSTERPORTAL        0x00100000 // hint for Q3's bots
172 #define CONTENTSQ3_DONOTENTER           0x00200000 // hint for Q3's bots
173 #define CONTENTSQ3_ORIGIN                       0x01000000 // used by origin brushes to indicate origin of bmodel (removed by map compiler)
174 #define CONTENTSQ3_BODY                         0x02000000 // used by bbox entities (should never be on a brush)
175 #define CONTENTSQ3_CORPSE                       0x04000000 // used by dead bodies (SOLID_CORPSE in darkplaces)
176 #define CONTENTSQ3_DETAIL                       0x08000000 // brushes that do not split the bsp tree (decorations)
177 #define CONTENTSQ3_STRUCTURAL           0x10000000 // brushes that split the bsp tree
178 #define CONTENTSQ3_TRANSLUCENT          0x20000000 // leaves surfaces that are inside for rendering
179 #define CONTENTSQ3_TRIGGER                      0x40000000 // used by trigger entities
180 #define CONTENTSQ3_NODROP                       0x80000000 // remove items that fall into this brush
181
182 #define SUPERCONTENTS_SOLID                     0x00000001
183 #define SUPERCONTENTS_WATER                     0x00000002
184 #define SUPERCONTENTS_SLIME                     0x00000004
185 #define SUPERCONTENTS_LAVA                      0x00000008
186 #define SUPERCONTENTS_SKY                       0x00000010
187 #define SUPERCONTENTS_BODY                      0x00000020
188 #define SUPERCONTENTS_CORPSE            0x00000040
189 #define SUPERCONTENTS_NODROP            0x00000080
190 #define SUPERCONTENTS_PLAYERCLIP        0x00000100
191 #define SUPERCONTENTS_MONSTERCLIP       0x00000200
192 #define SUPERCONTENTS_DONOTENTER        0x00000400
193 #define SUPERCONTENTS_LIQUIDSMASK       (SUPERCONTENTS_LAVA | SUPERCONTENTS_SLIME | SUPERCONTENTS_WATER)
194
195 /*
196 #define SUPERCONTENTS_DEADMONSTER       0x00000000
197 #define SUPERCONTENTS_CURRENT_0         0x00000000
198 #define SUPERCONTENTS_CURRENT_90        0x00000000
199 #define SUPERCONTENTS_CURRENT_180       0x00000000
200 #define SUPERCONTENTS_CURRENT_270       0x00000000
201 #define SUPERCONTENTS_CURRENT_DOWN      0x00000000
202 #define SUPERCONTENTS_CURRENT_UP        0x00000000
203 #define SUPERCONTENTS_AREAPORTAL        0x00000000
204 #define SUPERCONTENTS_AUX                       0x00000000
205 #define SUPERCONTENTS_CLUSTERPORTAL     0x00000000
206 #define SUPERCONTENTS_DETAIL            0x00000000
207 #define SUPERCONTENTS_STRUCTURAL        0x00000000
208 #define SUPERCONTENTS_DONOTENTER        0x00000000
209 #define SUPERCONTENTS_JUMPPAD           0x00000000
210 #define SUPERCONTENTS_LADDER            0x00000000
211 #define SUPERCONTENTS_MONSTER           0x00000000
212 #define SUPERCONTENTS_MONSTERCLIP       0x00000000
213 #define SUPERCONTENTS_PLAYERCLIP        0x00000000
214 #define SUPERCONTENTS_TELEPORTER        0x00000000
215 #define SUPERCONTENTS_TRANSLUCENT       0x00000000
216 #define SUPERCONTENTS_TRIGGER           0x00000000
217 #define SUPERCONTENTS_WINDOW            0x00000000
218 */
219
220
221 typedef struct
222 {
223         int                     planenum;
224         short           children[2];    // negative numbers are -(leafs+1), not nodes
225         short           mins[3];                // for sphere culling
226         short           maxs[3];
227         unsigned short  firstface;
228         unsigned short  numfaces;       // counting both sides
229 } dnode_t;
230
231 typedef struct
232 {
233         int                     planenum;
234         short           children[2];    // negative numbers are contents
235 } dclipnode_t;
236
237
238 typedef struct
239 {
240         float           vecs[2][4];             // [s/t][xyz offset]
241         int                     miptex;
242         int                     flags;
243 } texinfo_t;
244 #define TEX_SPECIAL             1               // sky or slime, no lightmap or 256 subdivision
245
246 // note that edge 0 is never used, because negative edge nums are used for
247 // counterclockwise use of the edge in a face
248 typedef struct
249 {
250         unsigned short  v[2];           // vertex numbers
251 } dedge_t;
252
253 #define MAXLIGHTMAPS    4
254 typedef struct
255 {
256         // LordHavoc: changed from short to unsigned short for q2 support
257         unsigned short  planenum;
258         short           side;
259
260         int                     firstedge;              // we must support > 64k edges
261         short           numedges;
262         short           texinfo;
263
264 // lighting info
265         qbyte           styles[MAXLIGHTMAPS];
266         int                     lightofs;               // start of [numstyles*surfsize] samples
267 } dface_t;
268
269
270
271 #define AMBIENT_WATER   0
272 #define AMBIENT_SKY             1
273 #define AMBIENT_SLIME   2
274 #define AMBIENT_LAVA    3
275
276 #define NUM_AMBIENTS                    4               // automatic ambient sounds
277
278 // leaf 0 is the generic CONTENTS_SOLID leaf, used for all solid areas
279 // all other leafs need visibility info
280 typedef struct
281 {
282         int                     contents;
283         int                     visofs;                         // -1 = no visibility info
284
285         short           mins[3];                        // for frustum culling
286         short           maxs[3];
287
288         unsigned short          firstmarksurface;
289         unsigned short          nummarksurfaces;
290
291         qbyte           ambient_level[NUM_AMBIENTS];
292 } dleaf_t;
293