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
25 // protocolversion_t is defined in common.h
27 protocolversion_t Protocol_EnumForName(const char *s);
28 const char *Protocol_NameForEnum(protocolversion_t p);
29 protocolversion_t Protocol_EnumForNumber(int n);
30 int Protocol_NumberForEnum(protocolversion_t p);
31 void Protocol_Names(char *buffer, size_t buffersize);
34 #define EF_ROCKET 1 // leave a trail
35 #define EF_GRENADE 2 // leave a trail
36 #define EF_GIB 4 // leave a trail
37 #define EF_ROTATE 8 // rotate (bonus items)
38 #define EF_TRACER 16 // green split trail
39 #define EF_ZOMGIB 32 // small blood trail
40 #define EF_TRACER2 64 // orange split trail + rotate
41 #define EF_TRACER3 128 // purple trail
43 #define EF_BRIGHTFIELD 1
44 #define EF_MUZZLEFLASH 2
45 #define EF_BRIGHTLIGHT 4
48 #define EF_ADDITIVE 32
51 #define EF_DELTA 8388608 // LordHavoc: (obsolete) entity is delta compressed to save network bandwidth (no longer used)
52 #define EF_LOWPRECISION 4194304 // LordHavoc: entity is low precision (integer coordinates) to save network bandwidth
53 // effects/model (can be used as model flags or entity effects)
54 #define EF_REFLECTIVE 256 // LordHavoc: shiny metal objects :) (not currently supported)
55 #define EF_FULLBRIGHT 512 // LordHavoc: fullbright
56 #define EF_FLAME 1024 // LordHavoc: on fire
57 #define EF_STARDUST 2048 // LordHavoc: showering sparks
58 #define EF_NOSHADOW 4096 // LordHavoc: does not cast a shadow
59 #define EF_NODEPTHTEST 8192 // LordHavoc: shows through walls
60 #define EF_SELECTABLE 16384 // LordHavoc: highlights when PRYDON_CLIENTCURSOR mouse is over it
61 #define EF_DOUBLESIDED 32768 //[515]: disable cull face for this entity
63 #define EF_FLAG1QW 16777216 // internal client use only
64 #define EF_FLAG2QW 33554432 // internal client use only
65 #define EF_STEP 0x80000000 // internal client use only - present on MOVETYPE_STEP entities, not QC accessible (too many bits)
67 // flags for the pflags field of entities
68 #define PFLAGS_NOSHADOW 1
69 #define PFLAGS_CORONA 2
70 #define PFLAGS_FULLDYNAMIC 128 // must be set or the light fields are ignored
72 // if the high bit of the servercmd is set, the low bits are fast update flags:
73 #define U_MOREBITS (1<<0)
74 #define U_ORIGIN1 (1<<1)
75 #define U_ORIGIN2 (1<<2)
76 #define U_ORIGIN3 (1<<3)
77 #define U_ANGLE2 (1<<4)
78 // LordHavoc: U_NOLERP was only ever used for monsters, so I renamed it U_STEP
80 #define U_FRAME (1<<6)
81 // just differentiates from other updates
82 #define U_SIGNAL (1<<7)
84 #define U_ANGLE1 (1<<8)
85 #define U_ANGLE3 (1<<9)
86 #define U_MODEL (1<<10)
87 #define U_COLORMAP (1<<11)
88 #define U_SKIN (1<<12)
89 #define U_EFFECTS (1<<13)
90 #define U_LONGENTITY (1<<14)
92 // LordHavoc: protocol extension
93 #define U_EXTEND1 (1<<15)
94 // LordHavoc: first extend byte
95 #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)
96 #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)
97 #define U_SCALE (1<<18) // 1 byte, scale / 16 positive, not sent if 1.0
98 #define U_EFFECTS2 (1<<19) // 1 byte, this is .effects & 0xFF00 (second byte)
99 #define U_GLOWSIZE (1<<20) // 1 byte, encoding is float/4.0, unsigned, not sent if 0
100 #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)
101 #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...
102 #define U_EXTEND2 (1<<23) // another byte to follow
103 // LordHavoc: second extend byte
104 #define U_GLOWTRAIL (1<<24) // leaves a trail of particles (of color .glowcolor, or black if it is a negative glowsize)
105 #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
106 #define U_FRAME2 (1<<26) // 1 byte, this is .frame & 0xFF00 (second byte)
107 #define U_MODEL2 (1<<27) // 1 byte, this is .modelindex & 0xFF00 (second byte)
108 #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)
109 #define U_UNUSED29 (1<<29) // future expansion
110 #define U_UNUSED30 (1<<30) // future expansion
111 #define U_EXTEND3 (1<<31) // another byte to follow, future expansion
113 #define SU_VIEWHEIGHT (1<<0)
114 #define SU_IDEALPITCH (1<<1)
115 #define SU_PUNCH1 (1<<2)
116 #define SU_PUNCH2 (1<<3)
117 #define SU_PUNCH3 (1<<4)
118 #define SU_VELOCITY1 (1<<5)
119 #define SU_VELOCITY2 (1<<6)
120 #define SU_VELOCITY3 (1<<7)
121 //define SU_AIMENT (1<<8) AVAILABLE BIT
122 #define SU_ITEMS (1<<9)
123 #define SU_ONGROUND (1<<10) // no data follows, the bit is it
124 #define SU_INWATER (1<<11) // no data follows, the bit is it
125 #define SU_WEAPONFRAME (1<<12)
126 #define SU_ARMOR (1<<13)
127 #define SU_WEAPON (1<<14)
128 #define SU_EXTEND1 (1<<15)
130 #define SU_PUNCHVEC1 (1<<16)
131 #define SU_PUNCHVEC2 (1<<17)
132 #define SU_PUNCHVEC3 (1<<18)
133 #define SU_VIEWZOOM (1<<19) // byte factor (0 = 0.0 (not valid), 255 = 1.0)
134 #define SU_UNUSED20 (1<<20)
135 #define SU_UNUSED21 (1<<21)
136 #define SU_UNUSED22 (1<<22)
137 #define SU_EXTEND2 (1<<23) // another byte to follow, future expansion
138 // second extend byte
139 #define SU_UNUSED24 (1<<24)
140 #define SU_UNUSED25 (1<<25)
141 #define SU_UNUSED26 (1<<26)
142 #define SU_UNUSED27 (1<<27)
143 #define SU_UNUSED28 (1<<28)
144 #define SU_UNUSED29 (1<<29)
145 #define SU_UNUSED30 (1<<30)
146 #define SU_EXTEND3 (1<<31) // another byte to follow, future expansion
148 // a sound with no channel is a local only sound
149 #define SND_VOLUME (1<<0) // a byte
150 #define SND_ATTENUATION (1<<1) // a byte
151 #define SND_LOOPING (1<<2) // a long
152 #define SND_LARGEENTITY (1<<3) // a short and a byte (instead of a short)
153 #define SND_LARGESOUND (1<<4) // a short (instead of a byte)
156 // defaults for clientinfo messages
157 #define DEFAULT_VIEWHEIGHT 22
160 // game types sent by serverinfo
161 // these determine which intermission screen plays
163 #define GAME_DEATHMATCH 1
166 // note that there are some defs.qc that mirror to these numbers
167 // also related to svc_strings[] in cl_parse
175 #define svc_disconnect 2
176 #define svc_updatestat 3 // [byte] [long]
177 #define svc_version 4 // [long] server version
178 #define svc_setview 5 // [short] entity number
179 #define svc_sound 6 // <see code>
180 #define svc_time 7 // [float] server time
181 #define svc_print 8 // [string] null terminated string
182 #define svc_stufftext 9 // [string] stuffed into client's console buffer
183 // the string should be \n terminated
184 #define svc_setangle 10 // [angle3] set the view angle to this absolute value
186 #define svc_serverinfo 11 // [long] version
187 // [string] signon string
188 // [string]..[0]model cache
189 // [string]...[0]sounds cache
190 #define svc_lightstyle 12 // [byte] [string]
191 #define svc_updatename 13 // [byte] [string]
192 #define svc_updatefrags 14 // [byte] [short]
193 #define svc_clientdata 15 // <shortbits + data>
194 #define svc_stopsound 16 // <see code>
195 #define svc_updatecolors 17 // [byte] [byte]
196 #define svc_particle 18 // [vec3] <variable>
197 #define svc_damage 19
199 #define svc_spawnstatic 20
200 // svc_spawnbinary 21
201 #define svc_spawnbaseline 22
203 #define svc_temp_entity 23
205 #define svc_setpause 24 // [byte] on / off
206 #define svc_signonnum 25 // [byte] used for the signon sequence
208 #define svc_centerprint 26 // [string] to put in center of the screen
210 #define svc_killedmonster 27
211 #define svc_foundsecret 28
213 #define svc_spawnstaticsound 29 // [coord3] [byte] samp [byte] vol [byte] aten
215 #define svc_intermission 30 // [string] music
216 #define svc_finale 31 // [string] music [string] text
218 #define svc_cdtrack 32 // [byte] track [byte] looptrack
219 #define svc_sellscreen 33
221 #define svc_cutscene 34
223 #define svc_showlmp 35 // [string] slotname [string] lmpfilename [short] x [short] y
224 #define svc_hidelmp 36 // [string] slotname
225 #define svc_skybox 37 // [string] skyname
227 // LordHavoc: my svc_ range, 50-59
228 #define svc_unusedlh1 50 //
229 #define svc_updatestatubyte 51 // [byte] stat [byte] value
230 #define svc_effect 52 // [vector] org [byte] modelindex [byte] startframe [byte] framecount [byte] framerate
231 #define svc_effect2 53 // [vector] org [short] modelindex [short] startframe [byte] framecount [byte] framerate
232 #define svc_sound2 54 // (obsolete in DP6 and later) short soundindex instead of byte
233 #define svc_precache 54 // [short] precacheindex [string] filename, precacheindex is + 0 for modelindex and +32768 for soundindex
234 #define svc_spawnbaseline2 55 // short modelindex instead of byte
235 #define svc_spawnstatic2 56 // short modelindex instead of byte
236 #define svc_entities 57 // [int] deltaframe [int] thisframe [float vector] eye [variable length] entitydata
237 #define svc_csqcentities 58 // [short] entnum [variable length] entitydata ... [short] 0x0000
238 #define svc_spawnstaticsound2 59 // [coord3] [short] samp [byte] vol [byte] aten
245 #define clc_disconnect 2
246 #define clc_move 3 // [usercmd_t]
247 #define clc_stringcmd 4 // [string] message
249 // LordHavoc: my clc_ range, 50-59
250 #define clc_ackframe 50 // [int] framenumber
251 #define clc_unusedlh1 51
252 #define clc_unusedlh2 52
253 #define clc_unusedlh3 53
254 #define clc_unusedlh4 54
255 #define clc_unusedlh5 55
256 #define clc_unusedlh6 56
257 #define clc_unusedlh7 57
258 #define clc_unusedlh8 58
259 #define clc_unusedlh9 59
262 // temp entity events
264 #define TE_SPIKE 0 // [vector] origin
265 #define TE_SUPERSPIKE 1 // [vector] origin
266 #define TE_GUNSHOT 2 // [vector] origin
267 #define TE_EXPLOSION 3 // [vector] origin
268 #define TE_TAREXPLOSION 4 // [vector] origin
269 #define TE_LIGHTNING1 5 // [entity] entity [vector] start [vector] end
270 #define TE_LIGHTNING2 6 // [entity] entity [vector] start [vector] end
271 #define TE_WIZSPIKE 7 // [vector] origin
272 #define TE_KNIGHTSPIKE 8 // [vector] origin
273 #define TE_LIGHTNING3 9 // [entity] entity [vector] start [vector] end
274 #define TE_LAVASPLASH 10 // [vector] origin
275 #define TE_TELEPORT 11 // [vector] origin
276 #define TE_EXPLOSION2 12 // [vector] origin [byte] startcolor [byte] colorcount
279 #define TE_BEAM 13 // [entity] entity [vector] start [vector] end
282 // Nehahra effects used in the movie (TE_EXPLOSION3 also got written up in a QSG tutorial, hence it's not marked NEH)
283 #define TE_EXPLOSION3 16 // [vector] origin [coord] red [coord] green [coord] blue
284 #define TE_LIGHTNING4NEH 17 // [string] model [entity] entity [vector] start [vector] end
286 // LordHavoc: added some TE_ codes (block1 - 50-60)
287 #define TE_BLOOD 50 // [vector] origin [byte] xvel [byte] yvel [byte] zvel [byte] count
288 #define TE_SPARK 51 // [vector] origin [byte] xvel [byte] yvel [byte] zvel [byte] count
289 #define TE_BLOODSHOWER 52 // [vector] min [vector] max [coord] explosionspeed [short] count
290 #define TE_EXPLOSIONRGB 53 // [vector] origin [byte] red [byte] green [byte] blue
291 #define TE_PARTICLECUBE 54 // [vector] min [vector] max [vector] dir [short] count [byte] color [byte] gravity [coord] randomvel
292 #define TE_PARTICLERAIN 55 // [vector] min [vector] max [vector] dir [short] count [byte] color
293 #define TE_PARTICLESNOW 56 // [vector] min [vector] max [vector] dir [short] count [byte] color
294 #define TE_GUNSHOTQUAD 57 // [vector] origin
295 #define TE_SPIKEQUAD 58 // [vector] origin
296 #define TE_SUPERSPIKEQUAD 59 // [vector] origin
297 // LordHavoc: block2 - 70-80
298 #define TE_EXPLOSIONQUAD 70 // [vector] origin
299 #define TE_UNUSED1 71 // unused
300 #define TE_SMALLFLASH 72 // [vector] origin
301 #define TE_CUSTOMFLASH 73 // [vector] origin [byte] radius / 8 - 1 [byte] lifetime / 256 - 1 [byte] red [byte] green [byte] blue
302 #define TE_FLAMEJET 74 // [vector] origin [vector] velocity [byte] count
303 #define TE_PLASMABURN 75 // [vector] origin
304 // LordHavoc: Tei grabbed these codes
305 #define TE_TEI_G3 76 // [vector] start [vector] end [vector] angles
306 #define TE_TEI_SMOKE 77 // [vector] origin [vector] dir [byte] count
307 #define TE_TEI_BIGEXPLOSION 78 // [vector] origin
308 #define TE_TEI_PLASMAHIT 79 // [vector} origin [vector] dir [byte] count
311 // these are bits for the 'flags' field of the entity_state_t
312 #define RENDER_STEP 1
313 #define RENDER_GLOWTRAIL 2
314 #define RENDER_VIEWMODEL 4
315 #define RENDER_EXTERIORMODEL 8
316 #define RENDER_LOWPRECISION 16 // send as low precision coordinates to save bandwidth
317 #define RENDER_COLORMAPPED 32
318 #define RENDER_SHADOW 65536 // cast shadow
319 #define RENDER_LIGHT 131072 // receive light
320 #define RENDER_TRANSPARENT 262144 // can't light during opaque stage
321 #define RENDER_NOCULLFACE 524288 // render as double sided (disable GL_CULL_FACE)
324 typedef struct entity_state_s
326 // ! means this is not sent to client
327 double time; // ! time this state was built (used on client for interpolation)
330 int number; // entity number this state is for
332 unsigned int customizeentityforclient; // !
333 unsigned short modelindex;
334 unsigned short frame;
335 unsigned short tagentity;
336 unsigned short specialvisibilityradius; // ! larger if it has effects/light
337 unsigned short viewmodelforclient; // !
338 unsigned short exteriormodelforclient; // ! not shown if first person viewing from this entity, shown in all other cases
339 unsigned short nodrawtoclient; // !
340 unsigned short drawonlytoclient; // !
341 unsigned short light[4]; // color*256 (0.00 to 255.996), and radius*1
342 unsigned char active; // true if a valid state
343 unsigned char lightstyle;
344 unsigned char lightpflags;
345 unsigned char colormap;
346 unsigned char skin; // also chooses cubemap for rtlights if lightpflags & LIGHTPFLAGS_FULLDYNAMIC
349 unsigned char glowsize;
350 unsigned char glowcolor;
352 unsigned char tagindex;
353 unsigned char colormod[3];
354 // padding to a multiple of 8 bytes (to align the double time)
355 unsigned char unused[6];
359 // baseline state values
360 extern entity_state_t defaultstate;
361 // reads a quake entity from the network stream
362 void EntityFrameQuake_ReadEntity(int bits);
363 // writes a list of quake entities to the network stream
364 // (or as many will fit)
365 void EntityFrameQuake_WriteFrame(sizebuf_t *msg, int numstates, const entity_state_t *states);
366 // cleans up dead entities each frame after ReadEntity (which doesn't clear unused entities)
367 void EntityFrameQuake_ISeeDeadEntities(void);
371 server updates entities according to some (unmentioned) scheme.
373 a frame consists of all visible entities, some of which are up to date,
374 often some are not up to date.
376 these entities are stored in a range (firstentity/endentity) of structs in the
379 to make a commit the server performs these steps:
380 1. duplicate oldest frame in database (this is the baseline) as new frame, and
381 write frame numbers (oldest frame's number, new frame's number) and eye
382 location to network packet (eye location is obsolete and will be removed in
384 2. write an entity change to packet and modify new frame accordingly
385 (this repeats until packet is sufficiently full or new frame is complete)
386 3. write terminator (0xFFFF) to network packet
387 (FIXME: this terminator value conflicts with MAX_EDICTS 32768...)
389 to read a commit the client performs these steps:
390 1. reads frame numbers from packet and duplicates baseline frame as new frame,
391 also reads eye location but does nothing with it (obsolete).
392 2. delete frames older than the baseline which was used
393 3. read entity changes from packet until terminator (0xFFFF) is encountered,
394 each change is applied to entity frame.
395 4. sends ack framenumber to server as part of input packet
397 if server receives ack message in put packet it performs these steps:
398 1. remove all older frames from database.
403 a frame consists of some visible entities in a range (this is stored as start and end, note that end may be less than start if it wrapped).
405 these entities are stored in a range (firstentity/endentity) of structs in the entitydata[] buffer.
407 to make a commit the server performs these steps:
408 1. build an entity_frame_t using appropriate functions, containing (some of) the visible entities, this is passed to the Write function to send it.
410 This documention is unfinished!
411 the Write function performs these steps:
412 1. check if entity frame is larger than MAX_ENTITYFRAME or is larger than available space in database, if so the baseline is defaults, otherwise it is the current baseline of the database.
413 2. write differences of an entity compared to selected baseline.
414 3. add entity to entity update in database.
415 4. if there are more entities to write and packet is not full, go back to step 2.
416 5. write terminator (0xFFFF) as entity number.
423 server updates entities in looping ranges, a frame consists of a range of visible entities (not always all visible entities),
426 typedef struct entity_frameinfo_s
430 int firstentity; // index into entitydata, modulo MAX_ENTITY_DATABASE
431 int endentity; // index into entitydata, firstentity + numentities
435 #define MAX_ENTITY_HISTORY 64
436 #define MAX_ENTITY_DATABASE (MAX_EDICTS * 2)
438 typedef struct entityframe_database_s
440 // note: these can be far out of range, modulo with MAX_ENTITY_DATABASE to get a valid range (which may wrap)
441 // start and end of used area, when adding a new update to database, store at endpos, and increment endpos
442 // when removing updates from database, nudge down frames array to only contain useful frames
443 // this logic should explain better:
444 // if (numframes >= MAX_ENTITY_HISTORY || (frames[numframes - 1].endentity - frames[0].firstentity) + entitiestoadd > MAX_ENTITY_DATABASE)
446 // note: if numframes == 0, insert at start (0 in entitydata)
447 // the only reason this system is used is to avoid copying memory when frames are removed
449 // server only: last sent frame
451 // server only: last acknowledged frame
453 // the current state in the database
455 // table of entities in the entityhistorydata
456 entity_frameinfo_t frames[MAX_ENTITY_HISTORY];
458 entity_state_t entitydata[MAX_ENTITY_DATABASE];
460 entityframe_database_t;
462 // build entity data in this, to pass to entity read/write functions
463 typedef struct entity_frame_s
471 entity_state_t entitydata[MAX_ENTITY_DATABASE];
475 // LordHavoc: these are in approximately sorted order, according to cost and
476 // likelyhood of being used for numerous objects in a frame
478 // note that the bytes are not written/read in this order, this is only the
479 // order of the bits to minimize overhead from extend bytes
481 // enough to describe a nail, gib, shell casing, bullet hole, or rocket
482 #define E_ORIGIN1 (1<<0)
483 #define E_ORIGIN2 (1<<1)
484 #define E_ORIGIN3 (1<<2)
485 #define E_ANGLE1 (1<<3)
486 #define E_ANGLE2 (1<<4)
487 #define E_ANGLE3 (1<<5)
488 #define E_MODEL1 (1<<6)
489 #define E_EXTEND1 (1<<7)
491 // enough to describe almost anything
492 #define E_FRAME1 (1<<8)
493 #define E_EFFECTS1 (1<<9)
494 #define E_ALPHA (1<<10)
495 #define E_SCALE (1<<11)
496 #define E_COLORMAP (1<<12)
497 #define E_SKIN (1<<13)
498 #define E_FLAGS (1<<14)
499 #define E_EXTEND2 (1<<15)
501 // players, custom color glows, high model numbers
502 #define E_FRAME2 (1<<16)
503 #define E_MODEL2 (1<<17)
504 #define E_EFFECTS2 (1<<18)
505 #define E_GLOWSIZE (1<<19)
506 #define E_GLOWCOLOR (1<<20)
507 #define E_LIGHT (1<<21)
508 #define E_LIGHTPFLAGS (1<<22)
509 #define E_EXTEND3 (1<<23)
511 #define E_SOUND1 (1<<24)
512 #define E_SOUNDVOL (1<<25)
513 #define E_SOUNDATTEN (1<<26)
514 #define E_TAGATTACHMENT (1<<27)
515 #define E_LIGHTSTYLE (1<<28)
516 #define E_UNUSED6 (1<<29)
517 #define E_UNUSED7 (1<<30)
518 #define E_EXTEND4 (1<<31)
520 // returns difference between two states as E_ flags
521 int EntityState_DeltaBits(const entity_state_t *o, const entity_state_t *n);
522 // write E_ flags to a msg
523 void EntityState_WriteExtendBits(sizebuf_t *msg, unsigned int bits);
524 // write values for the E_ flagged fields to a msg
525 void EntityState_WriteFields(const entity_state_t *ent, sizebuf_t *msg, unsigned int bits);
526 // write entity number and E_ flags and their values, or a remove number, describing the change from delta to ent
527 void EntityState_WriteUpdate(const entity_state_t *ent, sizebuf_t *msg, const entity_state_t *delta);
529 int EntityState_ReadExtendBits(void);
530 // read values for E_ flagged fields and apply them to a state
531 void EntityState_ReadFields(entity_state_t *e, unsigned int bits);
533 // (client and server) allocates a new empty database
534 entityframe_database_t *EntityFrame_AllocDatabase(mempool_t *mempool);
535 // (client and server) frees the database
536 void EntityFrame_FreeDatabase(entityframe_database_t *d);
537 // (server) clears the database to contain no frames (thus delta compression
538 // compresses against nothing)
539 void EntityFrame_ClearDatabase(entityframe_database_t *d);
540 // (server and client) removes frames older than 'frame' from database
541 void EntityFrame_AckFrame(entityframe_database_t *d, int frame);
542 // (server) clears frame, to prepare for adding entities
543 void EntityFrame_Clear(entity_frame_t *f, vec3_t eye, int framenum);
544 // (server and client) reads a frame from the database
545 void EntityFrame_FetchFrame(entityframe_database_t *d, int framenum, entity_frame_t *f);
546 // (server and client) adds a entity_frame to the database, for future
548 void EntityFrame_AddFrame(entityframe_database_t *d, vec3_t eye, int framenum, int numentities, const entity_state_t *entitydata);
549 // (server) writes a frame to network stream
550 void EntityFrame_WriteFrame(sizebuf_t *msg, entityframe_database_t *d, int numstates, const entity_state_t *states, int viewentnum);
551 // (client) reads a frame from network stream
552 void EntityFrame_CL_ReadFrame(void);
553 // (client) returns the frame number of the most recent frame recieved
554 int EntityFrame_MostRecentlyRecievedFrameNum(entityframe_database_t *d);
556 typedef struct entity_database4_commit_s
558 // frame number this commit represents
560 // number of entities in entity[] array
562 // maximum number of entities in entity[] array (dynamic resizing)
564 entity_state_t *entity;
566 entity_database4_commit_t;
568 typedef struct entity_database4_s
570 // what mempool to use for allocations
573 int referenceframenum;
574 // reference entities array is resized according to demand
575 int maxreferenceentities;
576 // array of states for entities, these are indexable by their entity number (yes there are gaps)
577 entity_state_t *referenceentity;
578 // commits waiting to be applied to the reference database when confirmed
579 // (commit[i]->numentities == 0 means it is empty)
580 entity_database4_commit_t commit[MAX_ENTITY_HISTORY];
581 // (server only) the current commit being worked on
582 entity_database4_commit_t *currentcommit;
583 // (server only) if a commit won't fit entirely, continue where it left
585 int currententitynumber;
587 int latestframenumber;
589 entityframe4_database_t;
591 // should-be-private functions that aren't
592 entity_state_t *EntityFrame4_GetReferenceEntity(entityframe4_database_t *d, int number);
593 void EntityFrame4_AddCommitEntity(entityframe4_database_t *d, const entity_state_t *s);
595 // allocate a database
596 entityframe4_database_t *EntityFrame4_AllocDatabase(mempool_t *pool);
598 void EntityFrame4_FreeDatabase(entityframe4_database_t *d);
599 // reset a database (resets compression but does not reallocate anything)
600 void EntityFrame4_ResetDatabase(entityframe4_database_t *d);
601 // updates database to account for a frame-received acknowledgment
602 int EntityFrame4_AckFrame(entityframe4_database_t *d, int framenum, int servermode);
603 // writes a frame to the network stream
604 void EntityFrame4_WriteFrame(sizebuf_t *msg, entityframe4_database_t *d, int numstates, const entity_state_t *states);
605 // reads a frame from the network stream
606 void EntityFrame4_CL_ReadFrame(void);
608 // reset all entity fields (typically used if status changed)
609 #define E5_FULLUPDATE (1<<0)
610 // E5_ORIGIN32=0: short[3] = s->origin[0] * 8, s->origin[1] * 8, s->origin[2] * 8
611 // E5_ORIGIN32=1: float[3] = s->origin[0], s->origin[1], s->origin[2]
612 #define E5_ORIGIN (1<<1)
613 // E5_ANGLES16=0: byte[3] = s->angle[0] * 256 / 360, s->angle[1] * 256 / 360, s->angle[2] * 256 / 360
614 // E5_ANGLES16=1: short[3] = s->angle[0] * 65536 / 360, s->angle[1] * 65536 / 360, s->angle[2] * 65536 / 360
615 #define E5_ANGLES (1<<2)
616 // E5_MODEL16=0: byte = s->modelindex
617 // E5_MODEL16=1: short = s->modelindex
618 #define E5_MODEL (1<<3)
619 // E5_FRAME16=0: byte = s->frame
620 // E5_FRAME16=1: short = s->frame
621 #define E5_FRAME (1<<4)
623 #define E5_SKIN (1<<5)
624 // E5_EFFECTS16=0 && E5_EFFECTS32=0: byte = s->effects
625 // E5_EFFECTS16=1 && E5_EFFECTS32=0: short = s->effects
626 // E5_EFFECTS16=0 && E5_EFFECTS32=1: int = s->effects
627 // E5_EFFECTS16=1 && E5_EFFECTS32=1: int = s->effects
628 #define E5_EFFECTS (1<<6)
630 #define E5_EXTEND1 (1<<7)
632 // byte = s->renderflags
633 #define E5_FLAGS (1<<8)
634 // byte = bound(0, s->alpha * 255, 255)
635 #define E5_ALPHA (1<<9)
636 // byte = bound(0, s->scale * 16, 255)
637 #define E5_SCALE (1<<10)
639 #define E5_ORIGIN32 (1<<11)
641 #define E5_ANGLES16 (1<<12)
643 #define E5_MODEL16 (1<<13)
644 // byte = s->colormap
645 #define E5_COLORMAP (1<<14)
647 #define E5_EXTEND2 (1<<15)
649 // short = s->tagentity
650 // byte = s->tagindex
651 #define E5_ATTACHMENT (1<<16)
652 // short[4] = s->light[0], s->light[1], s->light[2], s->light[3]
653 // byte = s->lightstyle
654 // byte = s->lightpflags
655 #define E5_LIGHT (1<<17)
656 // byte = s->glowsize
657 // byte = s->glowcolor
658 #define E5_GLOW (1<<18)
659 // short = s->effects
660 #define E5_EFFECTS16 (1<<19)
662 #define E5_EFFECTS32 (1<<20)
664 #define E5_FRAME16 (1<<21)
665 // byte[3] = s->colormod[0], s->colormod[1], s->colormod[2]
666 #define E5_COLORMOD (1<<22)
668 #define E5_EXTEND3 (1<<23)
671 #define E5_UNUSED24 (1<<24)
673 #define E5_UNUSED25 (1<<25)
675 #define E5_UNUSED26 (1<<26)
677 #define E5_UNUSED27 (1<<27)
679 #define E5_UNUSED28 (1<<28)
681 #define E5_UNUSED29 (1<<29)
683 #define E5_UNUSED30 (1<<30)
685 #define E5_EXTEND4 (1<<31)
687 #define ENTITYFRAME5_MAXPACKETLOGS 64
688 #define ENTITYFRAME5_MAXSTATES 1024
690 typedef struct entityframe5_changestate_s
695 entityframe5_changestate_t;
697 typedef struct entityframe5_packetlog_s
701 entityframe5_changestate_t states[ENTITYFRAME5_MAXSTATES];
702 unsigned char statsdeltabits[(MAX_CL_STATS+7)/8];
704 entityframe5_packetlog_t;
706 typedef struct entityframe5_database_s
708 // number of the latest message sent to client
710 // updated by WriteFrame for internal use
713 // logs of all recently sent messages (between acked and latest)
714 entityframe5_packetlog_t packetlog[ENTITYFRAME5_MAXPACKETLOGS];
716 // this goes up as needed and causes all the arrays to be reallocated
719 // which properties of each entity have changed since last send
720 int *deltabits; // [maxedicts]
721 // priorities of entities (updated whenever deltabits change)
722 // (derived from deltabits)
723 unsigned char *priorities; // [maxedicts]
724 // last frame this entity was sent on, for prioritzation
725 int *updateframenum; // [maxedicts]
727 // database of current status of all entities
728 entity_state_t *states; // [maxedicts]
729 // which entities are currently active
730 // (duplicate of the active bit of every state in states[])
731 // (derived from states)
732 unsigned char *visiblebits; // [(maxedicts+7)/8]
734 // delta compression of stats
735 unsigned char statsdeltabits[(MAX_CL_STATS+7)/8];
736 int stats[MAX_CL_STATS];
740 // this is used to decide which changestates to set each frame
741 //int numvisiblestates;
742 //entity_state_t visiblestates[MAX_EDICTS];
744 // sorted changing states that need to be sent to the client
745 // kept sorted in lowest to highest priority order, because this allows
746 // the numchangestates to simply be decremented whenever an state is sent,
747 // rather than a memmove to remove them from the start.
748 //int numchangestates;
749 //entityframe5_changestate_t changestates[MAX_EDICTS];
751 entityframe5_database_t;
753 entityframe5_database_t *EntityFrame5_AllocDatabase(mempool_t *pool);
754 void EntityFrame5_FreeDatabase(entityframe5_database_t *d);
755 void EntityState5_WriteUpdate(int number, const entity_state_t *s, int changedbits, sizebuf_t *msg);
756 int EntityState5_DeltaBitsForState(entity_state_t *o, entity_state_t *n);
757 void EntityFrame5_CL_ReadFrame(void);
758 void EntityFrame5_LostFrame(entityframe5_database_t *d, int framenum);
759 void EntityFrame5_AckFrame(entityframe5_database_t *d, int framenum);
760 void EntityFrame5_WriteFrame(sizebuf_t *msg, entityframe5_database_t *d, int numstates, const entity_state_t *states, int viewentnum, int *stats, int movesequence);
762 extern cvar_t developer_networkentities;
768 #define qw_svc_disconnect 2
769 #define qw_svc_updatestat 3 // [byte] [byte]
770 #define qw_svc_setview 5 // [short] entity number
771 #define qw_svc_sound 6 // <see code>
772 #define qw_svc_print 8 // [byte] id [string] null terminated string
773 #define qw_svc_stufftext 9 // [string] stuffed into client's console buffer
774 #define qw_svc_setangle 10 // [angle3] set the view angle to this absolute value
775 #define qw_svc_serverdata 11 // [long] protocol ...
776 #define qw_svc_lightstyle 12 // [byte] [string]
777 #define qw_svc_updatefrags 14 // [byte] [short]
778 #define qw_svc_stopsound 16 // <see code>
779 #define qw_svc_damage 19
780 #define qw_svc_spawnstatic 20
781 #define qw_svc_spawnbaseline 22
782 #define qw_svc_temp_entity 23 // variable
783 #define qw_svc_setpause 24 // [byte] on / off
784 #define qw_svc_centerprint 26 // [string] to put in center of the screen
785 #define qw_svc_killedmonster 27
786 #define qw_svc_foundsecret 28
787 #define qw_svc_spawnstaticsound 29 // [coord3] [byte] samp [byte] vol [byte] aten
788 #define qw_svc_intermission 30 // [vec3_t] origin [vec3_t] angle
789 #define qw_svc_finale 31 // [string] text
790 #define qw_svc_cdtrack 32 // [byte] track
791 #define qw_svc_sellscreen 33
792 #define qw_svc_smallkick 34 // set client punchangle to 2
793 #define qw_svc_bigkick 35 // set client punchangle to 4
794 #define qw_svc_updateping 36 // [byte] [short]
795 #define qw_svc_updateentertime 37 // [byte] [float]
796 #define qw_svc_updatestatlong 38 // [byte] [long]
797 #define qw_svc_muzzleflash 39 // [short] entity
798 #define qw_svc_updateuserinfo 40 // [byte] slot [long] uid
799 #define qw_svc_download 41 // [short] size [size bytes]
800 #define qw_svc_playerinfo 42 // variable
801 #define qw_svc_nails 43 // [byte] num [48 bits] xyzpy 12 12 12 4 8
802 #define qw_svc_chokecount 44 // [byte] packets choked
803 #define qw_svc_modellist 45 // [strings]
804 #define qw_svc_soundlist 46 // [strings]
805 #define qw_svc_packetentities 47 // [...]
806 #define qw_svc_deltapacketentities 48 // [...]
807 #define qw_svc_maxspeed 49 // maxspeed change, for prediction
808 #define qw_svc_entgravity 50 // gravity change, for prediction
809 #define qw_svc_setinfo 51 // setinfo on a client
810 #define qw_svc_serverinfo 52 // serverinfo
811 #define qw_svc_updatepl 53 // [byte] [byte]
816 #define qw_clc_move 3 // [[usercmd_t]
817 #define qw_clc_stringcmd 4 // [string] message
818 #define qw_clc_delta 5 // [byte] sequence number, requests delta compression of message
819 #define qw_clc_tmove 6 // teleport request, spectator only
820 #define qw_clc_upload 7 // teleport request, spectator only
822 // playerinfo flags from server
823 // playerinfo always sends: playernum, flags, origin[] and framenumber
824 #define QW_PF_MSEC (1<<0)
825 #define QW_PF_COMMAND (1<<1)
826 #define QW_PF_VELOCITY1 (1<<2)
827 #define QW_PF_VELOCITY2 (1<<3)
828 #define QW_PF_VELOCITY3 (1<<4)
829 #define QW_PF_MODEL (1<<5)
830 #define QW_PF_SKINNUM (1<<6)
831 #define QW_PF_EFFECTS (1<<7)
832 #define QW_PF_WEAPONFRAME (1<<8) // only sent for view player
833 #define QW_PF_DEAD (1<<9) // don't block movement any more
834 #define QW_PF_GIB (1<<10) // offset the view height differently
835 #define QW_PF_NOGRAV (1<<11) // don't apply gravity for prediction
837 // if the high bit of the client to server byte is set, the low bits are
838 // client move cmd bits
839 // ms and angle2 are allways sent, the others are optional
840 #define QW_CM_ANGLE1 (1<<0)
841 #define QW_CM_ANGLE3 (1<<1)
842 #define QW_CM_FORWARD (1<<2)
843 #define QW_CM_SIDE (1<<3)
844 #define QW_CM_UP (1<<4)
845 #define QW_CM_BUTTONS (1<<5)
846 #define QW_CM_IMPULSE (1<<6)
847 #define QW_CM_ANGLE2 (1<<7)
849 // the first 16 bits of a packetentities update holds 9 bits
850 // of entity number and 7 bits of flags
851 #define QW_U_ORIGIN1 (1<<9)
852 #define QW_U_ORIGIN2 (1<<10)
853 #define QW_U_ORIGIN3 (1<<11)
854 #define QW_U_ANGLE2 (1<<12)
855 #define QW_U_FRAME (1<<13)
856 #define QW_U_REMOVE (1<<14) // REMOVE this entity, don't add it
857 #define QW_U_MOREBITS (1<<15)
858 // if MOREBITS is set, these additional flags are read in next
859 #define QW_U_ANGLE1 (1<<0)
860 #define QW_U_ANGLE3 (1<<1)
861 #define QW_U_MODEL (1<<2)
862 #define QW_U_COLORMAP (1<<3)
863 #define QW_U_SKIN (1<<4)
864 #define QW_U_EFFECTS (1<<5)
865 #define QW_U_SOLID (1<<6) // the entity should be solid for prediction
867 // temp entity events
868 #define QW_TE_SPIKE 0
869 #define QW_TE_SUPERSPIKE 1
870 #define QW_TE_GUNSHOT 2
871 #define QW_TE_EXPLOSION 3
872 #define QW_TE_TAREXPLOSION 4
873 #define QW_TE_LIGHTNING1 5
874 #define QW_TE_LIGHTNING2 6
875 #define QW_TE_WIZSPIKE 7
876 #define QW_TE_KNIGHTSPIKE 8
877 #define QW_TE_LIGHTNING3 9
878 #define QW_TE_LAVASPLASH 10
879 #define QW_TE_TELEPORT 11
880 #define QW_TE_BLOOD 12
881 #define QW_TE_LIGHTNINGBLOOD 13
884 #define QW_EF_BRIGHTFIELD 1
885 #define QW_EF_MUZZLEFLASH 2
886 #define QW_EF_BRIGHTLIGHT 4
887 #define QW_EF_DIMLIGHT 8
888 #define QW_EF_FLAG1 16
889 #define QW_EF_FLAG2 32
890 #define QW_EF_BLUE 64
891 #define QW_EF_RED 128
893 #define QW_UPDATE_BACKUP 64
894 #define QW_UPDATE_MASK (QW_UPDATE_BACKUP - 1)
895 #define QW_MAX_PACKET_ENTITIES 64
897 // note: QW stats are directly compatible with NQ
898 // (but FRAGS, WEAPONFRAME, and VIEWHEIGHT are unused)
899 // so these defines are not actually used by darkplaces, but kept for reference
900 #define QW_STAT_HEALTH 0
901 //#define QW_STAT_FRAGS 1
902 #define QW_STAT_WEAPON 2
903 #define QW_STAT_AMMO 3
904 #define QW_STAT_ARMOR 4
905 //#define QW_STAT_WEAPONFRAME 5
906 #define QW_STAT_SHELLS 6
907 #define QW_STAT_NAILS 7
908 #define QW_STAT_ROCKETS 8
909 #define QW_STAT_CELLS 9
910 #define QW_STAT_ACTIVEWEAPON 10
911 #define QW_STAT_TOTALSECRETS 11
912 #define QW_STAT_TOTALMONSTERS 12
913 #define QW_STAT_SECRETS 13 // bumped on client side by svc_foundsecret
914 #define QW_STAT_MONSTERS 14 // bumped by svc_killedmonster
915 #define QW_STAT_ITEMS 15
916 //#define QW_STAT_VIEWHEIGHT 16
918 // build entity data in this, to pass to entity read/write functions
919 typedef struct entityframeqw_snapshot_s
924 entity_state_t entities[QW_MAX_PACKET_ENTITIES];
926 entityframeqw_snapshot_t;
928 typedef struct entityframeqw_database_s
930 entityframeqw_snapshot_t snapshot[QW_UPDATE_BACKUP];
932 entityframeqw_database_t;
934 entityframeqw_database_t *EntityFrameQW_AllocDatabase(mempool_t *pool);
935 void EntityFrameQW_FreeDatabase(entityframeqw_database_t *d);
936 void EntityStateQW_ReadPlayerUpdate(void);
937 void EntityFrameQW_CL_ReadFrame(qboolean delta);