network CSQC and network entities separately (should prevent bugs when an entity...
[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                 2097152         // 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 typedef enum entity_state_active_e
341 {
342         ACTIVE_NOT = 0,
343         ACTIVE_NETWORK = 1,
344         ACTIVE_SHARED = 2
345 }
346 entity_state_active_t;
347
348 // this is 96 bytes
349 typedef struct entity_state_s
350 {
351         // ! means this is not sent to client
352         double time; // ! time this state was built (used on client for interpolation)
353         float netcenter[3]; // ! for network prioritization, this is the center of the bounding box (which may differ from the origin)
354         float origin[3];
355         float angles[3];
356         int effects;
357         unsigned int customizeentityforclient; // !
358         unsigned short number; // entity number this state is for
359         unsigned short modelindex;
360         unsigned short frame;
361         unsigned short tagentity;
362         unsigned short specialvisibilityradius; // ! larger if it has effects/light
363         unsigned short viewmodelforclient; // !
364         unsigned short exteriormodelforclient; // ! not shown if first person viewing from this entity, shown in all other cases
365         unsigned short nodrawtoclient; // !
366         unsigned short drawonlytoclient; // !
367         unsigned short light[4]; // color*256 (0.00 to 255.996), and radius*1
368         unsigned char active; // true if a valid state
369         unsigned char lightstyle;
370         unsigned char lightpflags;
371         unsigned char colormap;
372         unsigned char skin; // also chooses cubemap for rtlights if lightpflags & LIGHTPFLAGS_FULLDYNAMIC
373         unsigned char alpha;
374         unsigned char scale;
375         unsigned char glowsize;
376         unsigned char glowcolor;
377         unsigned char flags;
378         unsigned char internaleffects; // INTEF_FLAG1QW and so on
379         unsigned char tagindex;
380         unsigned char colormod[3];
381         // padding to a multiple of 8 bytes (to align the double time)
382         unsigned char unused[5];
383 }
384 entity_state_t;
385
386 // baseline state values
387 extern entity_state_t defaultstate;
388 // reads a quake entity from the network stream
389 void EntityFrameQuake_ReadEntity(int bits);
390 // checks for stats changes and sets corresponding host_client->statsdeltabits
391 // (also updates host_client->stats array)
392 void Protocol_UpdateClientStats(const int *stats);
393 // writes reliable messages updating stats (not used by DP6 and later
394 // protocols which send updates in their WriteFrame function using a different
395 // method of reliable messaging)
396 void Protocol_WriteStatsReliable(void);
397 // writes a list of quake entities to the network stream
398 // (or as many will fit)
399 qboolean EntityFrameQuake_WriteFrame(sizebuf_t *msg, int maxsize, int numstates, const entity_state_t *states);
400 // cleans up dead entities each frame after ReadEntity (which doesn't clear unused entities)
401 void EntityFrameQuake_ISeeDeadEntities(void);
402
403 /*
404 PROTOCOL_DARKPLACES3
405 server updates entities according to some (unmentioned) scheme.
406
407 a frame consists of all visible entities, some of which are up to date,
408 often some are not up to date.
409
410 these entities are stored in a range (firstentity/endentity) of structs in the
411 entitydata[] buffer.
412
413 to make a commit the server performs these steps:
414 1. duplicate oldest frame in database (this is the baseline) as new frame, and
415    write frame numbers (oldest frame's number, new frame's number) and eye
416    location to network packet (eye location is obsolete and will be removed in
417    future revisions)
418 2. write an entity change to packet and modify new frame accordingly
419    (this repeats until packet is sufficiently full or new frame is complete)
420 3. write terminator (0xFFFF) to network packet
421    (FIXME: this terminator value conflicts with MAX_EDICTS 32768...)
422
423 to read a commit the client performs these steps:
424 1. reads frame numbers from packet and duplicates baseline frame as new frame,
425    also reads eye location but does nothing with it (obsolete).
426 2. delete frames older than the baseline which was used
427 3. read entity changes from packet until terminator (0xFFFF) is encountered,
428    each change is applied to entity frame.
429 4. sends ack framenumber to server as part of input packet
430
431 if server receives ack message in put packet it performs these steps:
432 1. remove all older frames from database.
433 */
434
435 /*
436 PROTOCOL_DARKPLACES4
437 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).
438
439 these entities are stored in a range (firstentity/endentity) of structs in the entitydata[] buffer.
440
441 to make a commit the server performs these steps:
442 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.
443
444 This documention is unfinished!
445 the Write function performs these steps:
446 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.
447 2. write differences of an entity compared to selected baseline.
448 3. add entity to entity update in database.
449 4. if there are more entities to write and packet is not full, go back to step 2.
450 5. write terminator (0xFFFF) as entity number.
451 6. return.
452
453
454
455
456
457 server updates entities in looping ranges, a frame consists of a range of visible entities (not always all visible entities),
458 */
459
460 #define MAX_ENTITY_HISTORY 64
461 #define MAX_ENTITY_DATABASE (MAX_EDICTS * 2)
462
463 // build entity data in this, to pass to entity read/write functions
464 typedef struct entity_frame_s
465 {
466         double time;
467         int framenum;
468         int numentities;
469         int firstentitynum;
470         int lastentitynum;
471         vec3_t eye;
472         entity_state_t entitydata[MAX_ENTITY_DATABASE];
473 }
474 entity_frame_t;
475
476 typedef struct entity_frameinfo_s
477 {
478         double time;
479         int framenum;
480         int firstentity; // index into entitydata, modulo MAX_ENTITY_DATABASE
481         int endentity; // index into entitydata, firstentity + numentities
482 }
483 entity_frameinfo_t;
484
485 typedef struct entityframe_database_s
486 {
487         // note: these can be far out of range, modulo with MAX_ENTITY_DATABASE to get a valid range (which may wrap)
488         // start and end of used area, when adding a new update to database, store at endpos, and increment endpos
489         // when removing updates from database, nudge down frames array to only contain useful frames
490         // this logic should explain better:
491         // if (numframes >= MAX_ENTITY_HISTORY || (frames[numframes - 1].endentity - frames[0].firstentity) + entitiestoadd > MAX_ENTITY_DATABASE)
492         //     flushdatabase();
493         // note: if numframes == 0, insert at start (0 in entitydata)
494         // the only reason this system is used is to avoid copying memory when frames are removed
495         int numframes;
496         // server only: last sent frame
497         int latestframenum;
498         // server only: last acknowledged frame
499         int ackframenum;
500         // the current state in the database
501         vec3_t eye;
502         // table of entities in the entityhistorydata
503         entity_frameinfo_t frames[MAX_ENTITY_HISTORY];
504         // entities
505         entity_state_t entitydata[MAX_ENTITY_DATABASE];
506
507         // structs for building new frames and reading them
508         entity_frame_t deltaframe;
509         entity_frame_t framedata;
510 }
511 entityframe_database_t;
512
513 // LordHavoc: these are in approximately sorted order, according to cost and
514 // likelyhood of being used for numerous objects in a frame
515
516 // note that the bytes are not written/read in this order, this is only the
517 // order of the bits to minimize overhead from extend bytes
518
519 // enough to describe a nail, gib, shell casing, bullet hole, or rocket
520 #define E_ORIGIN1               (1<<0)
521 #define E_ORIGIN2               (1<<1)
522 #define E_ORIGIN3               (1<<2)
523 #define E_ANGLE1                (1<<3)
524 #define E_ANGLE2                (1<<4)
525 #define E_ANGLE3                (1<<5)
526 #define E_MODEL1                (1<<6)
527 #define E_EXTEND1               (1<<7)
528
529 // enough to describe almost anything
530 #define E_FRAME1                (1<<8)
531 #define E_EFFECTS1              (1<<9)
532 #define E_ALPHA                 (1<<10)
533 #define E_SCALE                 (1<<11)
534 #define E_COLORMAP              (1<<12)
535 #define E_SKIN                  (1<<13)
536 #define E_FLAGS                 (1<<14)
537 #define E_EXTEND2               (1<<15)
538
539 // players, custom color glows, high model numbers
540 #define E_FRAME2                (1<<16)
541 #define E_MODEL2                (1<<17)
542 #define E_EFFECTS2              (1<<18)
543 #define E_GLOWSIZE              (1<<19)
544 #define E_GLOWCOLOR             (1<<20)
545 #define E_LIGHT                 (1<<21)
546 #define E_LIGHTPFLAGS   (1<<22)
547 #define E_EXTEND3               (1<<23)
548
549 #define E_SOUND1                (1<<24)
550 #define E_SOUNDVOL              (1<<25)
551 #define E_SOUNDATTEN    (1<<26)
552 #define E_TAGATTACHMENT (1<<27)
553 #define E_LIGHTSTYLE    (1<<28)
554 #define E_UNUSED6               (1<<29)
555 #define E_UNUSED7               (1<<30)
556 #define E_EXTEND4               (1<<31)
557
558 // returns difference between two states as E_ flags
559 int EntityState_DeltaBits(const entity_state_t *o, const entity_state_t *n);
560 // write E_ flags to a msg
561 void EntityState_WriteExtendBits(sizebuf_t *msg, unsigned int bits);
562 // write values for the E_ flagged fields to a msg
563 void EntityState_WriteFields(const entity_state_t *ent, sizebuf_t *msg, unsigned int bits);
564 // write entity number and E_ flags and their values, or a remove number, describing the change from delta to ent
565 void EntityState_WriteUpdate(const entity_state_t *ent, sizebuf_t *msg, const entity_state_t *delta);
566 // read E_ flags
567 int EntityState_ReadExtendBits(void);
568 // read values for E_ flagged fields and apply them to a state
569 void EntityState_ReadFields(entity_state_t *e, unsigned int bits);
570
571 // (client and server) allocates a new empty database
572 entityframe_database_t *EntityFrame_AllocDatabase(mempool_t *mempool);
573 // (client and server) frees the database
574 void EntityFrame_FreeDatabase(entityframe_database_t *d);
575 // (server) clears the database to contain no frames (thus delta compression
576 // compresses against nothing)
577 void EntityFrame_ClearDatabase(entityframe_database_t *d);
578 // (server and client) removes frames older than 'frame' from database
579 void EntityFrame_AckFrame(entityframe_database_t *d, int frame);
580 // (server) clears frame, to prepare for adding entities
581 void EntityFrame_Clear(entity_frame_t *f, vec3_t eye, int framenum);
582 // (server and client) reads a frame from the database
583 void EntityFrame_FetchFrame(entityframe_database_t *d, int framenum, entity_frame_t *f);
584 // (server and client) adds a entity_frame to the database, for future
585 // reference
586 void EntityFrame_AddFrame(entityframe_database_t *d, vec3_t eye, int framenum, int numentities, const entity_state_t *entitydata);
587 // (server) writes a frame to network stream
588 qboolean EntityFrame_WriteFrame(sizebuf_t *msg, int maxsize, entityframe_database_t *d, int numstates, const entity_state_t *states, int viewentnum);
589 // (client) reads a frame from network stream
590 void EntityFrame_CL_ReadFrame(void);
591 // (client) returns the frame number of the most recent frame recieved
592 int EntityFrame_MostRecentlyRecievedFrameNum(entityframe_database_t *d);
593
594 typedef struct entity_database4_commit_s
595 {
596         // frame number this commit represents
597         int framenum;
598         // number of entities in entity[] array
599         int numentities;
600         // maximum number of entities in entity[] array (dynamic resizing)
601         int maxentities;
602         entity_state_t *entity;
603 }
604 entity_database4_commit_t;
605
606 typedef struct entity_database4_s
607 {
608         // what mempool to use for allocations
609         mempool_t *mempool;
610         // reference frame
611         int referenceframenum;
612         // reference entities array is resized according to demand
613         int maxreferenceentities;
614         // array of states for entities, these are indexable by their entity number (yes there are gaps)
615         entity_state_t *referenceentity;
616         // commits waiting to be applied to the reference database when confirmed
617         // (commit[i]->numentities == 0 means it is empty)
618         entity_database4_commit_t commit[MAX_ENTITY_HISTORY];
619         // (server only) the current commit being worked on
620         entity_database4_commit_t *currentcommit;
621         // (server only) if a commit won't fit entirely, continue where it left
622         // off next frame
623         int currententitynumber;
624         // (server only)
625         int latestframenumber;
626 }
627 entityframe4_database_t;
628
629 // should-be-private functions that aren't
630 entity_state_t *EntityFrame4_GetReferenceEntity(entityframe4_database_t *d, int number);
631 void EntityFrame4_AddCommitEntity(entityframe4_database_t *d, const entity_state_t *s);
632
633 // allocate a database
634 entityframe4_database_t *EntityFrame4_AllocDatabase(mempool_t *pool);
635 // free a database
636 void EntityFrame4_FreeDatabase(entityframe4_database_t *d);
637 // reset a database (resets compression but does not reallocate anything)
638 void EntityFrame4_ResetDatabase(entityframe4_database_t *d);
639 // updates database to account for a frame-received acknowledgment
640 int EntityFrame4_AckFrame(entityframe4_database_t *d, int framenum, int servermode);
641 // writes a frame to the network stream
642 qboolean EntityFrame4_WriteFrame(sizebuf_t *msg, int maxsize, entityframe4_database_t *d, int numstates, const entity_state_t *states);
643 // reads a frame from the network stream
644 void EntityFrame4_CL_ReadFrame(void);
645
646 // reset all entity fields (typically used if status changed)
647 #define E5_FULLUPDATE (1<<0)
648 // E5_ORIGIN32=0: short[3] = s->origin[0] * 8, s->origin[1] * 8, s->origin[2] * 8
649 // E5_ORIGIN32=1: float[3] = s->origin[0], s->origin[1], s->origin[2]
650 #define E5_ORIGIN (1<<1)
651 // E5_ANGLES16=0: byte[3] = s->angle[0] * 256 / 360, s->angle[1] * 256 / 360, s->angle[2] * 256 / 360
652 // E5_ANGLES16=1: short[3] = s->angle[0] * 65536 / 360, s->angle[1] * 65536 / 360, s->angle[2] * 65536 / 360
653 #define E5_ANGLES (1<<2)
654 // E5_MODEL16=0: byte = s->modelindex
655 // E5_MODEL16=1: short = s->modelindex
656 #define E5_MODEL (1<<3)
657 // E5_FRAME16=0: byte = s->frame
658 // E5_FRAME16=1: short = s->frame
659 #define E5_FRAME (1<<4)
660 // byte = s->skin
661 #define E5_SKIN (1<<5)
662 // E5_EFFECTS16=0 && E5_EFFECTS32=0: byte = s->effects
663 // E5_EFFECTS16=1 && E5_EFFECTS32=0: short = s->effects
664 // E5_EFFECTS16=0 && E5_EFFECTS32=1: int = s->effects
665 // E5_EFFECTS16=1 && E5_EFFECTS32=1: int = s->effects
666 #define E5_EFFECTS (1<<6)
667 // bits >= (1<<8)
668 #define E5_EXTEND1 (1<<7)
669
670 // byte = s->renderflags
671 #define E5_FLAGS (1<<8)
672 // byte = bound(0, s->alpha * 255, 255)
673 #define E5_ALPHA (1<<9)
674 // byte = bound(0, s->scale * 16, 255)
675 #define E5_SCALE (1<<10)
676 // flag
677 #define E5_ORIGIN32 (1<<11)
678 // flag
679 #define E5_ANGLES16 (1<<12)
680 // flag
681 #define E5_MODEL16 (1<<13)
682 // byte = s->colormap
683 #define E5_COLORMAP (1<<14)
684 // bits >= (1<<16)
685 #define E5_EXTEND2 (1<<15)
686
687 // short = s->tagentity
688 // byte = s->tagindex
689 #define E5_ATTACHMENT (1<<16)
690 // short[4] = s->light[0], s->light[1], s->light[2], s->light[3]
691 // byte = s->lightstyle
692 // byte = s->lightpflags
693 #define E5_LIGHT (1<<17)
694 // byte = s->glowsize
695 // byte = s->glowcolor
696 #define E5_GLOW (1<<18)
697 // short = s->effects
698 #define E5_EFFECTS16 (1<<19)
699 // int = s->effects
700 #define E5_EFFECTS32 (1<<20)
701 // flag
702 #define E5_FRAME16 (1<<21)
703 // byte[3] = s->colormod[0], s->colormod[1], s->colormod[2]
704 #define E5_COLORMOD (1<<22)
705 // bits >= (1<<24)
706 #define E5_EXTEND3 (1<<23)
707
708 // unused
709 #define E5_UNUSED24 (1<<24)
710 // unused
711 #define E5_UNUSED25 (1<<25)
712 // unused
713 #define E5_UNUSED26 (1<<26)
714 // unused
715 #define E5_UNUSED27 (1<<27)
716 // unused
717 #define E5_UNUSED28 (1<<28)
718 // unused
719 #define E5_UNUSED29 (1<<29)
720 // unused
721 #define E5_UNUSED30 (1<<30)
722 // bits2 > 0
723 #define E5_EXTEND4 (1<<31)
724
725 #define ENTITYFRAME5_MAXPACKETLOGS 64
726 #define ENTITYFRAME5_MAXSTATES 1024
727 #define ENTITYFRAME5_PRIORITYLEVELS 32
728
729 typedef struct entityframe5_changestate_s
730 {
731         unsigned int number;
732         unsigned int bits;
733 }
734 entityframe5_changestate_t;
735
736 typedef struct entityframe5_packetlog_s
737 {
738         int packetnumber;
739         int numstates;
740         entityframe5_changestate_t states[ENTITYFRAME5_MAXSTATES];
741         unsigned char statsdeltabits[(MAX_CL_STATS+7)/8];
742 }
743 entityframe5_packetlog_t;
744
745 typedef struct entityframe5_database_s
746 {
747         // number of the latest message sent to client
748         int latestframenum;
749         // updated by WriteFrame for internal use
750         int viewentnum;
751
752         // logs of all recently sent messages (between acked and latest)
753         entityframe5_packetlog_t packetlog[ENTITYFRAME5_MAXPACKETLOGS];
754
755         // this goes up as needed and causes all the arrays to be reallocated
756         int maxedicts;
757
758         // which properties of each entity have changed since last send
759         int *deltabits; // [maxedicts]
760         // priorities of entities (updated whenever deltabits change)
761         // (derived from deltabits)
762         unsigned char *priorities; // [maxedicts]
763         // last frame this entity was sent on, for prioritzation
764         int *updateframenum; // [maxedicts]
765
766         // database of current status of all entities
767         entity_state_t *states; // [maxedicts]
768         // which entities are currently active
769         // (duplicate of the active bit of every state in states[])
770         // (derived from states)
771         unsigned char *visiblebits; // [(maxedicts+7)/8]
772
773         // old notes
774
775         // this is used to decide which changestates to set each frame
776         //int numvisiblestates;
777         //entity_state_t visiblestates[MAX_EDICTS];
778
779         // sorted changing states that need to be sent to the client
780         // kept sorted in lowest to highest priority order, because this allows
781         // the numchangestates to simply be decremented whenever an state is sent,
782         // rather than a memmove to remove them from the start.
783         //int numchangestates;
784         //entityframe5_changestate_t changestates[MAX_EDICTS];
785
786         // buffers for building priority info
787         int prioritychaincounts[ENTITYFRAME5_PRIORITYLEVELS];
788         unsigned short prioritychains[ENTITYFRAME5_PRIORITYLEVELS][ENTITYFRAME5_MAXSTATES];
789 }
790 entityframe5_database_t;
791
792 entityframe5_database_t *EntityFrame5_AllocDatabase(mempool_t *pool);
793 void EntityFrame5_FreeDatabase(entityframe5_database_t *d);
794 void EntityState5_WriteUpdate(int number, const entity_state_t *s, int changedbits, sizebuf_t *msg);
795 int EntityState5_DeltaBitsForState(entity_state_t *o, entity_state_t *n);
796 void EntityFrame5_CL_ReadFrame(void);
797 void EntityFrame5_LostFrame(entityframe5_database_t *d, int framenum);
798 void EntityFrame5_AckFrame(entityframe5_database_t *d, int framenum);
799 qboolean 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);
800
801 extern cvar_t developer_networkentities;
802
803 // QUAKEWORLD
804 // server to client
805 #define qw_svc_bad                              0
806 #define qw_svc_nop                              1
807 #define qw_svc_disconnect               2
808 #define qw_svc_updatestat               3       // [byte] [byte]
809 #define qw_svc_setview                  5       // [short] entity number
810 #define qw_svc_sound                    6       // <see code>
811 #define qw_svc_print                    8       // [byte] id [string] null terminated string
812 #define qw_svc_stufftext                9       // [string] stuffed into client's console buffer
813 #define qw_svc_setangle                 10      // [angle3] set the view angle to this absolute value
814 #define qw_svc_serverdata               11      // [long] protocol ...
815 #define qw_svc_lightstyle               12      // [byte] [string]
816 #define qw_svc_updatefrags              14      // [byte] [short]
817 #define qw_svc_stopsound                16      // <see code>
818 #define qw_svc_damage                   19
819 #define qw_svc_spawnstatic              20
820 #define qw_svc_spawnbaseline    22
821 #define qw_svc_temp_entity              23      // variable
822 #define qw_svc_setpause                 24      // [byte] on / off
823 #define qw_svc_centerprint              26      // [string] to put in center of the screen
824 #define qw_svc_killedmonster    27
825 #define qw_svc_foundsecret              28
826 #define qw_svc_spawnstaticsound 29      // [coord3] [byte] samp [byte] vol [byte] aten
827 #define qw_svc_intermission             30              // [vec3_t] origin [vec3_t] angle
828 #define qw_svc_finale                   31              // [string] text
829 #define qw_svc_cdtrack                  32              // [byte] track
830 #define qw_svc_sellscreen               33
831 #define qw_svc_smallkick                34              // set client punchangle to 2
832 #define qw_svc_bigkick                  35              // set client punchangle to 4
833 #define qw_svc_updateping               36              // [byte] [short]
834 #define qw_svc_updateentertime  37              // [byte] [float]
835 #define qw_svc_updatestatlong   38              // [byte] [long]
836 #define qw_svc_muzzleflash              39              // [short] entity
837 #define qw_svc_updateuserinfo   40              // [byte] slot [long] uid
838 #define qw_svc_download                 41              // [short] size [size bytes]
839 #define qw_svc_playerinfo               42              // variable
840 #define qw_svc_nails                    43              // [byte] num [48 bits] xyzpy 12 12 12 4 8
841 #define qw_svc_chokecount               44              // [byte] packets choked
842 #define qw_svc_modellist                45              // [strings]
843 #define qw_svc_soundlist                46              // [strings]
844 #define qw_svc_packetentities   47              // [...]
845 #define qw_svc_deltapacketentities      48              // [...]
846 #define qw_svc_maxspeed                 49              // maxspeed change, for prediction
847 #define qw_svc_entgravity               50              // gravity change, for prediction
848 #define qw_svc_setinfo                  51              // setinfo on a client
849 #define qw_svc_serverinfo               52              // serverinfo
850 #define qw_svc_updatepl                 53              // [byte] [byte]
851 // QUAKEWORLD
852 // client to server
853 #define qw_clc_bad                      0
854 #define qw_clc_nop                      1
855 #define qw_clc_move                     3               // [[usercmd_t]
856 #define qw_clc_stringcmd        4               // [string] message
857 #define qw_clc_delta            5               // [byte] sequence number, requests delta compression of message
858 #define qw_clc_tmove            6               // teleport request, spectator only
859 #define qw_clc_upload           7               // teleport request, spectator only
860 // QUAKEWORLD
861 // playerinfo flags from server
862 // playerinfo always sends: playernum, flags, origin[] and framenumber
863 #define QW_PF_MSEC                      (1<<0)
864 #define QW_PF_COMMAND           (1<<1)
865 #define QW_PF_VELOCITY1 (1<<2)
866 #define QW_PF_VELOCITY2 (1<<3)
867 #define QW_PF_VELOCITY3 (1<<4)
868 #define QW_PF_MODEL             (1<<5)
869 #define QW_PF_SKINNUM           (1<<6)
870 #define QW_PF_EFFECTS           (1<<7)
871 #define QW_PF_WEAPONFRAME       (1<<8)          // only sent for view player
872 #define QW_PF_DEAD                      (1<<9)          // don't block movement any more
873 #define QW_PF_GIB                       (1<<10)         // offset the view height differently
874 #define QW_PF_NOGRAV            (1<<11)         // don't apply gravity for prediction
875 // QUAKEWORLD
876 // if the high bit of the client to server byte is set, the low bits are
877 // client move cmd bits
878 // ms and angle2 are allways sent, the others are optional
879 #define QW_CM_ANGLE1    (1<<0)
880 #define QW_CM_ANGLE3    (1<<1)
881 #define QW_CM_FORWARD   (1<<2)
882 #define QW_CM_SIDE              (1<<3)
883 #define QW_CM_UP                (1<<4)
884 #define QW_CM_BUTTONS   (1<<5)
885 #define QW_CM_IMPULSE   (1<<6)
886 #define QW_CM_ANGLE2    (1<<7)
887 // QUAKEWORLD
888 // the first 16 bits of a packetentities update holds 9 bits
889 // of entity number and 7 bits of flags
890 #define QW_U_ORIGIN1    (1<<9)
891 #define QW_U_ORIGIN2    (1<<10)
892 #define QW_U_ORIGIN3    (1<<11)
893 #define QW_U_ANGLE2             (1<<12)
894 #define QW_U_FRAME              (1<<13)
895 #define QW_U_REMOVE             (1<<14)         // REMOVE this entity, don't add it
896 #define QW_U_MOREBITS   (1<<15)
897 // if MOREBITS is set, these additional flags are read in next
898 #define QW_U_ANGLE1             (1<<0)
899 #define QW_U_ANGLE3             (1<<1)
900 #define QW_U_MODEL              (1<<2)
901 #define QW_U_COLORMAP   (1<<3)
902 #define QW_U_SKIN               (1<<4)
903 #define QW_U_EFFECTS    (1<<5)
904 #define QW_U_SOLID              (1<<6)          // the entity should be solid for prediction
905 // QUAKEWORLD
906 // temp entity events
907 #define QW_TE_SPIKE                             0
908 #define QW_TE_SUPERSPIKE                1
909 #define QW_TE_GUNSHOT                   2
910 #define QW_TE_EXPLOSION                 3
911 #define QW_TE_TAREXPLOSION              4
912 #define QW_TE_LIGHTNING1                5
913 #define QW_TE_LIGHTNING2                6
914 #define QW_TE_WIZSPIKE                  7
915 #define QW_TE_KNIGHTSPIKE               8
916 #define QW_TE_LIGHTNING3                9
917 #define QW_TE_LAVASPLASH                10
918 #define QW_TE_TELEPORT                  11
919 #define QW_TE_BLOOD                             12
920 #define QW_TE_LIGHTNINGBLOOD    13
921 // QUAKEWORLD
922 // effect flags
923 #define QW_EF_BRIGHTFIELD               1
924 #define QW_EF_MUZZLEFLASH               2
925 #define QW_EF_BRIGHTLIGHT               4
926 #define QW_EF_DIMLIGHT                  8
927 #define QW_EF_FLAG1                             16
928 #define QW_EF_FLAG2                             32
929 #define QW_EF_BLUE                              64
930 #define QW_EF_RED                               128
931
932 #define QW_UPDATE_BACKUP 64
933 #define QW_UPDATE_MASK (QW_UPDATE_BACKUP - 1)
934 #define QW_MAX_PACKET_ENTITIES 64
935
936 // note: QW stats are directly compatible with NQ
937 // (but FRAGS, WEAPONFRAME, and VIEWHEIGHT are unused)
938 // so these defines are not actually used by darkplaces, but kept for reference
939 #define QW_STAT_HEALTH                  0
940 //#define QW_STAT_FRAGS                 1
941 #define QW_STAT_WEAPON                  2
942 #define QW_STAT_AMMO                    3
943 #define QW_STAT_ARMOR                   4
944 //#define QW_STAT_WEAPONFRAME           5
945 #define QW_STAT_SHELLS                  6
946 #define QW_STAT_NAILS                   7
947 #define QW_STAT_ROCKETS                 8
948 #define QW_STAT_CELLS                   9
949 #define QW_STAT_ACTIVEWEAPON    10
950 #define QW_STAT_TOTALSECRETS    11
951 #define QW_STAT_TOTALMONSTERS   12
952 #define QW_STAT_SECRETS                 13 // bumped on client side by svc_foundsecret
953 #define QW_STAT_MONSTERS                14 // bumped by svc_killedmonster
954 #define QW_STAT_ITEMS                   15
955 //#define QW_STAT_VIEWHEIGHT            16
956
957 // build entity data in this, to pass to entity read/write functions
958 typedef struct entityframeqw_snapshot_s
959 {
960         double time;
961         qboolean invalid;
962         int num_entities;
963         entity_state_t entities[QW_MAX_PACKET_ENTITIES];
964 }
965 entityframeqw_snapshot_t;
966
967 typedef struct entityframeqw_database_s
968 {
969         entityframeqw_snapshot_t snapshot[QW_UPDATE_BACKUP];
970 }
971 entityframeqw_database_t;
972
973 entityframeqw_database_t *EntityFrameQW_AllocDatabase(mempool_t *pool);
974 void EntityFrameQW_FreeDatabase(entityframeqw_database_t *d);
975 void EntityStateQW_ReadPlayerUpdate(void);
976 void EntityFrameQW_CL_ReadFrame(qboolean delta);
977
978 struct client_s;
979 void EntityFrameCSQC_LostFrame(struct client_s *client, int framenum);
980 qboolean EntityFrameCSQC_WriteFrame (sizebuf_t *msg, int maxsize, int numnumbers, const unsigned short *numbers, int framenum);
981
982 #endif
983