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