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