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