optimized AngleVectors calls (pass NULL for vectors that should not be generated)
[divverent/darkplaces.git] / protocol.h
1 /*
2 Copyright (C) 1996-1997 Id Software, Inc.
3
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  
12
13 See the GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18
19 */
20 // protocol.h -- communications protocols
21
22 #define PROTOCOL_VERSION        15
23 #define DPPROTOCOL_VERSION      96
24
25 // model effects
26 #define EF_ROCKET       1                       // leave a trail
27 #define EF_GRENADE      2                       // leave a trail
28 #define EF_GIB          4                       // leave a trail
29 #define EF_ROTATE       8                       // rotate (bonus items)
30 #define EF_TRACER       16                      // green split trail
31 #define EF_ZOMGIB       32                      // small blood trail
32 #define EF_TRACER2      64                      // orange split trail + rotate
33 #define EF_TRACER3      128                     // purple trail
34 // entity effects
35 #define EF_BRIGHTFIELD                  1
36 #define EF_MUZZLEFLASH                  2
37 #define EF_BRIGHTLIGHT                  4
38 #define EF_DIMLIGHT                     8
39 #define EF_NODRAW                               16
40 #define EF_ADDITIVE                             32
41 #define EF_BLUE                                 64
42 #define EF_RED                                  128
43 #define EF_DELTA                                8388608 // LordHavoc: entity is delta compressed to save network bandwidth
44 // effects/model (can be used as model flags or entity effects)
45 #define EF_REFLECTIVE                   256             // LordHavoc: shiny metal objects :)
46 #define EF_FULLBRIGHT                   512             // LordHavoc: fullbright
47 #define EF_FLAME                                1024    // LordHavoc: on fire
48
49 // if the high bit of the servercmd is set, the low bits are fast update flags:
50 #define U_MOREBITS      (1<<0)
51 #define U_ORIGIN1       (1<<1)
52 #define U_ORIGIN2       (1<<2)
53 #define U_ORIGIN3       (1<<3)
54 #define U_ANGLE2        (1<<4)
55 // LordHavoc: U_NOLERP was only ever used for monsters, so I renamed it U_STEP
56 #define U_STEP          (1<<5)
57 #define U_FRAME         (1<<6)
58 // just differentiates from other updates
59 #define U_SIGNAL        (1<<7)
60
61 // svc_update can pass all of the fast update bits, plus more
62 #define U_ANGLE1        (1<<8)
63 #define U_ANGLE3        (1<<9)
64 #define U_MODEL         (1<<10)
65 #define U_COLORMAP      (1<<11)
66 #define U_SKIN          (1<<12)
67 #define U_EFFECTS       (1<<13)
68 #define U_LONGENTITY    (1<<14)
69
70 // LordHavoc: protocol extension
71 #define U_EXTEND1       (1<<15)
72 // LordHavoc: first extend byte
73 #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)
74 #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)
75 #define U_SCALE         (1<<18) // 1 byte, scale / 16 positive, not sent if 1.0
76 #define U_EFFECTS2      (1<<19) // 1 byte, this is .effects & 0xFF00 (second byte)
77 #define U_GLOWSIZE      (1<<20) // 1 byte, encoding is float/8.0, signed (negative is darklight), not sent if 0
78 #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)
79 #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...
80 #define U_EXTEND2       (1<<23) // another byte to follow
81 // LordHavoc: second extend byte
82 #define U_GLOWTRAIL     (1<<24) // leaves a trail of particles (of color .glowcolor, or black if it is a negative glowsize)
83 #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
84 #define U_FRAME2        (1<<26) // 1 byte, this is .frame & 0xFF00 (second byte)
85 #define U_MODEL2        (1<<27) // 1 byte, this is .modelindex & 0xFF00 (second byte)
86 #define U_UNUSED28      (1<<28) // future expansion
87 #define U_UNUSED29      (1<<29) // future expansion
88 #define U_UNUSED30      (1<<30) // future expansion
89 #define U_EXTEND3       (1<<31) // another byte to follow, future expansion
90
91 #define SU_VIEWHEIGHT   (1<<0)
92 #define SU_IDEALPITCH   (1<<1)
93 #define SU_PUNCH1               (1<<2)
94 #define SU_PUNCH2               (1<<3)
95 #define SU_PUNCH3               (1<<4)
96 #define SU_VELOCITY1    (1<<5)
97 #define SU_VELOCITY2    (1<<6)
98 #define SU_VELOCITY3    (1<<7)
99 //define        SU_AIMENT               (1<<8)  AVAILABLE BIT
100 #define SU_ITEMS                (1<<9)
101 #define SU_ONGROUND             (1<<10)         // no data follows, the bit is it
102 #define SU_INWATER              (1<<11)         // no data follows, the bit is it
103 #define SU_WEAPONFRAME  (1<<12)
104 #define SU_ARMOR                (1<<13)
105 #define SU_WEAPON               (1<<14)
106 #define SU_EXTEND1              (1<<15)
107 // first extend byte
108 #define SU_PUNCHVEC1    (1<<16)
109 #define SU_PUNCHVEC2    (1<<17)
110 #define SU_PUNCHVEC3    (1<<18)
111 #define SU_UNUSED19             (1<<19)
112 #define SU_UNUSED20             (1<<20)
113 #define SU_UNUSED21             (1<<21)
114 #define SU_UNUSED22             (1<<22)
115 #define SU_EXTEND2              (1<<23) // another byte to follow, future expansion
116 // second extend byte
117 #define SU_UNUSED24             (1<<24)
118 #define SU_UNUSED25             (1<<25)
119 #define SU_UNUSED26             (1<<26)
120 #define SU_UNUSED27             (1<<27)
121 #define SU_UNUSED28             (1<<28)
122 #define SU_UNUSED29             (1<<29)
123 #define SU_UNUSED30             (1<<30)
124 #define SU_EXTEND3              (1<<31) // another byte to follow, future expansion
125
126 // a sound with no channel is a local only sound
127 #define SND_VOLUME              (1<<0)          // a byte
128 #define SND_ATTENUATION (1<<1)          // a byte
129 #define SND_LOOPING             (1<<2)          // a long
130
131
132 // defaults for clientinfo messages
133 #define DEFAULT_VIEWHEIGHT      22
134
135
136 // game types sent by serverinfo
137 // these determine which intermission screen plays
138 #define GAME_COOP                       0
139 #define GAME_DEATHMATCH         1
140
141 //==================
142 // note that there are some defs.qc that mirror to these numbers
143 // also related to svc_strings[] in cl_parse
144 //==================
145
146 //
147 // server to client
148 //
149 #define svc_bad                         0
150 #define svc_nop                         1
151 #define svc_disconnect          2
152 #define svc_updatestat          3       // [byte] [long]
153 #define svc_version                     4       // [long] server version
154 #define svc_setview                     5       // [short] entity number
155 #define svc_sound                       6       // <see code>
156 #define svc_time                        7       // [float] server time
157 #define svc_print                       8       // [string] null terminated string
158 #define svc_stufftext           9       // [string] stuffed into client's console buffer
159                                                                 // the string should be \n terminated
160 #define svc_setangle            10      // [angle3] set the view angle to this absolute value
161         
162 #define svc_serverinfo          11      // [long] version
163                                                 // [string] signon string
164                                                 // [string]..[0]model cache
165                                                 // [string]...[0]sounds cache
166 #define svc_lightstyle          12      // [byte] [string]
167 #define svc_updatename          13      // [byte] [string]
168 #define svc_updatefrags         14      // [byte] [short]
169 #define svc_clientdata          15      // <shortbits + data>
170 #define svc_stopsound           16      // <see code>
171 #define svc_updatecolors        17      // [byte] [byte]
172 #define svc_particle            18      // [vec3] <variable>
173 #define svc_damage                      19
174         
175 #define svc_spawnstatic         20
176 //      svc_spawnbinary         21
177 #define svc_spawnbaseline       22
178         
179 #define svc_temp_entity         23
180
181 #define svc_setpause            24      // [byte] on / off
182 #define svc_signonnum           25      // [byte]  used for the signon sequence
183
184 #define svc_centerprint         26      // [string] to put in center of the screen
185
186 #define svc_killedmonster       27
187 #define svc_foundsecret         28
188
189 #define svc_spawnstaticsound    29      // [coord3] [byte] samp [byte] vol [byte] aten
190
191 #define svc_intermission        30              // [string] music
192 #define svc_finale                      31              // [string] music [string] text
193
194 #define svc_cdtrack                     32              // [byte] track [byte] looptrack
195 #define svc_sellscreen          33
196
197 #define svc_cutscene            34
198
199 #define svc_showlmp                     35              // [string] slotname [string] lmpfilename [short] x [short] y
200 #define svc_hidelmp                     36              // [string] slotname
201
202 #define svc_unused1
203 #define svc_fog                         51              // unfinished
204 #define svc_effect                      52              // [vector] org [byte] modelindex [byte] startframe [byte] framecount [byte] framerate
205 #define svc_effect2                     53              // [vector] org [short] modelindex [byte] startframe [byte] framecount [byte] framerate
206 #define svc_sound2                      54              // short soundindex instead of byte
207 #define svc_spawnbaseline2      55              // short modelindex instead of byte
208 #define svc_spawnstatic2        56              // short modelindex instead of byte
209
210 //
211 // client to server
212 //
213 #define clc_bad                 0
214 #define clc_nop                 1
215 #define clc_disconnect  2
216 #define clc_move                3                       // [usercmd_t]
217 #define clc_stringcmd   4               // [string] message
218
219
220 //
221 // temp entity events
222 //
223 #define TE_SPIKE                        0 // [vector] origin
224 #define TE_SUPERSPIKE           1 // [vector] origin
225 #define TE_GUNSHOT                      2 // [vector] origin
226 #define TE_EXPLOSION            3 // [vector] origin
227 #define TE_TAREXPLOSION         4 // [vector] origin
228 #define TE_LIGHTNING1           5 // [entity] entity [vector] start [vector] end
229 #define TE_LIGHTNING2           6 // [entity] entity [vector] start [vector] end
230 #define TE_WIZSPIKE                     7 // [vector] origin
231 #define TE_KNIGHTSPIKE          8 // [vector] origin
232 #define TE_LIGHTNING3           9 // [entity] entity [vector] start [vector] end
233 #define TE_LAVASPLASH           10 // [vector] origin
234 #define TE_TELEPORT                     11 // [vector] origin
235 #define TE_EXPLOSION2           12 // [vector] origin [byte] startcolor [byte] colorcount
236
237 // PGM 01/21/97 
238 #define TE_BEAM                         13 // [entity] entity [vector] start [vector] end
239 // PGM 01/21/97 
240
241 // Nehahra effects used in the movie (TE_EXPLOSION3 also got written up in a QSG tutorial, hence it's not marked NEH)
242 #define TE_EXPLOSION3           16 // [vector] origin [coord] red [coord] green [coord] blue
243 #define TE_LIGHTNING4NEH        17 // [string] model [entity] entity [vector] start [vector] end
244
245 // LordHavoc: added some TE_ codes (block1 - 50-60)
246 #define TE_BLOOD                        50 // [vector] origin [byte] xvel [byte] yvel [byte] zvel [byte] count
247 #define TE_SPARK                        51 // [vector] origin [byte] xvel [byte] yvel [byte] zvel [byte] count
248 #define TE_BLOODSHOWER          52 // [vector] min [vector] max [coord] explosionspeed [short] count
249 #define TE_EXPLOSIONRGB         53 // [vector] origin [byte] red [byte] green [byte] blue
250 #define TE_PARTICLECUBE         54 // [vector] min [vector] max [vector] dir [short] count [byte] color [byte] gravity [coord] randomvel
251 #define TE_PARTICLERAIN         55 // [vector] min [vector] max [vector] dir [short] count [byte] color
252 #define TE_PARTICLESNOW         56 // [vector] min [vector] max [vector] dir [short] count [byte] color
253 #define TE_GUNSHOTQUAD          57 // [vector] origin
254 #define TE_SPIKEQUAD            58 // [vector] origin
255 #define TE_SUPERSPIKEQUAD       59 // [vector] origin
256 // LordHavoc: block2 - 70-80
257 #define TE_EXPLOSIONQUAD        70 // [vector] origin
258 #define TE_BLOOD2                       71 // [vector] origin
259 #define TE_SMALLFLASH           72 // [vector] origin
260 #define TE_CUSTOMFLASH          73 // [vector] origin [byte] radius / 8 - 1 [byte] lifetime / 256 - 1 [byte] red [byte] green [byte] blue
261 #define TE_FLAMEJET                     74 // [vector] origin [vector] velocity [byte] count