fe00b3254357890670b3f6737b23c65911780e86
[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
35 typedef struct lump_s
36 {
37         int             fileofs, filelen;
38 } lump_t;
39
40 #define LUMP_ENTITIES   0
41 #define LUMP_PLANES             1
42 #define LUMP_TEXTURES   2
43 #define LUMP_VERTEXES   3
44 #define LUMP_VISIBILITY 4
45 #define LUMP_NODES              5
46 #define LUMP_TEXINFO    6
47 #define LUMP_FACES              7
48 #define LUMP_LIGHTING   8
49 #define LUMP_CLIPNODES  9
50 #define LUMP_LEAFS              10
51 #define LUMP_MARKSURFACES 11
52 #define LUMP_EDGES              12
53 #define LUMP_SURFEDGES  13
54 #define LUMP_MODELS             14
55 #define HEADER_LUMPS    15
56
57 typedef struct hullinfo_s
58 {
59         int                     filehulls;
60         float           hullsizes[MAX_MAP_HULLS][2][3];
61 } hullinfo_t;
62
63 // WARNING: this struct does NOT match q1bsp's disk format because MAX_MAP_HULLS has been changed by Sajt's MCBSP code, this struct is only being used in memory as a result
64 typedef struct dmodel_s
65 {
66         float           mins[3], maxs[3];
67         float           origin[3];
68         int                     headnode[MAX_MAP_HULLS];
69         int                     visleafs;               // not including the solid leaf 0
70         int                     firstface, numfaces;
71 } dmodel_t;
72
73 typedef struct dheader_s
74 {
75         int                     version;
76         lump_t          lumps[HEADER_LUMPS];
77 } dheader_t;
78
79 typedef struct dmiptexlump_s
80 {
81         int                     nummiptex;
82         int                     dataofs[4];             // [nummiptex]
83 } dmiptexlump_t;
84
85 #define MIPLEVELS       4
86 typedef struct miptex_s
87 {
88         char            name[16];
89         unsigned        width, height;
90         unsigned        offsets[MIPLEVELS];             // four mip maps stored
91 } miptex_t;
92
93
94 typedef struct dvertex_s
95 {
96         float   point[3];
97 } dvertex_t;
98
99
100 // 0-2 are axial planes
101 #define PLANE_X                 0
102 #define PLANE_Y                 1
103 #define PLANE_Z                 2
104
105 // 3-5 are non-axial planes snapped to the nearest
106 #define PLANE_ANYX              3
107 #define PLANE_ANYY              4
108 #define PLANE_ANYZ              5
109
110 typedef struct dplane_s
111 {
112         float   normal[3];
113         float   dist;
114         int             type;           // PLANE_X - PLANE_ANYZ ?remove? trivial to regenerate
115 } dplane_t;
116
117
118 // contents values in Q1 maps
119 #define CONTENTS_EMPTY                  -1
120 #define CONTENTS_SOLID                  -2
121 #define CONTENTS_WATER                  -3
122 #define CONTENTS_SLIME                  -4
123 #define CONTENTS_LAVA                           -5
124 #define CONTENTS_SKY                            -6
125 // these were #ifdef QUAKE2 in the quake source
126 #define CONTENTS_ORIGIN                 -7 // removed at csg time
127 #define CONTENTS_CLIP                           -8 // changed to contents_solid
128 #define CONTENTS_CURRENT_0              -9
129 #define CONTENTS_CURRENT_90             -10
130 #define CONTENTS_CURRENT_180            -11
131 #define CONTENTS_CURRENT_270            -12
132 #define CONTENTS_CURRENT_UP             -13
133 #define CONTENTS_CURRENT_DOWN           -14
134
135 //contents flags in Q2 maps
136 #define CONTENTSQ2_SOLID                        0x00000001 // an eye is never valid in a solid
137 #define CONTENTSQ2_WINDOW                       0x00000002 // translucent, but not watery
138 #define CONTENTSQ2_AUX                          0x00000004
139 #define CONTENTSQ2_LAVA                         0x00000008
140 #define CONTENTSQ2_SLIME                        0x00000010
141 #define CONTENTSQ2_WATER                        0x00000020
142 #define CONTENTSQ2_MIST                         0x00000040
143 #define CONTENTSQ2_AREAPORTAL           0x00008000
144 #define CONTENTSQ2_PLAYERCLIP           0x00010000
145 #define CONTENTSQ2_MONSTERCLIP          0x00020000
146 #define CONTENTSQ2_CURRENT_0            0x00040000
147 #define CONTENTSQ2_CURRENT_90           0x00080000
148 #define CONTENTSQ2_CURRENT_180          0x00100000
149 #define CONTENTSQ2_CURRENT_270          0x00200000
150 #define CONTENTSQ2_CURRENT_UP           0x00400000
151 #define CONTENTSQ2_CURRENT_DOWN         0x00800000
152 #define CONTENTSQ2_ORIGIN                       0x01000000 // removed before bsping an entity
153 #define CONTENTSQ2_MONSTER                      0x02000000 // should never be on a brush, only in game
154 #define CONTENTSQ2_DEADMONSTER          0x04000000
155 #define CONTENTSQ2_DETAIL                       0x08000000 // brushes to be added after vis leafs
156 #define CONTENTSQ2_TRANSLUCENT          0x10000000 // auto set if any surface has trans
157 #define CONTENTSQ2_LADDER                       0x20000000
158
159 //contents flags in Q3 maps
160 #define CONTENTSQ3_SOLID                        0x00000001 // solid (opaque and transparent)
161 #define CONTENTSQ3_LAVA                         0x00000008 // lava
162 #define CONTENTSQ3_SLIME                        0x00000010 // slime
163 #define CONTENTSQ3_WATER                        0x00000020 // water
164 #define CONTENTSQ3_FOG                          0x00000040 // unused?
165 #define CONTENTSQ3_AREAPORTAL           0x00008000 // areaportal (separates areas)
166 #define CONTENTSQ3_PLAYERCLIP           0x00010000 // block players
167 #define CONTENTSQ3_MONSTERCLIP          0x00020000 // block monsters
168 #define CONTENTSQ3_TELEPORTER           0x00040000 // hint for Q3's bots
169 #define CONTENTSQ3_JUMPPAD                      0x00080000 // hint for Q3's bots
170 #define CONTENTSQ3_CLUSTERPORTAL        0x00100000 // hint for Q3's bots
171 #define CONTENTSQ3_DONOTENTER           0x00200000 // hint for Q3's bots
172 #define CONTENTSQ3_BOTCLIP                      0x00400000 // 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_BOTCLIP           0x00000800
194 #define SUPERCONTENTS_OPAQUE            0x00001000
195 // TODO: is there any reason to define:
196 //   fog?
197 //   areaportal?
198 //   teleporter?
199 //   jumppad?
200 //   clusterportal?
201 //   detail?         (div0) no, game code should not be allowed to differentiate between structural and detail
202 //   structural?     (div0) no, game code should not be allowed to differentiate between structural and detail
203 //   trigger?        (div0) no, as these are always solid anyway, and that's all that matters for trigger brushes
204 #define SUPERCONTENTS_LIQUIDSMASK       (SUPERCONTENTS_LAVA | SUPERCONTENTS_SLIME | SUPERCONTENTS_WATER)
205 #define SUPERCONTENTS_VISBLOCKERMASK    SUPERCONTENTS_OPAQUE
206
207 /*
208 #define SUPERCONTENTS_DEADMONSTER       0x00000000
209 #define SUPERCONTENTS_CURRENT_0         0x00000000
210 #define SUPERCONTENTS_CURRENT_90        0x00000000
211 #define SUPERCONTENTS_CURRENT_180       0x00000000
212 #define SUPERCONTENTS_CURRENT_270       0x00000000
213 #define SUPERCONTENTS_CURRENT_DOWN      0x00000000
214 #define SUPERCONTENTS_CURRENT_UP        0x00000000
215 #define SUPERCONTENTS_AREAPORTAL        0x00000000
216 #define SUPERCONTENTS_AUX                       0x00000000
217 #define SUPERCONTENTS_CLUSTERPORTAL     0x00000000
218 #define SUPERCONTENTS_DETAIL            0x00000000
219 #define SUPERCONTENTS_STRUCTURAL        0x00000000
220 #define SUPERCONTENTS_DONOTENTER        0x00000000
221 #define SUPERCONTENTS_JUMPPAD           0x00000000
222 #define SUPERCONTENTS_LADDER            0x00000000
223 #define SUPERCONTENTS_MONSTER           0x00000000
224 #define SUPERCONTENTS_MONSTERCLIP       0x00000000
225 #define SUPERCONTENTS_PLAYERCLIP        0x00000000
226 #define SUPERCONTENTS_TELEPORTER        0x00000000
227 #define SUPERCONTENTS_TRANSLUCENT       0x00000000
228 #define SUPERCONTENTS_TRIGGER           0x00000000
229 #define SUPERCONTENTS_WINDOW            0x00000000
230 */
231
232
233 typedef struct dnode_s
234 {
235         int                     planenum;
236         short           children[2];    // negative numbers are -(leafs+1), not nodes
237         short           mins[3];                // for sphere culling
238         short           maxs[3];
239         unsigned short  firstface;
240         unsigned short  numfaces;       // counting both sides
241 } dnode_t;
242
243 typedef struct dclipnode_s
244 {
245         int                     planenum;
246         short           children[2];    // negative numbers are contents
247 } dclipnode_t;
248
249
250 typedef struct texinfo_s
251 {
252         float           vecs[2][4];             // [s/t][xyz offset]
253         int                     miptex;
254         int                     flags;
255 } texinfo_t;
256 #define TEX_SPECIAL             1               // sky or slime, no lightmap or 256 subdivision
257
258 // note that edge 0 is never used, because negative edge nums are used for
259 // counterclockwise use of the edge in a face
260 typedef struct dedge_s
261 {
262         unsigned short  v[2];           // vertex numbers
263 } dedge_t;
264
265 #define MAXLIGHTMAPS    4
266 typedef struct dface_s
267 {
268         // LordHavoc: changed from short to unsigned short for q2 support
269         unsigned short  planenum;
270         short           side;
271
272         int                     firstedge;              // we must support > 64k edges
273         short           numedges;
274         short           texinfo;
275
276 // lighting info
277         unsigned char           styles[MAXLIGHTMAPS];
278         int                     lightofs;               // start of [numstyles*surfsize] samples
279 } dface_t;
280
281
282
283 #define AMBIENT_WATER   0
284 #define AMBIENT_SKY             1
285 #define AMBIENT_SLIME   2
286 #define AMBIENT_LAVA    3
287
288 #define NUM_AMBIENTS                    4               // automatic ambient sounds
289
290 // leaf 0 is the generic CONTENTS_SOLID leaf, used for all solid areas
291 // all other leafs need visibility info
292 typedef struct dleaf_s
293 {
294         int                     contents;
295         int                     visofs;                         // -1 = no visibility info
296
297         short           mins[3];                        // for frustum culling
298         short           maxs[3];
299
300         unsigned short          firstmarksurface;
301         unsigned short          nummarksurfaces;
302
303         unsigned char           ambient_level[NUM_AMBIENTS];
304 } dleaf_t;
305