2 Copyright (C) 1996-1997 Id Software, Inc.
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.
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.
13 See the GNU General Public License for more details.
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.
20 // protocol.h -- communications protocols
22 #define PROTOCOL_VERSION 15
23 #define DPPROTOCOL_VERSION1 96
24 #define DPPROTOCOL_VERSION2 97
27 #define EF_ROCKET 1 // leave a trail
28 #define EF_GRENADE 2 // leave a trail
29 #define EF_GIB 4 // leave a trail
30 #define EF_ROTATE 8 // rotate (bonus items)
31 #define EF_TRACER 16 // green split trail
32 #define EF_ZOMGIB 32 // small blood trail
33 #define EF_TRACER2 64 // orange split trail + rotate
34 #define EF_TRACER3 128 // purple trail
36 #define EF_BRIGHTFIELD 1
37 #define EF_MUZZLEFLASH 2
38 #define EF_BRIGHTLIGHT 4
41 #define EF_ADDITIVE 32
44 #define EF_DELTA 8388608 // LordHavoc: entity is delta compressed to save network bandwidth
45 // effects/model (can be used as model flags or entity effects)
46 #define EF_REFLECTIVE 256 // LordHavoc: shiny metal objects :)
47 #define EF_FULLBRIGHT 512 // LordHavoc: fullbright
48 #define EF_FLAME 1024 // LordHavoc: on fire
50 #define EF_STEP 0x80000000 // internal client use only - present on MOVETYPE_STEP entities, not QC accessible (too many bits)
52 // if the high bit of the servercmd is set, the low bits are fast update flags:
53 #define U_MOREBITS (1<<0)
54 #define U_ORIGIN1 (1<<1)
55 #define U_ORIGIN2 (1<<2)
56 #define U_ORIGIN3 (1<<3)
57 #define U_ANGLE2 (1<<4)
58 // LordHavoc: U_NOLERP was only ever used for monsters, so I renamed it U_STEP
60 #define U_FRAME (1<<6)
61 // just differentiates from other updates
62 #define U_SIGNAL (1<<7)
64 #define U_ANGLE1 (1<<8)
65 #define U_ANGLE3 (1<<9)
66 #define U_MODEL (1<<10)
67 #define U_COLORMAP (1<<11)
68 #define U_SKIN (1<<12)
69 #define U_EFFECTS (1<<13)
70 #define U_LONGENTITY (1<<14)
72 // LordHavoc: protocol extension
73 #define U_EXTEND1 (1<<15)
74 // LordHavoc: first extend byte
75 #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)
76 #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)
77 #define U_SCALE (1<<18) // 1 byte, scale / 16 positive, not sent if 1.0
78 #define U_EFFECTS2 (1<<19) // 1 byte, this is .effects & 0xFF00 (second byte)
79 #define U_GLOWSIZE (1<<20) // 1 byte, encoding is float/8.0, signed (negative is darklight), not sent if 0
80 #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)
81 // LordHavoc: colormod feature has been removed, because no one used it
82 #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...
83 #define U_EXTEND2 (1<<23) // another byte to follow
84 // LordHavoc: second extend byte
85 #define U_GLOWTRAIL (1<<24) // leaves a trail of particles (of color .glowcolor, or black if it is a negative glowsize)
86 #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
87 #define U_FRAME2 (1<<26) // 1 byte, this is .frame & 0xFF00 (second byte)
88 #define U_MODEL2 (1<<27) // 1 byte, this is .modelindex & 0xFF00 (second byte)
89 #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)
90 #define U_UNUSED29 (1<<29) // future expansion
91 #define U_UNUSED30 (1<<30) // future expansion
92 #define U_EXTEND3 (1<<31) // another byte to follow, future expansion
94 #define SU_VIEWHEIGHT (1<<0)
95 #define SU_IDEALPITCH (1<<1)
96 #define SU_PUNCH1 (1<<2)
97 #define SU_PUNCH2 (1<<3)
98 #define SU_PUNCH3 (1<<4)
99 #define SU_VELOCITY1 (1<<5)
100 #define SU_VELOCITY2 (1<<6)
101 #define SU_VELOCITY3 (1<<7)
102 //define SU_AIMENT (1<<8) AVAILABLE BIT
103 #define SU_ITEMS (1<<9)
104 #define SU_ONGROUND (1<<10) // no data follows, the bit is it
105 #define SU_INWATER (1<<11) // no data follows, the bit is it
106 #define SU_WEAPONFRAME (1<<12)
107 #define SU_ARMOR (1<<13)
108 #define SU_WEAPON (1<<14)
109 #define SU_EXTEND1 (1<<15)
111 #define SU_PUNCHVEC1 (1<<16)
112 #define SU_PUNCHVEC2 (1<<17)
113 #define SU_PUNCHVEC3 (1<<18)
114 #define SU_VIEWZOOM (1<<19) // byte factor (0 = 0.0 (not valid), 255 = 1.0)
115 #define SU_UNUSED20 (1<<20)
116 #define SU_UNUSED21 (1<<21)
117 #define SU_UNUSED22 (1<<22)
118 #define SU_EXTEND2 (1<<23) // another byte to follow, future expansion
119 // second extend byte
120 #define SU_UNUSED24 (1<<24)
121 #define SU_UNUSED25 (1<<25)
122 #define SU_UNUSED26 (1<<26)
123 #define SU_UNUSED27 (1<<27)
124 #define SU_UNUSED28 (1<<28)
125 #define SU_UNUSED29 (1<<29)
126 #define SU_UNUSED30 (1<<30)
127 #define SU_EXTEND3 (1<<31) // another byte to follow, future expansion
129 // a sound with no channel is a local only sound
130 #define SND_VOLUME (1<<0) // a byte
131 #define SND_ATTENUATION (1<<1) // a byte
132 #define SND_LOOPING (1<<2) // a long
135 // defaults for clientinfo messages
136 #define DEFAULT_VIEWHEIGHT 22
139 // game types sent by serverinfo
140 // these determine which intermission screen plays
142 #define GAME_DEATHMATCH 1
145 // note that there are some defs.qc that mirror to these numbers
146 // also related to svc_strings[] in cl_parse
154 #define svc_disconnect 2
155 #define svc_updatestat 3 // [byte] [long]
156 #define svc_version 4 // [long] server version
157 #define svc_setview 5 // [short] entity number
158 #define svc_sound 6 // <see code>
159 #define svc_time 7 // [float] server time
160 #define svc_print 8 // [string] null terminated string
161 #define svc_stufftext 9 // [string] stuffed into client's console buffer
162 // the string should be \n terminated
163 #define svc_setangle 10 // [angle3] set the view angle to this absolute value
165 #define svc_serverinfo 11 // [long] version
166 // [string] signon string
167 // [string]..[0]model cache
168 // [string]...[0]sounds cache
169 #define svc_lightstyle 12 // [byte] [string]
170 #define svc_updatename 13 // [byte] [string]
171 #define svc_updatefrags 14 // [byte] [short]
172 #define svc_clientdata 15 // <shortbits + data>
173 #define svc_stopsound 16 // <see code>
174 #define svc_updatecolors 17 // [byte] [byte]
175 #define svc_particle 18 // [vec3] <variable>
176 #define svc_damage 19
178 #define svc_spawnstatic 20
179 // svc_spawnbinary 21
180 #define svc_spawnbaseline 22
182 #define svc_temp_entity 23
184 #define svc_setpause 24 // [byte] on / off
185 #define svc_signonnum 25 // [byte] used for the signon sequence
187 #define svc_centerprint 26 // [string] to put in center of the screen
189 #define svc_killedmonster 27
190 #define svc_foundsecret 28
192 #define svc_spawnstaticsound 29 // [coord3] [byte] samp [byte] vol [byte] aten
194 #define svc_intermission 30 // [string] music
195 #define svc_finale 31 // [string] music [string] text
197 #define svc_cdtrack 32 // [byte] track [byte] looptrack
198 #define svc_sellscreen 33
200 #define svc_cutscene 34
202 #define svc_showlmp 35 // [string] slotname [string] lmpfilename [short] x [short] y
203 #define svc_hidelmp 36 // [string] slotname
204 #define svc_skybox 37 // [string] skyname
206 // LordHavoc: my svc_ range, 50-59
207 #define svc_cgame 50 // [short] length [bytes] data
208 #define svc_fog 51 // unfinished and obsolete
209 #define svc_effect 52 // [vector] org [byte] modelindex [byte] startframe [byte] framecount [byte] framerate
210 #define svc_effect2 53 // [vector] org [short] modelindex [short] startframe [byte] framecount [byte] framerate
211 #define svc_sound2 54 // short soundindex instead of byte
212 #define svc_spawnbaseline2 55 // short modelindex instead of byte
213 #define svc_spawnstatic2 56 // short modelindex instead of byte
214 #define svc_entities 57 // [int] deltaframe [int] thisframe [float vector] eye [variable length] entitydata
215 #define svc_unusedlh3 58
216 #define svc_spawnstaticsound2 59 // [coord3] [short] samp [byte] vol [byte] aten
223 #define clc_disconnect 2
224 #define clc_move 3 // [usercmd_t]
225 #define clc_stringcmd 4 // [string] message
227 // LordHavoc: my clc_ range, 50-59
228 #define clc_ackentities 50 // [int] framenumber
229 #define clc_unusedlh1 51
230 #define clc_unusedlh2 52
231 #define clc_unusedlh3 53
232 #define clc_unusedlh4 54
233 #define clc_unusedlh5 55
234 #define clc_unusedlh6 56
235 #define clc_unusedlh7 57
236 #define clc_unusedlh8 58
237 #define clc_unusedlh9 59
240 // temp entity events
242 #define TE_SPIKE 0 // [vector] origin
243 #define TE_SUPERSPIKE 1 // [vector] origin
244 #define TE_GUNSHOT 2 // [vector] origin
245 #define TE_EXPLOSION 3 // [vector] origin
246 #define TE_TAREXPLOSION 4 // [vector] origin
247 #define TE_LIGHTNING1 5 // [entity] entity [vector] start [vector] end
248 #define TE_LIGHTNING2 6 // [entity] entity [vector] start [vector] end
249 #define TE_WIZSPIKE 7 // [vector] origin
250 #define TE_KNIGHTSPIKE 8 // [vector] origin
251 #define TE_LIGHTNING3 9 // [entity] entity [vector] start [vector] end
252 #define TE_LAVASPLASH 10 // [vector] origin
253 #define TE_TELEPORT 11 // [vector] origin
254 #define TE_EXPLOSION2 12 // [vector] origin [byte] startcolor [byte] colorcount
257 #define TE_BEAM 13 // [entity] entity [vector] start [vector] end
260 // Nehahra effects used in the movie (TE_EXPLOSION3 also got written up in a QSG tutorial, hence it's not marked NEH)
261 #define TE_EXPLOSION3 16 // [vector] origin [coord] red [coord] green [coord] blue
262 #define TE_LIGHTNING4NEH 17 // [string] model [entity] entity [vector] start [vector] end
264 // LordHavoc: added some TE_ codes (block1 - 50-60)
265 #define TE_BLOOD 50 // [vector] origin [byte] xvel [byte] yvel [byte] zvel [byte] count
266 #define TE_SPARK 51 // [vector] origin [byte] xvel [byte] yvel [byte] zvel [byte] count
267 #define TE_BLOODSHOWER 52 // [vector] min [vector] max [coord] explosionspeed [short] count
268 #define TE_EXPLOSIONRGB 53 // [vector] origin [byte] red [byte] green [byte] blue
269 #define TE_PARTICLECUBE 54 // [vector] min [vector] max [vector] dir [short] count [byte] color [byte] gravity [coord] randomvel
270 #define TE_PARTICLERAIN 55 // [vector] min [vector] max [vector] dir [short] count [byte] color
271 #define TE_PARTICLESNOW 56 // [vector] min [vector] max [vector] dir [short] count [byte] color
272 #define TE_GUNSHOTQUAD 57 // [vector] origin
273 #define TE_SPIKEQUAD 58 // [vector] origin
274 #define TE_SUPERSPIKEQUAD 59 // [vector] origin
275 // LordHavoc: block2 - 70-80
276 #define TE_EXPLOSIONQUAD 70 // [vector] origin
277 #define TE_BLOOD2 71 // [vector] origin
278 #define TE_SMALLFLASH 72 // [vector] origin
279 #define TE_CUSTOMFLASH 73 // [vector] origin [byte] radius / 8 - 1 [byte] lifetime / 256 - 1 [byte] red [byte] green [byte] blue
280 #define TE_FLAMEJET 74 // [vector] origin [vector] velocity [byte] count
281 #define TE_PLASMABURN 75 // [vector] origin
283 // these are bits for the 'flags' field of the entity_state_t
284 #define RENDER_STEP 1
285 #define RENDER_GLOWTRAIL 2
286 #define RENDER_VIEWMODEL 4
287 #define RENDER_EXTERIORMODEL 8
291 double time; // time this state was built
294 int number; // entity number this state is for
295 unsigned short active; // true if a valid state
296 unsigned short modelindex;
297 unsigned short frame;
298 unsigned short effects;
313 int firstentity; // index into entitydata, modulo MAX_ENTITY_DATABASE
314 int endentity; // index into entitydata, firstentity + numentities
318 #define MAX_ENTITY_HISTORY 64
319 #define MAX_ENTITY_DATABASE 4096
323 // note: these can be far out of range, modulo with MAX_ENTITY_DATABASE to get a valid range (which may wrap)
324 // start and end of used area, when adding a new update to database, store at endpos, and increment endpos
325 // when removing updates from database, nudge down frames array to only contain useful frames
326 // this logic should explain better:
327 // if (numframes >= MAX_ENTITY_HISTORY || (frames[numframes - 1].endentity - frames[0].firstentity) + entitiestoadd > MAX_ENTITY_DATABASE)
329 // note: if numframes == 0, insert at start (0 in entitydata)
330 // the only reason this system is used is to avoid copying memory when frames are removed
332 int ackframe; // server only: last acknowledged frame
334 entity_frameinfo_t frames[MAX_ENTITY_HISTORY];
335 entity_state_t entitydata[MAX_ENTITY_DATABASE];
339 // build entity data in this, to pass to entity read/write functions
346 entity_state_t entitydata[MAX_ENTITY_DATABASE];
350 // LordHavoc: these are in approximately sorted order, according to cost and
351 // likelyhood of being used for numerous objects in a frame
353 // note that the bytes are not written/read in this order, this is only the
354 // order of the bits to minimize overhead from extend bytes
356 // enough to describe a nail, gib, shell casing, bullet hole, or rocket
357 #define E_ORIGIN1 (1<<0)
358 #define E_ORIGIN2 (1<<1)
359 #define E_ORIGIN3 (1<<2)
360 #define E_ANGLE1 (1<<3)
361 #define E_ANGLE2 (1<<4)
362 #define E_ANGLE3 (1<<5)
363 #define E_MODEL1 (1<<6)
364 #define E_EXTEND1 (1<<7)
366 // enough to describe almost anything
367 #define E_FRAME1 (1<<8)
368 #define E_EFFECTS1 (1<<9)
369 #define E_ALPHA (1<<10)
370 #define E_SCALE (1<<11)
371 #define E_COLORMAP (1<<12)
372 #define E_SKIN (1<<13)
373 #define E_FLAGS (1<<14)
374 #define E_EXTEND2 (1<<15)
376 // players, custom color glows, high model numbers
377 #define E_FRAME2 (1<<16)
378 #define E_MODEL2 (1<<17)
379 #define E_EFFECTS2 (1<<18)
380 #define E_GLOWSIZE (1<<19)
381 #define E_GLOWCOLOR (1<<20)
382 #define E_UNUSED1 (1<<21)
383 #define E_UNUSED2 (1<<22)
384 #define E_EXTEND3 (1<<23)
386 #define E_SOUND1 (1<<24)
387 #define E_SOUNDVOL (1<<25)
388 #define E_SOUNDATTEN (1<<26)
389 #define E_UNUSED4 (1<<27)
390 #define E_UNUSED5 (1<<28)
391 #define E_UNUSED6 (1<<29)
392 #define E_UNUSED7 (1<<30)
393 #define E_EXTEND4 (1<<31)
395 void ClearStateToDefault(entity_state_t *s);
396 // (server) clears the database to contain no frames (thus delta compression
397 // compresses against nothing)
398 void EntityFrame_ClearDatabase(entity_database_t *d);
399 // (server and client) removes frames older than 'frame' from database
400 void EntityFrame_AckFrame(entity_database_t *d, int frame);
401 // (server) clears frame, to prepare for adding entities
402 void EntityFrame_Clear(entity_frame_t *f, vec3_t eye);
403 // (server) allocates an entity slot in frame, returns NULL if full
404 entity_state_t *EntityFrame_NewEntity(entity_frame_t *f, int number);
405 // (server and client) reads a frame from the database
406 void EntityFrame_FetchFrame(entity_database_t *d, int framenum, entity_frame_t *f);
407 // (server and client) adds a entity_frame to the database, for future
409 void EntityFrame_AddFrame(entity_database_t *d, entity_frame_t *f);
410 // (server) writes a frame to network stream
411 void EntityFrame_Write(entity_database_t *d, entity_frame_t *f, sizebuf_t *msg);
412 // (client) reads a frame from network stream
413 void EntityFrame_Read(entity_database_t *d);
414 // (client) reads (and interpolates) the eye location from the database,
415 // given a current time
416 //int EntityFrame_FetchEye(entity_database_t *d, vec3_t eye, double time);
417 // (client) fetchs an entity from the frame by index into the entity list
418 //int EntityFrame_FetchEntityByIndex(entity_frame_t *f, entity_state_t *e, int index);
419 // (client) fetchs an entity from the frame by entity number
420 //int EntityFrame_FetchEntityByNumber(entity_frame_t *f, entity_state_t *e, int number);
421 // (client) returns the frame number of the most recent frame recieved
422 int EntityFrame_MostRecentlyRecievedFrameNum(entity_database_t *d);