most of Q2's keyboard handling ported over - what this means: keypad is now separatel...
[divverent/darkplaces.git] / protocol.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 // protocol.h -- communications protocols
21
22 #ifndef PROTOCOL_H
23 #define PROTOCOL_H
24
25 #define PROTOCOL_VERSION        15
26 #define DPPROTOCOL_VERSION1     96
27 #define DPPROTOCOL_VERSION2     97
28 // LordHavoc: I think the 96-99 range was going to run out too soon...  so here I jump to 3500
29 #define DPPROTOCOL_VERSION3     3500
30
31 // model effects
32 #define EF_ROCKET       1                       // leave a trail
33 #define EF_GRENADE      2                       // leave a trail
34 #define EF_GIB          4                       // leave a trail
35 #define EF_ROTATE       8                       // rotate (bonus items)
36 #define EF_TRACER       16                      // green split trail
37 #define EF_ZOMGIB       32                      // small blood trail
38 #define EF_TRACER2      64                      // orange split trail + rotate
39 #define EF_TRACER3      128                     // purple trail
40 // entity effects
41 #define EF_BRIGHTFIELD                  1
42 #define EF_MUZZLEFLASH                  2
43 #define EF_BRIGHTLIGHT                  4
44 #define EF_DIMLIGHT                     8
45 #define EF_NODRAW                               16
46 #define EF_ADDITIVE                             32
47 #define EF_BLUE                                 64
48 #define EF_RED                                  128
49 #define EF_DELTA                                8388608 // LordHavoc: (obsolete) entity is delta compressed to save network bandwidth  (no longer used)
50 #define EF_LOWPRECISION                 4194304 // LordHavoc: entity is low precision (integer coordinates) to save network bandwidth
51 // effects/model (can be used as model flags or entity effects)
52 #define EF_REFLECTIVE                   256             // LordHavoc: shiny metal objects :)  (not currently supported)
53 #define EF_FULLBRIGHT                   512             // LordHavoc: fullbright
54 #define EF_FLAME                                1024    // LordHavoc: on fire
55 #define EF_STARDUST                             2048    // LordHavoc: showering sparks
56
57 #define EF_STEP                                 0x80000000 // internal client use only - present on MOVETYPE_STEP entities, not QC accessible (too many bits)
58
59 // if the high bit of the servercmd is set, the low bits are fast update flags:
60 #define U_MOREBITS              (1<<0)
61 #define U_ORIGIN1               (1<<1)
62 #define U_ORIGIN2               (1<<2)
63 #define U_ORIGIN3               (1<<3)
64 #define U_ANGLE2                (1<<4)
65 // LordHavoc: U_NOLERP was only ever used for monsters, so I renamed it U_STEP
66 #define U_STEP                  (1<<5)
67 #define U_FRAME                 (1<<6)
68 // just differentiates from other updates
69 #define U_SIGNAL                (1<<7)
70
71 #define U_ANGLE1                (1<<8)
72 #define U_ANGLE3                (1<<9)
73 #define U_MODEL                 (1<<10)
74 #define U_COLORMAP              (1<<11)
75 #define U_SKIN                  (1<<12)
76 #define U_EFFECTS               (1<<13)
77 #define U_LONGENTITY    (1<<14)
78
79 // LordHavoc: protocol extension
80 #define U_EXTEND1               (1<<15)
81 // LordHavoc: first extend byte
82 #define U_DELTA                 (1<<16) // no data, while this is set the entity is delta compressed (uses previous frame as a baseline, meaning only things that have changed from the previous frame are sent, except for the forced full update every half second)
83 #define U_ALPHA                 (1<<17) // 1 byte, 0.0-1.0 maps to 0-255, not sent if exactly 1, and the entity is not sent if <=0 unless it has effects (model effects are checked as well)
84 #define U_SCALE                 (1<<18) // 1 byte, scale / 16 positive, not sent if 1.0
85 #define U_EFFECTS2              (1<<19) // 1 byte, this is .effects & 0xFF00 (second byte)
86 #define U_GLOWSIZE              (1<<20) // 1 byte, encoding is float/8.0, signed (negative is darklight), not sent if 0
87 #define U_GLOWCOLOR             (1<<21) // 1 byte, palette index, default is 254 (white), this IS used for darklight (allowing colored darklight), however the particles from a darklight are always black, not sent if default value (even if glowsize or glowtrail is set)
88 // LordHavoc: colormod feature has been removed, because no one used it
89 #define U_COLORMOD              (1<<22) // 1 byte, 3 bit red, 3 bit green, 2 bit blue, this lets you tint an object artifically, so you could make a red rocket, or a blue fiend...
90 #define U_EXTEND2               (1<<23) // another byte to follow
91 // LordHavoc: second extend byte
92 #define U_GLOWTRAIL             (1<<24) // leaves a trail of particles (of color .glowcolor, or black if it is a negative glowsize)
93 #define U_VIEWMODEL             (1<<25) // attachs the model to the view (origin and angles become relative to it), only shown to owner, a more powerful alternative to .weaponmodel and such
94 #define U_FRAME2                (1<<26) // 1 byte, this is .frame & 0xFF00 (second byte)
95 #define U_MODEL2                (1<<27) // 1 byte, this is .modelindex & 0xFF00 (second byte)
96 #define U_EXTERIORMODEL (1<<28) // causes this model to not be drawn when using a first person view (third person will draw it, first person will not)
97 #define U_UNUSED29              (1<<29) // future expansion
98 #define U_UNUSED30              (1<<30) // future expansion
99 #define U_EXTEND3               (1<<31) // another byte to follow, future expansion
100
101 #define SU_VIEWHEIGHT   (1<<0)
102 #define SU_IDEALPITCH   (1<<1)
103 #define SU_PUNCH1               (1<<2)
104 #define SU_PUNCH2               (1<<3)
105 #define SU_PUNCH3               (1<<4)
106 #define SU_VELOCITY1    (1<<5)
107 #define SU_VELOCITY2    (1<<6)
108 #define SU_VELOCITY3    (1<<7)
109 //define        SU_AIMENT               (1<<8)  AVAILABLE BIT
110 #define SU_ITEMS                (1<<9)
111 #define SU_ONGROUND             (1<<10)         // no data follows, the bit is it
112 #define SU_INWATER              (1<<11)         // no data follows, the bit is it
113 #define SU_WEAPONFRAME  (1<<12)
114 #define SU_ARMOR                (1<<13)
115 #define SU_WEAPON               (1<<14)
116 #define SU_EXTEND1              (1<<15)
117 // first extend byte
118 #define SU_PUNCHVEC1    (1<<16)
119 #define SU_PUNCHVEC2    (1<<17)
120 #define SU_PUNCHVEC3    (1<<18)
121 #define SU_VIEWZOOM             (1<<19) // byte factor (0 = 0.0 (not valid), 255 = 1.0)
122 #define SU_UNUSED20             (1<<20)
123 #define SU_UNUSED21             (1<<21)
124 #define SU_UNUSED22             (1<<22)
125 #define SU_EXTEND2              (1<<23) // another byte to follow, future expansion
126 // second extend byte
127 #define SU_UNUSED24             (1<<24)
128 #define SU_UNUSED25             (1<<25)
129 #define SU_UNUSED26             (1<<26)
130 #define SU_UNUSED27             (1<<27)
131 #define SU_UNUSED28             (1<<28)
132 #define SU_UNUSED29             (1<<29)
133 #define SU_UNUSED30             (1<<30)
134 #define SU_EXTEND3              (1<<31) // another byte to follow, future expansion
135
136 // a sound with no channel is a local only sound
137 #define SND_VOLUME              (1<<0)          // a byte
138 #define SND_ATTENUATION (1<<1)          // a byte
139 #define SND_LOOPING             (1<<2)          // a long
140
141
142 // defaults for clientinfo messages
143 #define DEFAULT_VIEWHEIGHT      22
144
145
146 // game types sent by serverinfo
147 // these determine which intermission screen plays
148 #define GAME_COOP                       0
149 #define GAME_DEATHMATCH         1
150
151 //==================
152 // note that there are some defs.qc that mirror to these numbers
153 // also related to svc_strings[] in cl_parse
154 //==================
155
156 //
157 // server to client
158 //
159 #define svc_bad                         0
160 #define svc_nop                         1
161 #define svc_disconnect          2
162 #define svc_updatestat          3       // [byte] [long]
163 #define svc_version                     4       // [long] server version
164 #define svc_setview                     5       // [short] entity number
165 #define svc_sound                       6       // <see code>
166 #define svc_time                        7       // [float] server time
167 #define svc_print                       8       // [string] null terminated string
168 #define svc_stufftext           9       // [string] stuffed into client's console buffer
169                                                                 // the string should be \n terminated
170 #define svc_setangle            10      // [angle3] set the view angle to this absolute value
171
172 #define svc_serverinfo          11      // [long] version
173                                                 // [string] signon string
174                                                 // [string]..[0]model cache
175                                                 // [string]...[0]sounds cache
176 #define svc_lightstyle          12      // [byte] [string]
177 #define svc_updatename          13      // [byte] [string]
178 #define svc_updatefrags         14      // [byte] [short]
179 #define svc_clientdata          15      // <shortbits + data>
180 #define svc_stopsound           16      // <see code>
181 #define svc_updatecolors        17      // [byte] [byte]
182 #define svc_particle            18      // [vec3] <variable>
183 #define svc_damage                      19
184
185 #define svc_spawnstatic         20
186 //      svc_spawnbinary         21
187 #define svc_spawnbaseline       22
188
189 #define svc_temp_entity         23
190
191 #define svc_setpause            24      // [byte] on / off
192 #define svc_signonnum           25      // [byte]  used for the signon sequence
193
194 #define svc_centerprint         26      // [string] to put in center of the screen
195
196 #define svc_killedmonster       27
197 #define svc_foundsecret         28
198
199 #define svc_spawnstaticsound    29      // [coord3] [byte] samp [byte] vol [byte] aten
200
201 #define svc_intermission        30              // [string] music
202 #define svc_finale                      31              // [string] music [string] text
203
204 #define svc_cdtrack                     32              // [byte] track [byte] looptrack
205 #define svc_sellscreen          33
206
207 #define svc_cutscene            34
208
209 #define svc_showlmp                     35              // [string] slotname [string] lmpfilename [short] x [short] y
210 #define svc_hidelmp                     36              // [string] slotname
211 #define svc_skybox                      37              // [string] skyname
212
213 // LordHavoc: my svc_ range, 50-59
214 #define svc_cgame                       50              // [short] length [bytes] data
215 #define svc_unusedlh1           51
216 #define svc_effect                      52              // [vector] org [byte] modelindex [byte] startframe [byte] framecount [byte] framerate
217 #define svc_effect2                     53              // [vector] org [short] modelindex [short] startframe [byte] framecount [byte] framerate
218 #define svc_sound2                      54              // short soundindex instead of byte
219 #define svc_spawnbaseline2      55              // short modelindex instead of byte
220 #define svc_spawnstatic2        56              // short modelindex instead of byte
221 #define svc_entities            57              // [int] deltaframe [int] thisframe [float vector] eye [variable length] entitydata
222 #define svc_unusedlh3                   58
223 #define svc_spawnstaticsound2   59      // [coord3] [short] samp [byte] vol [byte] aten
224
225 //
226 // client to server
227 //
228 #define clc_bad                 0
229 #define clc_nop                 1
230 #define clc_disconnect  2
231 #define clc_move                3                       // [usercmd_t]
232 #define clc_stringcmd   4               // [string] message
233
234 // LordHavoc: my clc_ range, 50-59
235 #define clc_ackentities 50              // [int] framenumber
236 #define clc_unusedlh1   51
237 #define clc_unusedlh2   52
238 #define clc_unusedlh3   53
239 #define clc_unusedlh4   54
240 #define clc_unusedlh5   55
241 #define clc_unusedlh6   56
242 #define clc_unusedlh7   57
243 #define clc_unusedlh8   58
244 #define clc_unusedlh9   59
245
246 //
247 // temp entity events
248 //
249 #define TE_SPIKE                        0 // [vector] origin
250 #define TE_SUPERSPIKE           1 // [vector] origin
251 #define TE_GUNSHOT                      2 // [vector] origin
252 #define TE_EXPLOSION            3 // [vector] origin
253 #define TE_TAREXPLOSION         4 // [vector] origin
254 #define TE_LIGHTNING1           5 // [entity] entity [vector] start [vector] end
255 #define TE_LIGHTNING2           6 // [entity] entity [vector] start [vector] end
256 #define TE_WIZSPIKE                     7 // [vector] origin
257 #define TE_KNIGHTSPIKE          8 // [vector] origin
258 #define TE_LIGHTNING3           9 // [entity] entity [vector] start [vector] end
259 #define TE_LAVASPLASH           10 // [vector] origin
260 #define TE_TELEPORT                     11 // [vector] origin
261 #define TE_EXPLOSION2           12 // [vector] origin [byte] startcolor [byte] colorcount
262
263 // PGM 01/21/97
264 #define TE_BEAM                         13 // [entity] entity [vector] start [vector] end
265 // PGM 01/21/97
266
267 // Nehahra effects used in the movie (TE_EXPLOSION3 also got written up in a QSG tutorial, hence it's not marked NEH)
268 #define TE_EXPLOSION3           16 // [vector] origin [coord] red [coord] green [coord] blue
269 #define TE_LIGHTNING4NEH        17 // [string] model [entity] entity [vector] start [vector] end
270
271 // LordHavoc: added some TE_ codes (block1 - 50-60)
272 #define TE_BLOOD                        50 // [vector] origin [byte] xvel [byte] yvel [byte] zvel [byte] count
273 #define TE_SPARK                        51 // [vector] origin [byte] xvel [byte] yvel [byte] zvel [byte] count
274 #define TE_BLOODSHOWER          52 // [vector] min [vector] max [coord] explosionspeed [short] count
275 #define TE_EXPLOSIONRGB         53 // [vector] origin [byte] red [byte] green [byte] blue
276 #define TE_PARTICLECUBE         54 // [vector] min [vector] max [vector] dir [short] count [byte] color [byte] gravity [coord] randomvel
277 #define TE_PARTICLERAIN         55 // [vector] min [vector] max [vector] dir [short] count [byte] color
278 #define TE_PARTICLESNOW         56 // [vector] min [vector] max [vector] dir [short] count [byte] color
279 #define TE_GUNSHOTQUAD          57 // [vector] origin
280 #define TE_SPIKEQUAD            58 // [vector] origin
281 #define TE_SUPERSPIKEQUAD       59 // [vector] origin
282 // LordHavoc: block2 - 70-80
283 #define TE_EXPLOSIONQUAD        70 // [vector] origin
284 #define TE_BLOOD2                       71 // [vector] origin
285 #define TE_SMALLFLASH           72 // [vector] origin
286 #define TE_CUSTOMFLASH          73 // [vector] origin [byte] radius / 8 - 1 [byte] lifetime / 256 - 1 [byte] red [byte] green [byte] blue
287 #define TE_FLAMEJET                     74 // [vector] origin [vector] velocity [byte] count
288 #define TE_PLASMABURN           75 // [vector] origin
289 // LordHavoc: Tei grabbed these codes
290 #define TE_TEI_G3                       76 // [vector] start [vector] end [vector] angles
291 #define TE_TEI_SMOKE            77 // [vector] origin [vector] dir [byte] count
292 #define TE_TEI_BIGEXPLOSION     78 // [vector] origin
293 #define TE_TEI_PLASMAHIT        79 // [vector} origin [vector] dir [byte] count
294
295
296 // these are bits for the 'flags' field of the entity_state_t
297 #define RENDER_STEP 1
298 #define RENDER_GLOWTRAIL 2
299 #define RENDER_VIEWMODEL 4
300 #define RENDER_EXTERIORMODEL 8
301 #define RENDER_LOWPRECISION 16 // send as low precision coordinates to save bandwidth
302 #define RENDER_COLORMAPPED 32
303
304 typedef struct
305 {
306         double time; // time this state was built
307         vec3_t origin;
308         vec3_t angles;
309         int number; // entity number this state is for
310         unsigned short active; // true if a valid state
311         unsigned short modelindex;
312         unsigned short frame;
313         unsigned short effects;
314         qbyte colormap;
315         qbyte skin;
316         qbyte alpha;
317         qbyte scale;
318         qbyte glowsize;
319         qbyte glowcolor;
320         qbyte flags;
321 }
322 entity_state_t;
323
324 typedef struct
325 {
326         double time;
327         int framenum;
328         int firstentity; // index into entitydata, modulo MAX_ENTITY_DATABASE
329         int endentity; // index into entitydata, firstentity + numentities
330 }
331 entity_frameinfo_t;
332
333 #define MAX_ENTITY_HISTORY 64
334 #define MAX_ENTITY_DATABASE 4096
335
336 typedef struct
337 {
338         // note: these can be far out of range, modulo with MAX_ENTITY_DATABASE to get a valid range (which may wrap)
339         // start and end of used area, when adding a new update to database, store at endpos, and increment endpos
340         // when removing updates from database, nudge down frames array to only contain useful frames
341         // this logic should explain better:
342         // if (numframes >= MAX_ENTITY_HISTORY || (frames[numframes - 1].endentity - frames[0].firstentity) + entitiestoadd > MAX_ENTITY_DATABASE)
343         //     flushdatabase();
344         // note: if numframes == 0, insert at start (0 in entitydata)
345         // the only reason this system is used is to avoid copying memory when frames are removed
346         int numframes;
347         int ackframe; // server only: last acknowledged frame
348         vec3_t eye;
349         entity_frameinfo_t frames[MAX_ENTITY_HISTORY];
350         entity_state_t entitydata[MAX_ENTITY_DATABASE];
351 }
352 entity_database_t;
353
354 // build entity data in this, to pass to entity read/write functions
355 typedef struct
356 {
357         double time;
358         int framenum;
359         int numentities;
360         vec3_t eye;
361         entity_state_t entitydata[MAX_ENTITY_DATABASE];
362 }
363 entity_frame_t;
364
365 // LordHavoc: these are in approximately sorted order, according to cost and
366 // likelyhood of being used for numerous objects in a frame
367
368 // note that the bytes are not written/read in this order, this is only the
369 // order of the bits to minimize overhead from extend bytes
370
371 // enough to describe a nail, gib, shell casing, bullet hole, or rocket
372 #define E_ORIGIN1               (1<<0)
373 #define E_ORIGIN2               (1<<1)
374 #define E_ORIGIN3               (1<<2)
375 #define E_ANGLE1                (1<<3)
376 #define E_ANGLE2                (1<<4)
377 #define E_ANGLE3                (1<<5)
378 #define E_MODEL1                (1<<6)
379 #define E_EXTEND1               (1<<7)
380
381 // enough to describe almost anything
382 #define E_FRAME1                (1<<8)
383 #define E_EFFECTS1              (1<<9)
384 #define E_ALPHA                 (1<<10)
385 #define E_SCALE                 (1<<11)
386 #define E_COLORMAP              (1<<12)
387 #define E_SKIN                  (1<<13)
388 #define E_FLAGS                 (1<<14)
389 #define E_EXTEND2               (1<<15)
390
391 // players, custom color glows, high model numbers
392 #define E_FRAME2                (1<<16)
393 #define E_MODEL2                (1<<17)
394 #define E_EFFECTS2              (1<<18)
395 #define E_GLOWSIZE              (1<<19)
396 #define E_GLOWCOLOR             (1<<20)
397 #define E_UNUSED1               (1<<21)
398 #define E_UNUSED2               (1<<22)
399 #define E_EXTEND3               (1<<23)
400
401 #define E_SOUND1                (1<<24)
402 #define E_SOUNDVOL              (1<<25)
403 #define E_SOUNDATTEN    (1<<26)
404 #define E_UNUSED4               (1<<27)
405 #define E_UNUSED5               (1<<28)
406 #define E_UNUSED6               (1<<29)
407 #define E_UNUSED7               (1<<30)
408 #define E_EXTEND4               (1<<31)
409
410 void ClearStateToDefault(entity_state_t *s);
411 // (server) clears the database to contain no frames (thus delta compression
412 // compresses against nothing)
413 void EntityFrame_ClearDatabase(entity_database_t *d);
414 // (server and client) removes frames older than 'frame' from database
415 void EntityFrame_AckFrame(entity_database_t *d, int frame);
416 // (server) clears frame, to prepare for adding entities
417 void EntityFrame_Clear(entity_frame_t *f, vec3_t eye);
418 // (server) allocates an entity slot in frame, returns NULL if full
419 entity_state_t *EntityFrame_NewEntity(entity_frame_t *f, int number);
420 // (server and client) reads a frame from the database
421 void EntityFrame_FetchFrame(entity_database_t *d, int framenum, entity_frame_t *f);
422 // (server and client) adds a entity_frame to the database, for future
423 // reference
424 void EntityFrame_AddFrame(entity_database_t *d, entity_frame_t *f);
425 // (server) writes a frame to network stream
426 void EntityFrame_Write(entity_database_t *d, entity_frame_t *f, sizebuf_t *msg);
427 // (client) reads a frame from network stream
428 void EntityFrame_Read(entity_database_t *d);
429 // (client) returns the frame number of the most recent frame recieved
430 int EntityFrame_MostRecentlyRecievedFrameNum(entity_database_t *d);
431
432 #endif
433