rewrote protocol version system (including splitting PROTOCOL_QUAKE into PROTOCOL_QUA...
[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 // protocolversion_t is defined in common.h
26
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);
32
33 // model effects
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
42 // entity effects
43 #define EF_BRIGHTFIELD                  1
44 #define EF_MUZZLEFLASH                  2
45 #define EF_BRIGHTLIGHT                  4
46 #define EF_DIMLIGHT                     8
47 #define EF_NODRAW                               16
48 #define EF_ADDITIVE                             32
49 #define EF_BLUE                                 64
50 #define EF_RED                                  128
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
62 #define EF_STEP                                 0x80000000 // internal client use only - present on MOVETYPE_STEP entities, not QC accessible (too many bits)
63
64 // flags for the pflags field of entities
65 #define PFLAGS_NOSHADOW                 1
66 #define PFLAGS_CORONA                   2
67 #define PFLAGS_FULLDYNAMIC              128 // must be set or the light fields are ignored
68
69 // if the high bit of the servercmd is set, the low bits are fast update flags:
70 #define U_MOREBITS              (1<<0)
71 #define U_ORIGIN1               (1<<1)
72 #define U_ORIGIN2               (1<<2)
73 #define U_ORIGIN3               (1<<3)
74 #define U_ANGLE2                (1<<4)
75 // LordHavoc: U_NOLERP was only ever used for monsters, so I renamed it U_STEP
76 #define U_STEP                  (1<<5)
77 #define U_FRAME                 (1<<6)
78 // just differentiates from other updates
79 #define U_SIGNAL                (1<<7)
80
81 #define U_ANGLE1                (1<<8)
82 #define U_ANGLE3                (1<<9)
83 #define U_MODEL                 (1<<10)
84 #define U_COLORMAP              (1<<11)
85 #define U_SKIN                  (1<<12)
86 #define U_EFFECTS               (1<<13)
87 #define U_LONGENTITY    (1<<14)
88
89 // LordHavoc: protocol extension
90 #define U_EXTEND1               (1<<15)
91 // LordHavoc: first extend byte
92 #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)
93 #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)
94 #define U_SCALE                 (1<<18) // 1 byte, scale / 16 positive, not sent if 1.0
95 #define U_EFFECTS2              (1<<19) // 1 byte, this is .effects & 0xFF00 (second byte)
96 #define U_GLOWSIZE              (1<<20) // 1 byte, encoding is float/4.0, unsigned, not sent if 0
97 #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)
98 #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...
99 #define U_EXTEND2               (1<<23) // another byte to follow
100 // LordHavoc: second extend byte
101 #define U_GLOWTRAIL             (1<<24) // leaves a trail of particles (of color .glowcolor, or black if it is a negative glowsize)
102 #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
103 #define U_FRAME2                (1<<26) // 1 byte, this is .frame & 0xFF00 (second byte)
104 #define U_MODEL2                (1<<27) // 1 byte, this is .modelindex & 0xFF00 (second byte)
105 #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)
106 #define U_UNUSED29              (1<<29) // future expansion
107 #define U_UNUSED30              (1<<30) // future expansion
108 #define U_EXTEND3               (1<<31) // another byte to follow, future expansion
109
110 #define SU_VIEWHEIGHT   (1<<0)
111 #define SU_IDEALPITCH   (1<<1)
112 #define SU_PUNCH1               (1<<2)
113 #define SU_PUNCH2               (1<<3)
114 #define SU_PUNCH3               (1<<4)
115 #define SU_VELOCITY1    (1<<5)
116 #define SU_VELOCITY2    (1<<6)
117 #define SU_VELOCITY3    (1<<7)
118 //define        SU_AIMENT               (1<<8)  AVAILABLE BIT
119 #define SU_ITEMS                (1<<9)
120 #define SU_ONGROUND             (1<<10)         // no data follows, the bit is it
121 #define SU_INWATER              (1<<11)         // no data follows, the bit is it
122 #define SU_WEAPONFRAME  (1<<12)
123 #define SU_ARMOR                (1<<13)
124 #define SU_WEAPON               (1<<14)
125 #define SU_EXTEND1              (1<<15)
126 // first extend byte
127 #define SU_PUNCHVEC1    (1<<16)
128 #define SU_PUNCHVEC2    (1<<17)
129 #define SU_PUNCHVEC3    (1<<18)
130 #define SU_VIEWZOOM             (1<<19) // byte factor (0 = 0.0 (not valid), 255 = 1.0)
131 #define SU_UNUSED20             (1<<20)
132 #define SU_UNUSED21             (1<<21)
133 #define SU_UNUSED22             (1<<22)
134 #define SU_EXTEND2              (1<<23) // another byte to follow, future expansion
135 // second extend byte
136 #define SU_UNUSED24             (1<<24)
137 #define SU_UNUSED25             (1<<25)
138 #define SU_UNUSED26             (1<<26)
139 #define SU_UNUSED27             (1<<27)
140 #define SU_UNUSED28             (1<<28)
141 #define SU_UNUSED29             (1<<29)
142 #define SU_UNUSED30             (1<<30)
143 #define SU_EXTEND3              (1<<31) // another byte to follow, future expansion
144
145 // a sound with no channel is a local only sound
146 #define SND_VOLUME              (1<<0)          // a byte
147 #define SND_ATTENUATION (1<<1)          // a byte
148 #define SND_LOOPING             (1<<2)          // a long
149 #define SND_LARGEENTITY (1<<3)          // a short and a byte (instead of a short)
150 #define SND_LARGESOUND  (1<<4)          // a short (instead of a byte)
151
152
153 // defaults for clientinfo messages
154 #define DEFAULT_VIEWHEIGHT      22
155
156
157 // game types sent by serverinfo
158 // these determine which intermission screen plays
159 #define GAME_COOP                       0
160 #define GAME_DEATHMATCH         1
161
162 //==================
163 // note that there are some defs.qc that mirror to these numbers
164 // also related to svc_strings[] in cl_parse
165 //==================
166
167 //
168 // server to client
169 //
170 #define svc_bad                         0
171 #define svc_nop                         1
172 #define svc_disconnect          2
173 #define svc_updatestat          3       // [byte] [long]
174 #define svc_version                     4       // [long] server version
175 #define svc_setview                     5       // [short] entity number
176 #define svc_sound                       6       // <see code>
177 #define svc_time                        7       // [float] server time
178 #define svc_print                       8       // [string] null terminated string
179 #define svc_stufftext           9       // [string] stuffed into client's console buffer
180                                                                 // the string should be \n terminated
181 #define svc_setangle            10      // [angle3] set the view angle to this absolute value
182
183 #define svc_serverinfo          11      // [long] version
184                                                 // [string] signon string
185                                                 // [string]..[0]model cache
186                                                 // [string]...[0]sounds cache
187 #define svc_lightstyle          12      // [byte] [string]
188 #define svc_updatename          13      // [byte] [string]
189 #define svc_updatefrags         14      // [byte] [short]
190 #define svc_clientdata          15      // <shortbits + data>
191 #define svc_stopsound           16      // <see code>
192 #define svc_updatecolors        17      // [byte] [byte]
193 #define svc_particle            18      // [vec3] <variable>
194 #define svc_damage                      19
195
196 #define svc_spawnstatic         20
197 //      svc_spawnbinary         21
198 #define svc_spawnbaseline       22
199
200 #define svc_temp_entity         23
201
202 #define svc_setpause            24      // [byte] on / off
203 #define svc_signonnum           25      // [byte]  used for the signon sequence
204
205 #define svc_centerprint         26      // [string] to put in center of the screen
206
207 #define svc_killedmonster       27
208 #define svc_foundsecret         28
209
210 #define svc_spawnstaticsound    29      // [coord3] [byte] samp [byte] vol [byte] aten
211
212 #define svc_intermission        30              // [string] music
213 #define svc_finale                      31              // [string] music [string] text
214
215 #define svc_cdtrack                     32              // [byte] track [byte] looptrack
216 #define svc_sellscreen          33
217
218 #define svc_cutscene            34
219
220 #define svc_showlmp                     35              // [string] slotname [string] lmpfilename [short] x [short] y
221 #define svc_hidelmp                     36              // [string] slotname
222 #define svc_skybox                      37              // [string] skyname
223
224 // LordHavoc: my svc_ range, 50-59
225 #define svc_cgame                       50              // [short] length [bytes] data
226 #define svc_updatestatubyte     51              // [byte] stat [byte] value
227 #define svc_effect                      52              // [vector] org [byte] modelindex [byte] startframe [byte] framecount [byte] framerate
228 #define svc_effect2                     53              // [vector] org [short] modelindex [short] startframe [byte] framecount [byte] framerate
229 #define svc_sound2                      54              // (obsolete in DP6 and later) short soundindex instead of byte
230 #define svc_precache            54              // [short] precacheindex [string] filename, precacheindex is + 0 for modelindex and +32768 for soundindex
231 #define svc_spawnbaseline2      55              // short modelindex instead of byte
232 #define svc_spawnstatic2        56              // short modelindex instead of byte
233 #define svc_entities            57              // [int] deltaframe [int] thisframe [float vector] eye [variable length] entitydata
234 #define svc_unusedlh3                   58
235 #define svc_spawnstaticsound2   59      // [coord3] [short] samp [byte] vol [byte] aten
236
237 //
238 // client to server
239 //
240 #define clc_bad                 0
241 #define clc_nop                 1
242 #define clc_disconnect  2
243 #define clc_move                3                       // [usercmd_t]
244 #define clc_stringcmd   4               // [string] message
245
246 // LordHavoc: my clc_ range, 50-59
247 #define clc_ackframe    50              // [int] framenumber
248 #define clc_unusedlh1   51
249 #define clc_unusedlh2   52
250 #define clc_unusedlh3   53
251 #define clc_unusedlh4   54
252 #define clc_unusedlh5   55
253 #define clc_unusedlh6   56
254 #define clc_unusedlh7   57
255 #define clc_unusedlh8   58
256 #define clc_unusedlh9   59
257
258 //
259 // temp entity events
260 //
261 #define TE_SPIKE                        0 // [vector] origin
262 #define TE_SUPERSPIKE           1 // [vector] origin
263 #define TE_GUNSHOT                      2 // [vector] origin
264 #define TE_EXPLOSION            3 // [vector] origin
265 #define TE_TAREXPLOSION         4 // [vector] origin
266 #define TE_LIGHTNING1           5 // [entity] entity [vector] start [vector] end
267 #define TE_LIGHTNING2           6 // [entity] entity [vector] start [vector] end
268 #define TE_WIZSPIKE                     7 // [vector] origin
269 #define TE_KNIGHTSPIKE          8 // [vector] origin
270 #define TE_LIGHTNING3           9 // [entity] entity [vector] start [vector] end
271 #define TE_LAVASPLASH           10 // [vector] origin
272 #define TE_TELEPORT                     11 // [vector] origin
273 #define TE_EXPLOSION2           12 // [vector] origin [byte] startcolor [byte] colorcount
274
275 // PGM 01/21/97
276 #define TE_BEAM                         13 // [entity] entity [vector] start [vector] end
277 // PGM 01/21/97
278
279 // Nehahra effects used in the movie (TE_EXPLOSION3 also got written up in a QSG tutorial, hence it's not marked NEH)
280 #define TE_EXPLOSION3           16 // [vector] origin [coord] red [coord] green [coord] blue
281 #define TE_LIGHTNING4NEH        17 // [string] model [entity] entity [vector] start [vector] end
282
283 // LordHavoc: added some TE_ codes (block1 - 50-60)
284 #define TE_BLOOD                        50 // [vector] origin [byte] xvel [byte] yvel [byte] zvel [byte] count
285 #define TE_SPARK                        51 // [vector] origin [byte] xvel [byte] yvel [byte] zvel [byte] count
286 #define TE_BLOODSHOWER          52 // [vector] min [vector] max [coord] explosionspeed [short] count
287 #define TE_EXPLOSIONRGB         53 // [vector] origin [byte] red [byte] green [byte] blue
288 #define TE_PARTICLECUBE         54 // [vector] min [vector] max [vector] dir [short] count [byte] color [byte] gravity [coord] randomvel
289 #define TE_PARTICLERAIN         55 // [vector] min [vector] max [vector] dir [short] count [byte] color
290 #define TE_PARTICLESNOW         56 // [vector] min [vector] max [vector] dir [short] count [byte] color
291 #define TE_GUNSHOTQUAD          57 // [vector] origin
292 #define TE_SPIKEQUAD            58 // [vector] origin
293 #define TE_SUPERSPIKEQUAD       59 // [vector] origin
294 // LordHavoc: block2 - 70-80
295 #define TE_EXPLOSIONQUAD        70 // [vector] origin
296 #define TE_UNUSED1                      71 // unused
297 #define TE_SMALLFLASH           72 // [vector] origin
298 #define TE_CUSTOMFLASH          73 // [vector] origin [byte] radius / 8 - 1 [byte] lifetime / 256 - 1 [byte] red [byte] green [byte] blue
299 #define TE_FLAMEJET                     74 // [vector] origin [vector] velocity [byte] count
300 #define TE_PLASMABURN           75 // [vector] origin
301 // LordHavoc: Tei grabbed these codes
302 #define TE_TEI_G3                       76 // [vector] start [vector] end [vector] angles
303 #define TE_TEI_SMOKE            77 // [vector] origin [vector] dir [byte] count
304 #define TE_TEI_BIGEXPLOSION     78 // [vector] origin
305 #define TE_TEI_PLASMAHIT        79 // [vector} origin [vector] dir [byte] count
306
307
308 // these are bits for the 'flags' field of the entity_state_t
309 #define RENDER_STEP 1
310 #define RENDER_GLOWTRAIL 2
311 #define RENDER_VIEWMODEL 4
312 #define RENDER_EXTERIORMODEL 8
313 #define RENDER_LOWPRECISION 16 // send as low precision coordinates to save bandwidth
314 #define RENDER_COLORMAPPED 32
315 #define RENDER_SHADOW 65536 // cast shadow
316 #define RENDER_LIGHT 131072 // receive light
317 #define RENDER_TRANSPARENT 262144 // can't light during opaque stage
318
319 // this is 80 bytes
320 typedef struct
321 {
322         // ! means this is not sent to client
323         double time; // ! time this state was built (used on client for interpolation)
324         float origin[3];
325         float angles[3];
326         int number; // entity number this state is for
327         int effects;
328         unsigned short modelindex;
329         unsigned short frame;
330         unsigned short tagentity;
331         unsigned short specialvisibilityradius; // ! larger if it has effects/light
332         unsigned short viewmodelforclient; // !
333         unsigned short exteriormodelforclient; // ! not shown if first person viewing from this entity, shown in all other cases
334         unsigned short nodrawtoclient; // !
335         unsigned short drawonlytoclient; // !
336         unsigned short light[4]; // color*256 (0.00 to 255.996), and radius*1
337         unsigned char active; // true if a valid state
338         unsigned char lightstyle;
339         unsigned char lightpflags;
340         unsigned char colormap;
341         unsigned char skin; // also chooses cubemap for rtlights if lightpflags & LIGHTPFLAGS_FULLDYNAMIC
342         unsigned char alpha;
343         unsigned char scale;
344         unsigned char glowsize;
345         unsigned char glowcolor;
346         unsigned char flags;
347         unsigned char tagindex;
348         unsigned char colormod[3];
349         // padding to a multiple of 8 bytes (to align the double time)
350         unsigned char unused[2];
351 }
352 entity_state_t;
353
354 // baseline state values
355 entity_state_t defaultstate;
356 // reads a quake entity from the network stream
357 void EntityFrameQuake_ReadEntity(int bits);
358 // writes a list of quake entities to the network stream
359 // (or as many will fit)
360 void EntityFrameQuake_WriteFrame(sizebuf_t *msg, int numstates, const entity_state_t *states);
361 // cleans up dead entities each frame after ReadEntity (which doesn't clear unused entities)
362 void EntityFrameQuake_ISeeDeadEntities(void);
363
364 /*
365 PROTOCOL_DARKPLACES3
366 server updates entities according to some (unmentioned) scheme.
367
368 a frame consists of all visible entities, some of which are up to date,
369 often some are not up to date.
370
371 these entities are stored in a range (firstentity/endentity) of structs in the
372 entitydata[] buffer.
373
374 to make a commit the server performs these steps:
375 1. duplicate oldest frame in database (this is the baseline) as new frame, and
376    write frame numbers (oldest frame's number, new frame's number) and eye
377    location to network packet (eye location is obsolete and will be removed in
378    future revisions)
379 2. write an entity change to packet and modify new frame accordingly
380    (this repeats until packet is sufficiently full or new frame is complete)
381 3. write terminator (0xFFFF) to network packet
382    (FIXME: this terminator value conflicts with MAX_EDICTS 32768...)
383
384 to read a commit the client performs these steps:
385 1. reads frame numbers from packet and duplicates baseline frame as new frame,
386    also reads eye location but does nothing with it (obsolete).
387 2. delete frames older than the baseline which was used
388 3. read entity changes from packet until terminator (0xFFFF) is encountered,
389    each change is applied to entity frame.
390 4. sends ack framenumber to server as part of input packet
391
392 if server receives ack message in put packet it performs these steps:
393 1. remove all older frames from database.
394 */
395
396 /*
397 PROTOCOL_DARKPLACES4
398 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).
399
400 these entities are stored in a range (firstentity/endentity) of structs in the entitydata[] buffer.
401
402 to make a commit the server performs these steps:
403 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.
404
405 This documention is unfinished!
406 the Write function performs these steps:
407 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.
408 2. write differences of an entity compared to selected baseline.
409 3. add entity to entity update in database.
410 4. if there are more entities to write and packet is not full, go back to step 2.
411 5. write terminator (0xFFFF) as entity number.
412 6. return.
413
414
415
416
417
418 server updates entities in looping ranges, a frame consists of a range of visible entities (not always all visible entities),
419 */
420
421 typedef struct
422 {
423         double time;
424         int framenum;
425         int firstentity; // index into entitydata, modulo MAX_ENTITY_DATABASE
426         int endentity; // index into entitydata, firstentity + numentities
427 }
428 entity_frameinfo_t;
429
430 #define MAX_ENTITY_HISTORY 64
431 #define MAX_ENTITY_DATABASE (MAX_EDICTS * 2)
432
433 typedef struct
434 {
435         // note: these can be far out of range, modulo with MAX_ENTITY_DATABASE to get a valid range (which may wrap)
436         // start and end of used area, when adding a new update to database, store at endpos, and increment endpos
437         // when removing updates from database, nudge down frames array to only contain useful frames
438         // this logic should explain better:
439         // if (numframes >= MAX_ENTITY_HISTORY || (frames[numframes - 1].endentity - frames[0].firstentity) + entitiestoadd > MAX_ENTITY_DATABASE)
440         //     flushdatabase();
441         // note: if numframes == 0, insert at start (0 in entitydata)
442         // the only reason this system is used is to avoid copying memory when frames are removed
443         int numframes;
444         // server only: last sent frame
445         int latestframenum;
446         // server only: last acknowledged frame
447         int ackframenum;
448         // the current state in the database
449         vec3_t eye;
450         // table of entities in the entityhistorydata
451         entity_frameinfo_t frames[MAX_ENTITY_HISTORY];
452         // entities
453         entity_state_t entitydata[MAX_ENTITY_DATABASE];
454 }
455 entityframe_database_t;
456
457 // build entity data in this, to pass to entity read/write functions
458 typedef struct
459 {
460         double time;
461         int framenum;
462         int numentities;
463         int firstentitynum;
464         int lastentitynum;
465         vec3_t eye;
466         entity_state_t entitydata[MAX_ENTITY_DATABASE];
467 }
468 entity_frame_t;
469
470 // LordHavoc: these are in approximately sorted order, according to cost and
471 // likelyhood of being used for numerous objects in a frame
472
473 // note that the bytes are not written/read in this order, this is only the
474 // order of the bits to minimize overhead from extend bytes
475
476 // enough to describe a nail, gib, shell casing, bullet hole, or rocket
477 #define E_ORIGIN1               (1<<0)
478 #define E_ORIGIN2               (1<<1)
479 #define E_ORIGIN3               (1<<2)
480 #define E_ANGLE1                (1<<3)
481 #define E_ANGLE2                (1<<4)
482 #define E_ANGLE3                (1<<5)
483 #define E_MODEL1                (1<<6)
484 #define E_EXTEND1               (1<<7)
485
486 // enough to describe almost anything
487 #define E_FRAME1                (1<<8)
488 #define E_EFFECTS1              (1<<9)
489 #define E_ALPHA                 (1<<10)
490 #define E_SCALE                 (1<<11)
491 #define E_COLORMAP              (1<<12)
492 #define E_SKIN                  (1<<13)
493 #define E_FLAGS                 (1<<14)
494 #define E_EXTEND2               (1<<15)
495
496 // players, custom color glows, high model numbers
497 #define E_FRAME2                (1<<16)
498 #define E_MODEL2                (1<<17)
499 #define E_EFFECTS2              (1<<18)
500 #define E_GLOWSIZE              (1<<19)
501 #define E_GLOWCOLOR             (1<<20)
502 #define E_LIGHT                 (1<<21)
503 #define E_LIGHTPFLAGS   (1<<22)
504 #define E_EXTEND3               (1<<23)
505
506 #define E_SOUND1                (1<<24)
507 #define E_SOUNDVOL              (1<<25)
508 #define E_SOUNDATTEN    (1<<26)
509 #define E_TAGATTACHMENT (1<<27)
510 #define E_LIGHTSTYLE    (1<<28)
511 #define E_UNUSED6               (1<<29)
512 #define E_UNUSED7               (1<<30)
513 #define E_EXTEND4               (1<<31)
514
515 // returns difference between two states as E_ flags
516 int EntityState_DeltaBits(const entity_state_t *o, const entity_state_t *n);
517 // write E_ flags to a msg
518 void EntityState_WriteExtendBits(sizebuf_t *msg, unsigned int bits);
519 // write values for the E_ flagged fields to a msg
520 void EntityState_WriteFields(const entity_state_t *ent, sizebuf_t *msg, unsigned int bits);
521 // write entity number and E_ flags and their values, or a remove number, describing the change from delta to ent
522 void EntityState_WriteUpdate(const entity_state_t *ent, sizebuf_t *msg, const entity_state_t *delta);
523 // read E_ flags
524 int EntityState_ReadExtendBits(void);
525 // read values for E_ flagged fields and apply them to a state
526 void EntityState_ReadFields(entity_state_t *e, unsigned int bits);
527
528 // (client and server) allocates a new empty database
529 entityframe_database_t *EntityFrame_AllocDatabase(mempool_t *mempool);
530 // (client and server) frees the database
531 void EntityFrame_FreeDatabase(entityframe_database_t *d);
532 // (server) clears the database to contain no frames (thus delta compression
533 // compresses against nothing)
534 void EntityFrame_ClearDatabase(entityframe_database_t *d);
535 // (server and client) removes frames older than 'frame' from database
536 void EntityFrame_AckFrame(entityframe_database_t *d, int frame);
537 // (server) clears frame, to prepare for adding entities
538 void EntityFrame_Clear(entity_frame_t *f, vec3_t eye, int framenum);
539 // (server and client) reads a frame from the database
540 void EntityFrame_FetchFrame(entityframe_database_t *d, int framenum, entity_frame_t *f);
541 // (server and client) adds a entity_frame to the database, for future
542 // reference
543 void EntityFrame_AddFrame(entityframe_database_t *d, vec3_t eye, int framenum, int numentities, const entity_state_t *entitydata);
544 // (server) writes a frame to network stream
545 void EntityFrame_WriteFrame(sizebuf_t *msg, entityframe_database_t *d, int numstates, const entity_state_t *states, int viewentnum);
546 // (client) reads a frame from network stream
547 void EntityFrame_CL_ReadFrame(void);
548 // (client) returns the frame number of the most recent frame recieved
549 int EntityFrame_MostRecentlyRecievedFrameNum(entityframe_database_t *d);
550
551 typedef struct entity_database4_commit_s
552 {
553         // frame number this commit represents
554         int framenum;
555         // number of entities in entity[] array
556         int numentities;
557         // maximum number of entities in entity[] array (dynamic resizing)
558         int maxentities;
559         entity_state_t *entity;
560 }
561 entity_database4_commit_t;
562
563 typedef struct entity_database4_s
564 {
565         // what mempool to use for allocations
566         mempool_t *mempool;
567         // reference frame
568         int referenceframenum;
569         // reference entities array is resized according to demand
570         int maxreferenceentities;
571         // array of states for entities, these are indexable by their entity number (yes there are gaps)
572         entity_state_t *referenceentity;
573         // commits waiting to be applied to the reference database when confirmed
574         // (commit[i]->numentities == 0 means it is empty)
575         entity_database4_commit_t commit[MAX_ENTITY_HISTORY];
576         // (server only) the current commit being worked on
577         entity_database4_commit_t *currentcommit;
578         // (server only) if a commit won't fit entirely, continue where it left
579         // off next frame
580         int currententitynumber;
581         // (server only)
582         int latestframenumber;
583 }
584 entityframe4_database_t;
585
586 // should-be-private functions that aren't
587 entity_state_t *EntityFrame4_GetReferenceEntity(entityframe4_database_t *d, int number);
588 void EntityFrame4_AddCommitEntity(entityframe4_database_t *d, const entity_state_t *s);
589
590 // allocate a database
591 entityframe4_database_t *EntityFrame4_AllocDatabase(mempool_t *pool);
592 // free a database
593 void EntityFrame4_FreeDatabase(entityframe4_database_t *d);
594 // reset a database (resets compression but does not reallocate anything)
595 void EntityFrame4_ResetDatabase(entityframe4_database_t *d);
596 // updates database to account for a frame-received acknowledgment
597 int EntityFrame4_AckFrame(entityframe4_database_t *d, int framenum, int servermode);
598 // writes a frame to the network stream
599 void EntityFrame4_WriteFrame(sizebuf_t *msg, entityframe4_database_t *d, int numstates, const entity_state_t *states);
600 // reads a frame from the network stream
601 void EntityFrame4_CL_ReadFrame(void);
602
603 // reset all entity fields (typically used if status changed)
604 #define E5_FULLUPDATE (1<<0)
605 // E5_ORIGIN32=0: short[3] = s->origin[0] * 8, s->origin[1] * 8, s->origin[2] * 8
606 // E5_ORIGIN32=1: float[3] = s->origin[0], s->origin[1], s->origin[2]
607 #define E5_ORIGIN (1<<1)
608 // E5_ANGLES16=0: byte[3] = s->angle[0] * 256 / 360, s->angle[1] * 256 / 360, s->angle[2] * 256 / 360
609 // E5_ANGLES16=1: short[3] = s->angle[0] * 65536 / 360, s->angle[1] * 65536 / 360, s->angle[2] * 65536 / 360
610 #define E5_ANGLES (1<<2)
611 // E5_MODEL16=0: byte = s->modelindex
612 // E5_MODEL16=1: short = s->modelindex
613 #define E5_MODEL (1<<3)
614 // E5_FRAME16=0: byte = s->frame
615 // E5_FRAME16=1: short = s->frame
616 #define E5_FRAME (1<<4)
617 // byte = s->skin
618 #define E5_SKIN (1<<5)
619 // E5_EFFECTS16=0 && E5_EFFECTS32=0: byte = s->effects
620 // E5_EFFECTS16=1 && E5_EFFECTS32=0: short = s->effects
621 // E5_EFFECTS16=0 && E5_EFFECTS32=1: int = s->effects
622 // E5_EFFECTS16=1 && E5_EFFECTS32=1: int = s->effects
623 #define E5_EFFECTS (1<<6)
624 // bits >= (1<<8)
625 #define E5_EXTEND1 (1<<7)
626
627 // byte = s->renderflags
628 #define E5_FLAGS (1<<8)
629 // byte = bound(0, s->alpha * 255, 255)
630 #define E5_ALPHA (1<<9)
631 // byte = bound(0, s->scale * 16, 255)
632 #define E5_SCALE (1<<10)
633 // flag
634 #define E5_ORIGIN32 (1<<11)
635 // flag
636 #define E5_ANGLES16 (1<<12)
637 // flag
638 #define E5_MODEL16 (1<<13)
639 // byte = s->colormap
640 #define E5_COLORMAP (1<<14)
641 // bits >= (1<<16)
642 #define E5_EXTEND2 (1<<15)
643
644 // short = s->tagentity
645 // byte = s->tagindex
646 #define E5_ATTACHMENT (1<<16)
647 // short[4] = s->light[0], s->light[1], s->light[2], s->light[3]
648 // byte = s->lightstyle
649 // byte = s->lightpflags
650 #define E5_LIGHT (1<<17)
651 // byte = s->glowsize
652 // byte = s->glowcolor
653 #define E5_GLOW (1<<18)
654 // short = s->effects
655 #define E5_EFFECTS16 (1<<19)
656 // int = s->effects
657 #define E5_EFFECTS32 (1<<20)
658 // flag
659 #define E5_FRAME16 (1<<21)
660 // byte[3] = s->colormod[0], s->colormod[1], s->colormod[2]
661 #define E5_COLORMOD (1<<22)
662 // bits >= (1<<24)
663 #define E5_EXTEND3 (1<<23)
664
665 // unused
666 #define E5_UNUSED24 (1<<24)
667 // unused
668 #define E5_UNUSED25 (1<<25)
669 // unused
670 #define E5_UNUSED26 (1<<26)
671 // unused
672 #define E5_UNUSED27 (1<<27)
673 // unused
674 #define E5_UNUSED28 (1<<28)
675 // unused
676 #define E5_UNUSED29 (1<<29)
677 // unused
678 #define E5_UNUSED30 (1<<30)
679 // bits2 > 0
680 #define E5_EXTEND4 (1<<31)
681
682 #define ENTITYFRAME5_MAXPACKETLOGS 64
683 #define ENTITYFRAME5_MAXSTATES 1024
684
685 typedef struct entityframe5_changestate_s
686 {
687         unsigned int number;
688         unsigned int bits;
689 }
690 entityframe5_changestate_t;
691
692 typedef struct entityframe5_packetlog_s
693 {
694         int packetnumber;
695         int numstates;
696         entityframe5_changestate_t states[ENTITYFRAME5_MAXSTATES];
697         qbyte statsdeltabits[(MAX_CL_STATS+7)/8];
698 }
699 entityframe5_packetlog_t;
700
701 typedef struct entityframe5_database_s
702 {
703         // number of the latest message sent to client
704         int latestframenum;
705         // updated by WriteFrame for internal use
706         int viewentnum;
707
708         // logs of all recently sent messages (between acked and latest)
709         entityframe5_packetlog_t packetlog[ENTITYFRAME5_MAXPACKETLOGS];
710
711         // this goes up as needed and causes all the arrays to be reallocated
712         int maxedicts;
713
714         // which properties of each entity have changed since last send
715         int *deltabits; // [maxedicts]
716         // priorities of entities (updated whenever deltabits change)
717         // (derived from deltabits)
718         qbyte *priorities; // [maxedicts]
719         // last frame this entity was sent on, for prioritzation
720         int *updateframenum; // [maxedicts]
721
722         // database of current status of all entities
723         entity_state_t *states; // [maxedicts]
724         // which entities are currently active
725         // (duplicate of the active bit of every state in states[])
726         // (derived from states)
727         qbyte *visiblebits; // [(maxedicts+7)/8]
728
729         // delta compression of stats
730         qbyte statsdeltabits[(MAX_CL_STATS+7)/8];
731         int stats[MAX_CL_STATS];
732
733         // old notes
734
735         // this is used to decide which changestates to set each frame
736         //int numvisiblestates;
737         //entity_state_t visiblestates[MAX_EDICTS];
738
739         // sorted changing states that need to be sent to the client
740         // kept sorted in lowest to highest priority order, because this allows
741         // the numchangestates to simply be decremented whenever an state is sent,
742         // rather than a memmove to remove them from the start.
743         //int numchangestates;
744         //entityframe5_changestate_t changestates[MAX_EDICTS];
745 }
746 entityframe5_database_t;
747
748 entityframe5_database_t *EntityFrame5_AllocDatabase(mempool_t *pool);
749 void EntityFrame5_FreeDatabase(entityframe5_database_t *d);
750 void EntityFrame5_ResetDatabase(entityframe5_database_t *d);
751 void EntityState5_WriteUpdate(int number, const entity_state_t *s, int changedbits, sizebuf_t *msg);
752 int EntityState5_DeltaBitsForState(entity_state_t *o, entity_state_t *n);
753 void EntityFrame5_CL_ReadFrame(void);
754 void EntityFrame5_LostFrame(entityframe5_database_t *d, int framenum);
755 void EntityFrame5_AckFrame(entityframe5_database_t *d, int framenum);
756 void EntityFrame5_WriteFrame(sizebuf_t *msg, entityframe5_database_t *d, int numstates, const entity_state_t *states, int viewentnum, int *stats, int movesequence);
757
758 extern cvar_t developer_networkentities;
759
760 #endif
761