DP_QC_GETTIME, sv_cmd time
[divverent/nexuiz.git] / data / qcsrc / server / extensions.qh
1
2 //DarkPlaces supported extension list, draft version 1.04
3
4 //things that don't have extensions yet:
5 .float disableclientprediction;
6
7 //definitions that id Software left out:
8 //these are passed as the 'nomonsters' parameter to traceline/tracebox (yes really this was supported in all quake engines, nomonsters is misnamed)
9 float MOVE_NORMAL = 0; // same as FALSE
10 float MOVE_NOMONSTERS = 1; // same as TRUE
11 float MOVE_MISSILE = 2; // save as movement with .movetype == MOVETYPE_FLYMISSILE
12
13 //checkextension function
14 //idea: expected by almost everyone
15 //darkplaces implementation: LordHavoc
16 float(string s) checkextension = #99;
17 //description:
18 //check if (cvar("pr_checkextension")) before calling this, this is the only
19 //guaranteed extension to be present in the extension system, it allows you
20 //to check if an extension is available, by name, to check for an extension
21 //use code like this:
22 //// (it is recommended this code be placed in worldspawn or a worldspawn called function somewhere)
23 //if (cvar("pr_checkextension"))
24 //if (checkextension("DP_SV_SETCOLOR"))
25 //      ext_setcolor = TRUE;
26 //from then on you can check ext_setcolor to know if that extension is available
27
28 //BX_WAL_SUPPORT
29 //idea: id Software
30 //darkplaces implementation: LordHavoc
31 //description:
32 //indicates the engine supports .wal textures for filenames in the textures/ directory
33 //(note: DarkPlaces has supported this since 2001 or 2002, but did not advertise it as an extension, then I noticed Betwix was advertising it and added the extension accordingly)
34
35 //DP_BUTTONCHAT
36 //idea: Vermeulen
37 //darkplaces implementation: LordHavoc
38 //field definitions:
39 .float buttonchat;
40 //description:
41 //true if the player is currently chatting (in messagemode, menus or console)
42
43 //DP_BUTTONUSE
44 //idea: id Software
45 //darkplaces implementation: LordHavoc
46 //field definitions:
47 .float buttonuse;
48 //client console commands:
49 //+use
50 //-use
51 //description:
52 //made +use and -use commands work, they now control the .buttonuse field (.button1 was used by many mods for other purposes).
53
54 //DP_CL_LOADSKY
55 //idea: Nehahra, LordHavoc
56 //darkplaces implementation: LordHavoc
57 //client console commands:
58 //"loadsky" (parameters: "basename", example: "mtnsun_" would load "mtnsun_up.tga" and "mtnsun_rt.tga" and similar names, use "" to revert to quake sky, note: this is the same as Quake2 skybox naming)
59 //description:
60 //sets global skybox for the map for this client (can be stuffed to a client by QC), does not hurt much to repeatedly execute this command, please don't use this in mods if it can be avoided (only if changing skybox is REALLY needed, otherwise please use DP_GFX_SKYBOX).
61
62 //DP_CON_SET
63 //idea: id Software
64 //darkplaces implementation: LordHavoc
65 //description:
66 //indicates this engine supports the "set" console command which creates or sets a non-archived cvar (not saved to config.cfg on exit), it is recommended that set and seta commands be placed in default.cfg for mod-specific cvars.
67
68 //DP_CON_SETA
69 //idea: id Software
70 //darkplaces implementation: LordHavoc
71 //description:
72 //indicates this engine supports the "seta" console command which creates or sets an archived cvar (saved to config.cfg on exit), it is recommended that set and seta commands be placed in default.cfg for mod-specific cvars.
73
74 //DP_CON_ALIASPARAMETERS
75 //idea: many
76 //darkplaces implementation: Black
77 //description:
78 //indicates this engine supports aliases containing $1 through $9 parameter macros (which when called will expand to the parameters passed to the alias, for example alias test "say $2 $1", then you can type test hi there and it will execute say there hi), as well as $0 (name of the alias) and $* (all parameters $1 onward).
79
80 //DP_CON_EXPANDCVAR
81 //idea: many, PHP
82 //darkplaces implementation: Black
83 //description:
84 //indicates this engine supports console commandlines containing $cvarname which will expand to the contents of that cvar as a parameter, for instance say my fov is $fov, will say "my fov is 90", or similar.
85
86 //DP_CON_STARTMAP
87 //idea: LordHavoc
88 //darkplaces implementation: LordHavoc
89 //description:
90 //adds two engine-called aliases named startmap_sp and startmap_dm which are called when the engine tries to start a singleplayer game from the menu (startmap_sp) or the -listen or -dedicated options are used or the engine is a dedicated server (uses startmap_dm), these allow a mod or game to specify their own map instead of start, and also distinguish between singleplayer and -listen/-dedicated, also these need not be a simple "map start" command, they can do other things if desired, startmap_sp and startmap_dm both default to "map start".
91
92 //DP_EF_ADDITIVE
93 //idea: LordHavoc
94 //darkplaces implementation: LordHavoc
95 //effects bit:
96 float   EF_ADDITIVE     = 32;
97 //description:
98 //additive blending when this object is rendered
99
100 //DP_EF_BLUE
101 //idea: id Software
102 //darkplaces implementation: LordHavoc
103 //effects bit:
104 float   EF_BLUE         = 64;
105 //description:
106 //entity emits blue light (used for quad)
107
108 //DP_EF_DOUBLESIDED
109 //idea: LordHavoc
110 //darkplaces implementation: [515] and LordHavoc
111 //effects bit:
112 float EF_DOUBLESIDED = 32768;
113 //description:
114 //render entity as double sided (backfaces are visible, I.E. you see the 'interior' of the model, rather than just the front), can be occasionally useful on transparent stuff.
115
116 //DP_EF_FLAME
117 //idea: LordHavoc
118 //darkplaces implementation: LordHavoc
119 //effects bit:
120 float   EF_FLAME        = 1024;
121 //description:
122 //entity is on fire
123
124 //DP_EF_FULLBRIGHT
125 //idea: LordHavoc
126 //darkplaces implementation: LordHavoc
127 //effects bit:
128 float   EF_FULLBRIGHT   = 512;
129 //description:
130 //entity is always brightly lit
131
132 //DP_EF_NODEPTHTEST
133 //idea: Supa
134 //darkplaces implementation: LordHavoc
135 //effects bit:
136 float   EF_NODEPTHTEST       = 8192;
137 //description:
138 //makes entity show up to client even through walls, useful with EF_ADDITIVE for special indicators like where team bases are in a map, so that people don't get lost
139
140 //DP_EF_NODRAW
141 //idea: id Software
142 //darkplaces implementation: LordHavoc
143 //effects bit:
144 float   EF_NODRAW       = 16;
145 //description:
146 //prevents server from sending entity to client (forced invisible, even if it would have been a light source or other such things)
147
148 //DP_EF_NOGUNBOB
149 //idea: Chris Page, Dresk
150 //darkplaces implementation: LordHAvoc
151 //effects bit:
152 float   EF_NOGUNBOB     = 256;
153 //description:
154 //this has different meanings depending on the entity it is used on:
155 //player entity - prevents gun bobbing on player.viewmodel
156 //viewmodelforclient entity - prevents gun bobbing on an entity attached to the player's view
157 //other entities - no effect
158 //uses:
159 //disabling gun bobbing on a diving mask or other model used as a .viewmodel.
160 //disabling gun bobbing on view-relative models meant to be part of the heads up display.  (note: if fov is changed these entities may be off-screen, or too near the center of the screen, so use fov 90 in this case)
161
162 //DP_EF_NOSHADOW
163 //idea: LordHavoc
164 //darkplaces implementation: LordHavoc
165 //effects bit:
166 float   EF_NOSHADOW     = 4096;
167 //description:
168 //realtime lights will not cast shadows from this entity (but can still illuminate it)
169
170 //DP_EF_RED
171 //idea: id Software
172 //darkplaces implementation: LordHavoc
173 //effects bit:
174 float   EF_RED          = 128;
175 //description:
176 //entity emits red light (used for invulnerability)
177
178 //DP_EF_STARDUST
179 //idea: MythWorks Inc
180 //darkplaces implementation: LordHavoc
181 //effects bit:
182 float   EF_STARDUST     = 2048;
183 //description:
184 //entity emits bouncing sparkles in every direction
185
186 //DP_EF_TELEPORT_BIT
187 //idea: id software
188 //darkplaces implementation: div0
189 //effects bit:
190 float   EF_TELEPORT_BIT = 2097152;
191 //description:
192 //when toggled, interpolation of the entity is skipped for one frame. Useful for teleporting.
193 //to toggle this bit in QC, you can do:
194 //  self.effects += (EF_TELEPORT_BIT - 2 * (self.effects & EF_TELEPORT_BIT));
195
196 //DP_ENT_ALPHA
197 //idea: Nehahra
198 //darkplaces implementation: LordHavoc
199 //fields:
200 .float alpha;
201 //description:
202 //controls opacity of the entity, 0.0 is forced to be 1.0 (otherwise everything would be invisible), use -1 if you want to make something invisible, 1.0 is solid (like normal).
203
204 //DP_ENT_COLORMOD
205 //idea: LordHavoc
206 //darkplaces implementation: LordHavoc
207 //field definition:
208 .vector colormod;
209 //description:
210 //controls color of the entity, '0 0 0', is forced to be '1 1 1' (otherwise everything would be black), used for tinting objects, for instance using '1 0.6 0.4' on an ogre would give you an orange ogre (order is red green blue), note the colors can go up to '8 8 8' (8x as bright as normal).
211
212 //DP_ENT_CUSTOMCOLORMAP
213 //idea: LordHavoc
214 //darkplaces implementation: LordHavoc
215 //description:
216 //if .colormap is set to 1024 + pants + shirt * 16, those colors will be used for colormapping the entity, rather than looking up a colormap by player number.
217
218 /*
219 //NOTE: no longer supported by darkplaces because all entities are delta compressed now
220 //DP_ENT_DELTACOMPRESS // no longer supported
221 //idea: LordHavoc
222 //darkplaces implementation: LordHavoc
223 //effects bit:
224 float EF_DELTA = 8388608;
225 //description:
226 //(obsolete) applies delta compression to the network updates of the entity, making updates smaller, this might cause some unreliable behavior in packet loss situations, so it should only be used on numerous (nails/plasma shots/etc) or unimportant objects (gibs/shell casings/bullet holes/etc).
227 */
228
229 //DP_ENT_EXTERIORMODELTOCLIENT
230 //idea: LordHavoc
231 //darkplaces implementation: LordHavoc
232 //fields:
233 .entity exteriormodeltoclient;
234 //description:
235 //the entity is visible to all clients with one exception: if the specified client is using first person view (not using chase_active) the entity will not be shown.  Also if tag attachments are supported any entities attached to the player entity will not be drawn in first person.
236
237 //DP_ENT_GLOW
238 //idea: LordHavoc
239 //darkplaces implementation: LordHavoc
240 //field definitions:
241 .float glow_color;
242 .float glow_size;
243 .float glow_trail;
244 //description:
245 //customizable glowing light effect on the entity, glow_color is a paletted (8bit) color in the range 0-255 (note: 0 and 254 are white), glow_size is 0 or higher (up to the engine what limit to cap it to, darkplaces imposes a 1020 limit), if glow_trail is true it will leave a trail of particles of the same color as the light.
246
247 //DP_ENT_LOWPRECISION
248 //idea: LordHavoc
249 //darkplaces implementation: LordHavoc
250 //effects bit:
251 float EF_LOWPRECISION = 4194304;
252 //description:
253 //uses low quality origin coordinates, reducing network traffic compared to the default high precision, intended for numerous objects (projectiles/gibs/bullet holes/etc).
254
255 //DP_ENT_SCALE
256 //idea: LordHavoc
257 //darkplaces implementation: LordHavoc
258 //field definitions:
259 .float scale;
260 //description:
261 //controls rendering scale of the object, 0 is forced to be 1, darkplaces uses 1/16th accuracy and a limit of 15.9375, can be used to make an object larger or smaller.
262
263 //DP_ENT_VIEWMODEL
264 //idea: LordHavoc
265 //darkplaces implementation: LordHavoc
266 //field definitions:
267 .entity viewmodelforclient;
268 //description:
269 //this is a very special capability, attachs the entity to the view of the client specified, origin and angles become relative to the view of that client, all effects can be used (multiple skins on a weapon model etc)...  the entity is not visible to any other client.
270
271 //DP_GECKO_SUPPORT
272 //idea: Res2k, BlackHC
273 //darkplaces implementation: Res2k, BlackHC
274 //constant definitions:
275 float GECKO_BUTTON_DOWN         = 0;
276 float GECKO_BUTTON_UP           = 1;
277 // either use down and up or just press but not all of them!
278 float GECKO_BUTTON_PRESS        = 2;
279 // use this for mouse events if needed?
280 float GECKO_BUTTON_DOUBLECLICK  = 3;
281 //builtin definitions:
282 float(string name) gecko_create( string name ) = #487;
283 void(string name) gecko_destroy( string name ) = #488;
284 void(string name) gecko_navigate( string name, string URI ) = #489;
285 float(string name) gecko_keyevent( string name, float key, float eventtype ) = #490;
286 void gecko_mousemove( string name, float x, float y ) = #491;
287 void gecko_resize( string name, float w, float h ) = #492;
288 vector gecko_get_texture_extent( string name ) = #493;
289 //engine-called QC prototypes:
290 //string(string name, string query) Qecko_Query;
291 //description:
292 //provides an interface to the offscreengecko library and allows for internet browsing in games
293
294 //DP_GFX_EXTERNALTEXTURES
295 //idea: LordHavoc
296 //darkplaces implementation: LordHavoc
297 //description:
298 //loads external textures found in various directories (tenebrae compatible)...
299 /*
300 in all examples .tga is merely the base texture, it can be any of these:
301 .tga (base texture)
302 _glow.tga (fullbrights or other glowing overlay stuff, NOTE: this is done using additive blend, not alpha)
303 _pants.tga (pants overlay for colormapping on models, this should be shades of grey (it is tinted by pants color) and black wherever the base texture is not black, as this is an additive blend)
304 _shirt.tga (same idea as pants, but for shirt color)
305 _diffuse.tga (this may be used instead of base texture for per pixel lighting)
306 _gloss.tga (specular texture for per pixel lighting, note this can be in color (tenebrae only supports greyscale))
307 _norm.tga (normalmap texture for per pixel lighting)
308 _bump.tga (bumpmap, converted to normalmap at load time, supported only for reasons of tenebrae compatibility)
309 _luma.tga (same as _glow but supported only for reasons of tenebrae compatibility)
310
311 due to glquake's incomplete Targa(r) loader, this section describes
312 required Targa(r) features support:
313 types:
314 type 1 (uncompressed 8bit paletted with 24bit/32bit palette)
315 type 2 (uncompressed 24bit/32bit true color, glquake supported this)
316 type 3 (uncompressed 8bit greyscale)
317 type 9 (RLE compressed 8bit paletted with 24bit/32bit palette)
318 type 10 (RLE compressed 24bit/32bit true color, glquake supported this)
319 type 11 (RLE compressed 8bit greyscale)
320 attribute bit 0x20 (Origin At Top Left, top to bottom, left to right)
321
322 image formats guaranteed to be supported: tga, pcx, lmp
323 image formats that are optional: png, jpg
324
325 mdl/spr/spr32 examples:
326 skins are named _A (A being a number) and skingroups are named like _A_B
327 these act as suffixes on the model name...
328 example names for skin _2_1 of model "progs/armor.mdl":
329 game/override/progs/armor.mdl_2_1.tga
330 game/textures/progs/armor.mdl_2_1.tga
331 game/progs/armor.mdl_2_1.tga
332 example names for skin _0 of the model "progs/armor.mdl":
333 game/override/progs/armor.mdl_0.tga
334 game/textures/progs/armor.mdl_0.tga
335 game/progs/armor.mdl_0.tga
336 note that there can be more skins files (of the _0 naming) than the mdl
337 contains, this is only useful to save space in the .mdl file if classic quake
338 compatibility is not a concern.
339
340 bsp/md2/md3 examples:
341 example names for the texture "quake" of model "maps/start.bsp":
342 game/override/quake.tga
343 game/textures/quake.tga
344 game/quake.tga
345
346 sbar/menu/console textures: for example the texture "conchars" (console font) in gfx.wad
347 game/override/gfx/conchars.tga
348 game/textures/gfx/conchars.tga
349 game/gfx/conchars.tga
350 */
351
352 //DP_GFX_EXTERNALTEXTURES_PERMAPTEXTURES
353 //idea: Fuh?
354 //darkplaces implementation: LordHavoc
355 //description:
356 //Q1BSP and HLBSP map loading loads external textures found in textures/<mapname>/ as well as textures/.
357 //Where mapname is the bsp filename minus the extension (typically .bsp) and minus maps/ if it is in maps/ (any other path is not removed)
358 //example:
359 //maps/e1m1.bsp uses textures in the directory textures/e1m1/ and falls back to textures/
360 //maps/b_batt0.bsp uses textures in the directory textures/b_batt0.bsp and falls back to textures/
361 //as a more extreme example:
362 //progs/something/blah.bsp uses textures in the directory textures/progs/something/blah/ and falls back to textures/
363
364 //DP_GFX_FOG
365 //idea: LordHavoc
366 //darkplaces implementation: LordHavoc
367 //worldspawn fields:
368 //"fog" (parameters: "density red green blue", example: "0.1 0.3 0.3 0.3")
369 //description:
370 //global fog for the map, can not be changed by QC
371
372 //DP_GFX_QUAKE3MODELTAGS
373 //idea: id Software
374 //darkplaces implementation: LordHavoc
375 //field definitions:
376 .entity tag_entity; // entity this is attached to (call setattachment to set this)
377 .float tag_index; // which tag on that entity (0 is relative to the entity, > 0 is an index into the tags on the model if it has any) (call setattachment to set this)
378 //builtin definitions:
379 void(entity e, entity tagentity, string tagname) setattachment = #443; // attachs e to a tag on tagentity (note: use "" to attach to entity origin/angles instead of a tag)
380 //description:
381 //allows entities to be visually attached to model tags (which follow animations perfectly) on other entities, for example attaching a weapon to a player's hand, or upper body attached to lower body, allowing it to change angles and frame separately (note: origin and angles are relative to the tag, use '0 0 0' for both if you want it to follow exactly, this is similar to viewmodelforclient's behavior).
382 //note 2: if the tag is not found, it defaults to "" (attach to origin/angles of entity)
383 //note 3: attaching to world turns off attachment
384 //note 4: the entity that this is attached to must be visible for this to work
385 //note 5: if an entity is attached to the player entity it will not be drawn in first person.
386
387 //DP_GFX_SKINFILES
388 //idea: LordHavoc
389 //darkplaces implementation: LordHavoc
390 //description:
391 //alias models (mdl, md2, md3) can have .skin files to replace conventional texture naming, these have a naming format such as:
392 //progs/test.md3_0.skin
393 //progs/test.md3_1.skin
394 //...
395 //
396 //these files contain replace commands (replace meshname shadername), example:
397 //replace "helmet" "progs/test/helmet1.tga" // this is a mesh shader replacement
398 //replace "teamstripes" "progs/test/redstripes.tga"
399 //replace "visor" "common/nodraw" // this makes the visor mesh invisible
400 ////it is not possible to rename tags using this format
401 //
402 //Or the Quake3 syntax (100% compatible with Quake3's .skin files):
403 //helmet,progs/test/helmet1.tga // this is a mesh shader replacement
404 //teamstripes,progs/test/redstripes.tga
405 //visor,common/nodraw // this makes the visor mesh invisible
406 //tag_camera, // this defines that the first tag in the model is called tag_camera
407 //tag_test, // this defines that the second tag in the model is called tag_test
408 //
409 //any names that are not replaced are automatically show up as a grey checkerboard to indicate the error status, and "common/nodraw" is a special case that is invisible.
410 //this feature is intended to allow multiple skin sets on md3 models (which otherwise only have one skin set).
411 //other commands might be added someday but it is not expected.
412
413 //DP_GFX_SKYBOX
414 //idea: LordHavoc
415 //darkplaces implementation: LordHavoc
416 //worldspawn fields:
417 //"sky" (parameters: "basename", example: "mtnsun_" would load "mtnsun_up.tga" and "mtnsun_rt.tga" and similar names, note: "sky" is also used the same way by Quake2)
418 //description:
419 //global skybox for the map, can not be changed by QC
420
421 //DP_HALFLIFE_MAP
422 //idea: LordHavoc
423 //darkplaces implementation: LordHavoc
424 //description:
425 //simply indicates that the engine supports HalfLife maps (BSP version 30, NOT the QER RGBA ones which are also version 30).
426
427 //DP_HALFLIFE_MAP_CVAR
428 //idea: LordHavoc
429 //darkplaces implementation: LordHavoc
430 //cvars:
431 //halflifebsp 0/1
432 //description:
433 //engine sets this cvar when loading a map to indicate if it is halflife format or not.
434
435 //DP_HALFLIFE_SPRITE
436 //idea: LordHavoc
437 //darkplaces implementation: LordHavoc
438 //description:
439 //simply indicates that the engine supports HalfLife sprites.
440
441 //DP_INPUTBUTTONS
442 //idea: LordHavoc
443 //darkplaces implementation: LordHavoc
444 //field definitions:
445 .float button3;
446 .float button4;
447 .float button5;
448 .float button6;
449 .float button7;
450 .float button8;
451 //description:
452 //set to the state of the +button3, +button4, +button5, +button6, +button7, and +button8 buttons from the client, this does not involve protocol changes (the extra 6 button bits were simply not used).
453 //the exact mapping of protocol button bits on the server is:
454 //self.button0 = (bits & 1) != 0;
455 ///* button1 is skipped because mods abuse it as a variable, and accordingly it has no bit */
456 //self.button2 = (bits & 2) != 0;
457 //self.button3 = (bits & 4) != 0;
458 //self.button4 = (bits & 8) != 0;
459 //self.button5 = (bits & 16) != 0;
460 //self.button6 = (bits & 32) != 0;
461 //self.button7 = (bits & 64) != 0;
462 //self.button8 = (bits & 128) != 0;
463
464 //DP_LITSPRITES
465 //idea: LordHavoc
466 //darkplaces implementation: LordHavoc
467 //description:
468 //indicates this engine supports lighting on sprites, any sprite with ! in its filename (both on disk and in the qc) will be lit rather than having forced EF_FULLBRIGHT (EF_FULLBRIGHT on the entity can still force these sprites to not be lit).
469
470 //DP_LITSUPPORT
471 //idea: LordHavoc
472 //darkplaces implementation: LordHavoc
473 //description:
474 //indicates this engine loads .lit files for any quake1 format .bsp files it loads to enhance maps with colored lighting.
475 //implementation description: these files begin with the header QLIT followed by version number 1 (as little endian 32bit), the rest of the file is a replacement lightmaps lump, except being 3x as large as the lightmaps lump of the map it matches up with (and yes the between-lightmap padding is expanded 3x to keep this consistent), so the lightmap offset in each surface is simply multiplied by 3 during loading to properly index the lit data, and the lit file is loaded instead of the lightmap lump, other renderer changes are needed to display these of course...  see the litsupport.zip sample code (almost a tutorial) at http://icculus.org/twilight/darkplaces for more information.
476
477 //DP_MONSTERWALK
478 //idea: LordHavoc
479 //darkplaces implementation: LordHavoc
480 //description:
481 //MOVETYPE_WALK is permitted on non-clients, so bots can move smoothly, run off ledges, etc, just like a real player.
482
483 //DP_MOVETYPEBOUNCEMISSILE
484 //idea: id Software
485 //darkplaces implementation: id Software
486 //movetype definitions:
487 //float MOVETYPE_BOUNCEMISSILE = 11; // already in defs.qc
488 //description:
489 //MOVETYPE_BOUNCE but without gravity, and with full reflection (no speed loss like grenades have), in other words - bouncing laser bolts.
490
491 //DP_NULL_MODEL
492 //idea: Chris
493 //darkplaces implementation: div0
494 //definitions:
495 //string dp_null_model = "null";
496 //description:
497 //setmodel(e, "null"); makes an entity invisible, have a zero bbox, but
498 //networked. useful for shared CSQC entities.
499
500 //DP_MOVETYPEFOLLOW
501 //idea: id Software, LordHavoc (redesigned)
502 //darkplaces implementation: LordHavoc
503 //movetype definitions:
504 float MOVETYPE_FOLLOW = 12;
505 //description:
506 //MOVETYPE_FOLLOW implemented, this uses existing entity fields in unusual ways:
507 //aiment - the entity this is attached to.
508 //punchangle - the original angles when the follow began.
509 //view_ofs - the relative origin (note that this is un-rotated by punchangle, and that is actually the only purpose of punchangle).
510 //v_angle - the relative angles.
511 //here's an example of how you would set a bullet hole sprite to follow a bmodel it was created on, even if the bmodel rotates:
512 //hole.movetype = MOVETYPE_FOLLOW; // make the hole follow
513 //hole.solid = SOLID_NOT; // MOVETYPE_FOLLOW is always non-solid
514 //hole.aiment = bmodel; // make the hole follow bmodel
515 //hole.punchangle = bmodel.angles; // the original angles of bmodel
516 //hole.view_ofs = hole.origin - bmodel.origin; // relative origin
517 //hole.v_angle = hole.angles - bmodel.angles; // relative angles
518
519 //DP_QC_ASINACOSATANATAN2TAN
520 //idea: Urre
521 //darkplaces implementation: LordHavoc
522 //constant definitions:
523 float DEG2RAD = 0.0174532925199432957692369076848861271344287188854172545609719144;
524 float RAD2DEG = 57.2957795130823208767981548141051703324054724665643215491602438612;
525 float PI      = 3.1415926535897932384626433832795028841971693993751058209749445923;
526 //builtin definitions:
527 float(float s) asin = #471; // returns angle in radians for a given sin() value, the result is in the range -PI*0.5 to PI*0.5
528 float(float c) acos = #472; // returns angle in radians for a given cos() value, the result is in the range 0 to PI
529 float(float t) atan = #473; // returns angle in radians for a given tan() value, the result is in the range -PI*0.5 to PI*0.5
530 float(float c, float s) atan2 = #474; // returns angle in radians for a given cos() and sin() value pair, the result is in the range -PI to PI (this is identical to vectoyaw except it returns radians rather than degrees)
531 float(float a) tan = #475; // returns tangent value (which is simply sin(a)/cos(a)) for the given angle in radians, the result is in the range -infinity to +infinity
532 //description:
533 //useful math functions for analyzing vectors, note that these all use angles in radians (just like the cos/sin functions) not degrees unlike makevectors/vectoyaw/vectoangles, so be sure to do the appropriate conversions (multiply by DEG2RAD or RAD2DEG as needed).
534 //note: atan2 can take unnormalized vectors (just like vectoyaw), and the function was included only for completeness (more often you want vectoyaw or vectoangles), atan2(v_x,v_y) * RAD2DEG gives the same result as vectoyaw(v)
535
536 //DP_QC_CHANGEPITCH
537 //idea: id Software
538 //darkplaces implementation: id Software
539 //field definitions:
540 .float idealpitch;
541 .float pitch_speed;
542 //builtin definitions:
543 void(entity ent) changepitch = #63;
544 //description:
545 //equivilant to changeyaw, ent is normally self. (this was a Q2 builtin)
546
547 //DP_QC_COPYENTITY
548 //idea: LordHavoc
549 //darkplaces implementation: LordHavoc
550 //builtin definitions:
551 void(entity from, entity to) copyentity = #400;
552 //description:
553 //copies all data in the entity to another entity.
554
555 //DP_QC_CVAR_DEFSTRING
556 //idea: id Software (Doom3), LordHavoc
557 //darkplaces implementation: LordHavoc
558 //builtin definitions:
559 string(string s) cvar_defstring = #482;
560 //description:
561 //returns the default value of a cvar, as a tempstring.
562
563 //DP_QC_CVAR_DESCRIPTION
564 //idea: div0
565 //DarkPlaces implementation: div0
566 //builtin definitions:
567 string(string name) cvar_description = #518;
568 //description:
569 //returns the description of a cvar
570
571 //DP_QC_CVAR_STRING
572 //idea: VorteX
573 //DarkPlaces implementation: VorteX, LordHavoc
574 //builtin definitions:
575 string(string s) cvar_string = #448;
576 //description:
577 //returns the value of a cvar, as a tempstring.
578
579 //DP_QC_CVAR_TYPE
580 //idea: div0
581 //DarkPlaces implementation: div0
582 //builtin definitions:
583 float(string name) cvar_type = #495;
584 float CVAR_TYPEFLAG_EXISTS = 1;
585 float CVAR_TYPEFLAG_SAVED = 2;
586 float CVAR_TYPEFLAG_PRIVATE = 4;
587 float CVAR_TYPEFLAG_ENGINE = 8;
588 float CVAR_TYPEFLAG_HASDESCRIPTION = 16;
589 float CVAR_TYPEFLAG_READONLY = 32;
590
591 //DP_QC_EDICT_NUM
592 //idea: 515
593 //DarkPlaces implementation: LordHavoc
594 //builtin definitions:
595 entity(float entnum) edict_num = #459;
596 float(entity ent) wasfreed = #353; // same as in EXT_CSQC extension
597 //description:
598 //edict_num returns the entity corresponding to a given number, this works even for freed entities, but you should call wasfreed(ent) to see if is currently active.
599 //wasfreed returns whether an entity slot is currently free (entities that have never spawned are free, entities that have had remove called on them are also free).
600
601 //DP_QC_ENTITYDATA
602 //idea: KrimZon
603 //darkplaces implementation: KrimZon
604 //builtin definitions:
605 float() numentityfields = #496;
606 string(float fieldnum) entityfieldname = #497;
607 float(float fieldnum) entityfieldtype = #498;
608 string(float fieldnum, entity ent) getentityfieldstring = #499;
609 float(float fieldnum, entity ent, string s) putentityfieldstring = #500;
610 //constants:
611 //Returned by entityfieldtype
612 float FIELD_STRING   = 1;
613 float FIELD_FLOAT    = 2;
614 float FIELD_VECTOR   = 3;
615 float FIELD_ENTITY   = 4;
616 float FIELD_FUNCTION = 6;
617 //description:
618 //Versatile functions intended for storing data from specific entities between level changes, but can be customized for some kind of partial savegame.
619 //WARNING: .entity fields cannot be saved and restored between map loads as they will leave dangling pointers.
620 //numentityfields returns the number of entity fields. NOT offsets. Vectors comprise 4 fields: v, v_x, v_y and v_z.
621 //entityfieldname returns the name as a string, eg. "origin" or "classname" or whatever.
622 //entityfieldtype returns a value that the constants represent, but the field may be of another type in more exotic progs.dat formats or compilers.
623 //getentityfieldstring returns data as would be written to a savegame, eg... "0.05" (float), "0 0 1" (vector), or "Hello World!" (string). Function names can also be returned.
624 //putentityfieldstring puts the data returned by getentityfieldstring back into the entity.
625
626 //DP_QC_ETOS
627 //idea: id Software
628 //darkplaces implementation: id Software
629 //builtin definitions:
630 string(entity ent) etos = #65;
631 //description:
632 //prints "entity 1" or similar into a string. (this was a Q2 builtin)
633
634 //DP_QC_FINDCHAIN
635 //idea: LordHavoc
636 //darkplaces implementation: LordHavoc
637 //builtin definitions:
638 entity(.string fld, string match) findchain = #402;
639 //description:
640 //similar to find() but returns a chain of entities like findradius.
641
642 //DP_QC_FINDCHAIN_TOFIELD
643 //idea: div0
644 //darkplaces implementation: div0
645 //builtin definitions:
646 entity(.string fld, float match, .entity tofield) findradius_tofield = #22;
647 entity(.string fld, string match, .entity tofield) findchain_tofield = #402;
648 entity(.string fld, float match, .entity tofield) findchainflags_tofield = #450;
649 entity(.string fld, float match, .entity tofield) findchainfloat_tofield = #403;
650 //description:
651 //similar to findchain() etc, but stores the chain into .tofield instead of .chain
652 //actually, the .entity tofield is an optional field of the the existing findchain* functions
653
654 //DP_QC_FINDCHAINFLAGS
655 //idea: Sajt
656 //darkplaces implementation: LordHavoc
657 //builtin definitions:
658 entity(.float fld, float match) findchainflags = #450;
659 //description:
660 //similar to findflags() but returns a chain of entities like findradius.
661
662 //DP_QC_FINDCHAINFLOAT
663 //idea: LordHavoc
664 //darkplaces implementation: LordHavoc
665 //builtin definitions:
666 entity(.entity fld, entity match) findchainentity = #403;
667 entity(.float fld, float match) findchainfloat = #403;
668 //description:
669 //similar to findentity()/findfloat() but returns a chain of entities like findradius.
670
671 //DP_QC_FINDFLAGS
672 //idea: Sajt
673 //darkplaces implementation: LordHavoc
674 //builtin definitions:
675 entity(entity start, .float fld, float match) findflags = #449;
676 //description:
677 //finds an entity with the specified flag set in the field, similar to find()
678
679 //DP_QC_FINDFLOAT
680 //idea: LordHavoc
681 //darkplaces implementation: LordHavoc
682 //builtin definitions:
683 entity(entity start, .entity fld, entity match) findentity = #98;
684 entity(entity start, .float fld, float match) findfloat = #98;
685 //description:
686 //finds an entity or float field value, similar to find(), but for entity and float fields.
687
688 //DP_QC_FS_SEARCH
689 //idea: Black
690 //darkplaces implementation: Black
691 //builtin definitions:
692 float(string pattern, float caseinsensitive, float quiet) search_begin = #444;
693 void(float handle) search_end = #445;
694 float(float handle) search_getsize = #446;
695 string(float handle, float num) search_getfilename = #447;
696 //description:
697 //search_begin performs a filename search with the specified pattern (for example "maps/*.bsp") and stores the results in a search slot (minimum of 128 supported by any engine with this extension), the other functions take this returned search slot number, be sure to search_free when done (they are also freed on progs reload).
698 //search_end frees a search slot (also done at progs reload).
699 //search_getsize returns how many filenames were found.
700 //search_getfilename returns a filename from the search.
701
702 //DP_QC_GETLIGHT
703 //idea: LordHavoc
704 //darkplaces implementation: LordHavoc
705 //builtin definitions:
706 vector(vector org) getlight = #92;
707 //description:
708 //returns the lighting at the requested location (in color), 0-255 range (can exceed 255).
709
710 //DP_QC_GETSURFACE
711 //idea: LordHavoc
712 //darkplaces implementation: LordHavoc
713 //builtin definitions:
714 float(entity e, float s) getsurfacenumpoints = #434;
715 vector(entity e, float s, float n) getsurfacepoint = #435;
716 vector(entity e, float s) getsurfacenormal = #436;
717 string(entity e, float s) getsurfacetexture = #437;
718 float(entity e, vector p) getsurfacenearpoint = #438;
719 vector(entity e, float s, vector p) getsurfaceclippedpoint = #439;
720 //description:
721 //functions to query surface information.
722
723 //DP_QC_GETSURFACEPOINTATTRIBUTE
724 //idea: BlackHC
725 //darkplaces implementation: BlackHC
726 // constants
727 float SPA_POSITION = 0;
728 float SPA_S_AXIS = 1;
729 float SPA_T_AXIS = 2;
730 float SPA_R_AXIS = 3; // same as SPA_NORMAL
731 float SPA_TEXCOORDS0 = 4;
732 float SPA_LIGHTMAP0_TEXCOORDS = 5;
733 float SPA_LIGHTMAP0_COLOR = 6;
734 //builtin definitions:
735 vector(entity e, float s, float n, float a) getsurfacepointattribute = #486;
736
737 //description:
738 //function to query extended information about a point on a certain surface
739
740 //DP_QC_GETTAGINFO
741 //idea: VorteX, LordHavoc (somebody else?)
742 //DarkPlaces implementation: VorteX
743 //builtin definitions:
744 float(entity ent, string tagname) gettagindex = #451;
745 vector(entity ent, float tagindex) gettaginfo = #452;
746 //description:
747 //gettagindex returns the number of a tag on an entity, this number is the same as set by setattachment (in the .tag_index field), allowing the qc to save a little cpu time by keeping the number around if it wishes (this could already be done by calling setattachment and saving off the tag_index).
748 //gettaginfo returns the origin of the tag in worldspace and sets v_forward, v_right, and v_up to the current orientation of the tag in worldspace, this automatically resolves all dependencies (attachments, including viewmodelforclient), this means you could fire a shot from a tag on a gun entity attached to the view for example.
749
750 //DP_QC_GETTAGINFO_BONEPROPERTIES
751 //idea: daemon
752 //DarkPlaces implementation: div0
753 //global definitions:
754 float gettaginfo_parent;
755 string gettaginfo_name;
756 vector gettaginfo_offset;
757 vector gettaginfo_forward;
758 vector gettaginfo_right;
759 vector gettaginfo_up;
760 //description:
761 //when this extension is present, gettaginfo fills in some globals with info about the bone that had been queried
762 //gettaginfo_parent is set to the number of the parent bone, or 0 if it is a root bone
763 //gettaginfo_name is set to the name of the bone whose index had been specified in gettaginfo
764 //gettaginfo_offset, gettaginfo_forward, gettaginfo_right, gettaginfo_up contain the transformation matrix of the bone relative to its parent. Note that the matrix may contain a scaling component.
765
766 //DP_QC_GETTIME
767 //idea: tZork
768 //darkplaces implementation: tZork, div0
769 //constant definitions:
770 float GETTIME_FRAMESTART = 0; // time of start of frame
771 float GETTIME_REALTIME = 1; // current time (may be OS specific)
772 float GETTIME_HIRES = 2; // like REALTIME, but may reset between QC invocations and thus can be higher precision
773 float GETTIME_UPTIME = 3; // time since start of the engine
774 //builtin definitions:
775 float(float tmr) gettime = #519;
776 //description:
777 //some timers to query...
778
779 //DP_QC_MINMAXBOUND
780 //idea: LordHavoc
781 //darkplaces implementation: LordHavoc
782 //builtin definitions:
783 float(float a, float b) min = #94;
784 float(float a, float b, float c) min3 = #94;
785 float(float a, float b, float c, float d) min4 = #94;
786 float(float a, float b, float c, float d, float e) min5 = #94;
787 float(float a, float b, float c, float d, float e, float f) min6 = #94;
788 float(float a, float b, float c, float d, float e, float f, float g) min7 = #94;
789 float(float a, float b, float c, float d, float e, float f, float g, float h) min8 = #94;
790 float(float a, float b) max = #95;
791 float(float a, float b, float c) max3 = #95;
792 float(float a, float b, float c, float d) max4 = #95;
793 float(float a, float b, float c, float d, float e) max5 = #95;
794 float(float a, float b, float c, float d, float e, float f) max6 = #95;
795 float(float a, float b, float c, float d, float e, float f, float g) max7 = #95;
796 float(float a, float b, float c, float d, float e, float f, float g, float h) max8 = #95;
797 float(float minimum, float val, float maximum) bound = #96;
798 //description:
799 //min returns the lowest of all the supplied numbers.
800 //max returns the highest of all the supplied numbers.
801 //bound clamps the value to the range and returns it.
802
803 //DP_QC_MULTIPLETEMPSTRINGS
804 //idea: LordHavoc
805 //darkplaces implementation: LordHavoc
806 //description:
807 //this extension makes all builtins returning tempstrings (ftos for example)
808 //cycle through a pool of multiple tempstrings (at least 16), allowing
809 //multiple ftos results to be gathered before putting them to use, normal
810 //quake only had 1 tempstring, causing many headaches.
811 //
812 //Note that for longer term storage (or compatibility on engines having
813 //FRIK_FILE but not this extension) the FRIK_FILE extension's
814 //strzone/strunzone builtins provide similar functionality (slower though).
815 //
816 //NOTE: this extension is superseded by DP_QC_UNLIMITEDTEMPSTRINGS
817
818 //DP_QC_NUM_FOR_EDICT
819 //idea: Blub\0
820 //darkplaces implementation: Blub\0
821 //Function to get the number of an entity - a clean way.
822 float(entity num) num_for_edict = #512;
823
824 //DP_QC_RANDOMVEC
825 //idea: LordHavoc
826 //darkplaces implementation: LordHavoc
827 //builtin definitions:
828 vector() randomvec = #91;
829 //description:
830 //returns a vector of length < 1, much quicker version of this QC: do {v_x = random()*2-1;v_y = random()*2-1;v_z = random()*2-1;} while(vlen(v) > 1)
831
832 //DP_QC_SINCOSSQRTPOW
833 //idea: id Software, LordHavoc
834 //darkplaces implementation: id Software, LordHavoc
835 //builtin definitions:
836 float(float val) sin = #60;
837 float(float val) cos = #61;
838 float(float val) sqrt = #62;
839 float(float a, float b) pow = #97;
840 //description:
841 //useful math functions, sine of val, cosine of val, square root of val, and raise a to power b, respectively.
842
843 //DP_QC_STRFTIME
844 //idea: LordHavoc
845 //darkplaces implementation: LordHavoc
846 //builtin definitions:
847 string(float uselocaltime, string format, ...) strftime = #478;
848 //description:
849 //provides the ability to get the local (in your timezone) or world (Universal Coordinated Time) time as a string using the formatting of your choice:
850 //example: "%Y-%m-%d %H:%M:%S"   (result looks like: 2007-02-08 01:03:15)
851 //note: "%F %T" gives the same result as "%Y-%m-%d %H:%M:%S" (ISO 8601 date format and 24-hour time)
852 //for more format codes please do a web search for strftime 3 and you should find the man(3) pages for this standard C function.
853 //
854 //practical uses:
855 //changing day/night cycle (shops closing, monsters going on the prowl) in an RPG, for this you probably want to use s = strftime(TRUE, "%H");hour = stof(s);
856 //printing current date/time for competitive multiplayer games, such as the beginning/end of each round in real world time.
857 //activating eastereggs in singleplayer games on certain dates.
858 //
859 //note: some codes such as %x and %X use your locale settings and thus may not make sense to international users, it is not advisable to use these as the server and clients may be in different countries.
860 //note: if you display local time to a player, it would be a good idea to note whether it is local time using a string like "%F %T (local)", and otherwise use "%F %T (UTC)".
861 //note: be aware that if the game is saved and reloaded a week later the date and time will be different, so if activating eastereggs in a singleplayer game or something you may want to only check when a level is loaded and then keep the same easteregg state throughout the level so that the easteregg does not deactivate when reloading from a savegame (also be aware that precaches should not depend on such date/time code because reloading a savegame often scrambles the precaches if so!).
862 //note: this function can return a NULL string (you can check for it with if (!s)) if the localtime/gmtime functions returned NULL in the engine code, such as if those functions don't work on this platform (consoles perhaps?), so be aware that this may return nothing.
863
864 //DP_QC_STRINGCOLORFUNCTIONS
865 //idea: Dresk
866 //darkplaces implementation: Dresk
867 //builtin definitions:
868 float(string s) strlennocol = #476; // returns how many characters are in a string, minus color codes
869 string(string s) strdecolorize = #477; // returns a string minus the color codes of the string provided
870 //description:
871 //provides additional functionality to strings by supporting functions that isolate and identify strings with color codes
872
873 //DP_QC_STRING_CASE_FUNCTIONS
874 //idea: Dresk
875 //darkplaces implementation: LordHavoc / Dresk
876 //builtin definitions:
877 string(string s) strtolower = #480; // returns the passed in string in pure lowercase form
878 string(string s) strtoupper = #481; // returns the passed in string in pure uppercase form
879 //description:
880 //provides simple string uppercase and lowercase functions
881
882 //DP_QC_TOKENIZEBYSEPARATOR
883 //idea: Electro, SavageX, LordHavoc
884 //darkplaces implementation: LordHavoc
885 //builtin definitions:
886 float(string s, string separator1, ...) tokenizebyseparator = #479;
887 //description:
888 //this function returns tokens separated by any of the supplied separator strings, example:
889 //numnumbers = tokenizebyseparator("10.2.3.4", ".");
890 //returns 4 and the tokens are "10" "2" "3" "4"
891 //possibly useful for parsing IPv4 addresses (such as "1.2.3.4") and IPv6 addresses (such as "[1234:5678:9abc:def0:1234:5678:9abc:def0]:26000")
892
893 //DP_QC_TOKENIZE_CONSOLE
894 //idea: div0
895 //darkplaces implementation: div0
896 //builtin definitions:
897 float(string s) tokenize_console = #514;
898 float(float i) argv_start_index = #515;
899 float(float i) argv_end_index = #516;
900 //description:
901 //this function returns tokens separated just like the console does
902 //also, functions are provided to get the index of the first and last character of each token in the original string
903 //Passing negative values to them, or to argv, will be treated as indexes from the LAST token (like lists work in Perl). So argv(-1) will return the LAST token.
904
905 //DP_QC_TRACEBOX
906 //idea: id Software
907 //darkplaces implementation: id Software
908 //builtin definitions:
909 void(vector v1, vector min, vector max, vector v2, float nomonsters, entity forent) tracebox = #90;
910 //description:
911 //similar to traceline but much more useful, traces a box of the size specified (technical note: in quake1 and halflife bsp maps the mins and maxs will be rounded up to one of the hull sizes, quake3 bsp does not have this problem, this is the case with normal moving entities as well).
912
913 //DP_QC_TRACETOSS
914 //idea: id Software
915 //darkplaces implementation: id Software
916 //builtin definitions:
917 void(entity ent, entity ignore) tracetoss = #64;
918 //description:
919 //simulates movement of the entity as if it is MOVETYPE_TOSS and starting with it's current state (location, velocity, etc), returns relevant trace_ variables (trace_fraction is always 0, all other values are supported - trace_ent, trace_endpos, trace_plane_normal), does not actually alter the entity.
920
921 //DP_QC_TRACE_MOVETYPE_HITMODEL
922 //idea: LordHavoc
923 //darkplaces implementation: LordHavoc
924 //constant definitions:
925 float MOVE_HITMODEL = 4;
926 //description:
927 //allows traces to hit alias models (not sprites!) instead of entity boxes, use as the nomonsters parameter to trace functions, note that you can hit invisible model entities (alpha < 0 or EF_NODRAW or model "", it only checks modelindex)
928
929 //DP_QC_TRACE_MOVETYPE_WORLDONLY
930 //idea: LordHavoc
931 //darkplaces implementation: LordHavoc
932 //constant definitions:
933 float MOVE_WORLDONLY = 3;
934 //description:
935 //allows traces to hit only world (ignoring all entities, unlike MOVE_NOMONSTERS which hits all bmodels), use as the nomonsters parameter to trace functions
936
937 //DP_QC_UNLIMITEDTEMPSTRINGS
938 //idea: div0
939 //darkplaces implementation: LordHavoc
940 //description:
941 //this extension alters Quake behavior such that instead of reusing a single
942 //tempstring (or multiple) there are an unlimited number of tempstrings, which
943 //are removed only when a QC function invoked by the engine returns,
944 //eliminating almost all imaginable concerns with string handling in QuakeC.
945 //
946 //in short:
947 //you can now use and abuse tempstrings as much as you like, you still have to
948 //use strzone (FRIK_FILE) for permanent storage however.
949 //
950 //
951 //
952 //implementation notes for other engine coders:
953 //these tempstrings are expected to be stored in a contiguous buffer in memory
954 //which may be fixed size or controlled by a cvar, or automatically grown on
955 //demand (in the case of DarkPlaces).
956 //
957 //this concept is similar to quake's Zone system, however these are all freed
958 //when the QC interpreter returns.
959 //
960 //this is basically a poor man's garbage collection system for strings.
961
962 //DP_QC_VECTOANGLES_WITH_ROLL
963 //idea: LordHavoc
964 //darkplaces implementation: LordHavoc
965 //builtin definitions:
966 vector(vector forward, vector up) vectoangles2 = #51; // same number as vectoangles
967 //description:
968 //variant of vectoangles that takes an up vector to calculate roll angle (also uses this to calculate yaw correctly if the forward is straight up or straight down)
969 //note: just like normal vectoangles you need to negate the pitch of the returned angles if you want to feed them to makevectors or assign to self.v_angle
970
971 //DP_QC_VECTORVECTORS
972 //idea: LordHavoc
973 //darkplaces implementation: LordHavoc
974 //builtin definitions:
975 void(vector dir) vectorvectors = #432;
976 //description:
977 //creates v_forward, v_right, and v_up vectors given a forward vector, similar to makevectors except it takes a forward direction vector instead of angles.
978
979 //DP_QC_WHICHPACK
980 //idea: div0
981 //darkplaces implementation: div0
982 //builtin definitions:
983 string(string filename) whichpack = #503;
984 //description:
985 //returns the name of the pak/pk3/whatever containing the given file, in the same path space as FRIK_FILE functions use (that is, possibly with a path name prefix)
986
987 //DP_QC_URI_ESCAPE
988 //idea: div0
989 //darkplaces implementation: div0
990 //URI::Escape's functionality
991 string(string in) uri_escape = #510;
992 string(string in) uri_unescape = #511;
993
994 //DP_QC_URI_GET
995 //idea: div0
996 //darkplaces implementation: div0
997 //loads text from an URL into a string
998 //returns 1 on success of initiation, 0 if there are too many concurrent
999 //connections already or if the URL is invalid
1000 //the following callback will receive the data and MUST exist!
1001 //  void(float id, float status, string data) URI_Get_Callback;
1002 //status is either
1003 //  negative for an internal error,
1004 //  0 for success, or
1005 //  the HTTP response code on server error (e.g. 404)
1006 //if 1 is returned by uri_get, the callback will be called in the future
1007 float(string url, float id) uri_get = #513;
1008
1009 //DP_SV_SPAWNFUNC_PREFIX
1010 //idea: div0
1011 //darkplaces implementation: div0
1012 //Make functions whose name start with spawnfunc_ take precedence as spawn function for loading entities.
1013 //Useful if you have a field ammo_shells (required in any Quake mod) but want to support spawn functions called ammo_shells (like in Q3A).
1014 //Optionally, you can declare a global "float require_spawnfunc_prefix;" which will require ANY spawn function to start with that prefix.
1015
1016
1017 //DP_QUAKE2_MODEL
1018 //idea: quake community
1019 //darkplaces implementation: LordHavoc
1020 //description:
1021 //shows that the engine supports Quake2 .md2 files.
1022
1023 //DP_QUAKE2_SPRITE
1024 //idea: LordHavoc
1025 //darkplaces implementation: Elric
1026 //description:
1027 //shows that the engine supports Quake2 .sp2 files.
1028
1029 //DP_QUAKE3_MAP
1030 //idea: quake community
1031 //darkplaces implementation: LordHavoc
1032 //description:
1033 //shows that the engine supports Quake3 .bsp files.
1034
1035 //DP_QUAKE3_MODEL
1036 //idea: quake community
1037 //darkplaces implementation: LordHavoc
1038 //description:
1039 //shows that the engine supports Quake3 .md3 files.
1040
1041 //DP_REGISTERCVAR
1042 //idea: LordHavoc
1043 //darkplaces implementation: LordHavoc
1044 //builtin definitions:
1045 float(string name, string value) registercvar = #93;
1046 //description:
1047 //adds a new console cvar to the server console (in singleplayer this is the player's console), the cvar exists until the mod is unloaded or the game quits.
1048 //NOTE: DP_CON_SET is much better.
1049
1050 //DP_SND_DIRECTIONLESSATTNNONE
1051 //idea: LordHavoc
1052 //darkplaces implementation: LordHavoc
1053 //description:
1054 //make sounds with ATTN_NONE have no spatialization (enabling easy use as music sources).
1055
1056 //DP_SND_FAKETRACKS
1057 //idea: requested
1058 //darkplaces implementation: Elric
1059 //description:
1060 //the engine plays sound/cdtracks/track001.wav instead of cd track 1 and so on if found, this allows games and mods to have music tracks without using ambientsound.
1061 //Note: also plays .ogg with DP_SND_OGGVORBIS extension.
1062
1063 //DP_SND_OGGVORBIS
1064 //idea: Transfusion
1065 //darkplaces implementation: Elric
1066 //description:
1067 //the engine supports loading Ogg Vorbis sound files.  Use either the .ogg filename directly, or a .wav of the same name (will try to load the .wav first and then .ogg).
1068
1069 //DP_SND_STEREOWAV
1070 //idea: LordHavoc
1071 //darkplaces implementation: LordHavoc
1072 //description:
1073 //the engine supports stereo WAV files.  (useful with DP_SND_DIRECTIONLESSATTNNONE for music)
1074
1075 //DP_SOLIDCORPSE
1076 //idea: LordHavoc
1077 //darkplaces implementation: LordHavoc
1078 //solid definitions:
1079 float SOLID_CORPSE = 5;
1080 //description:
1081 //the entity will not collide with SOLID_CORPSE and SOLID_SLIDEBOX entities (and likewise they will not collide with it), this is useful if you want dead bodies that are shootable but do not obstruct movement by players and monsters, note that if you traceline with a SOLID_SLIDEBOX entity as the ignoreent, it will ignore SOLID_CORPSE entities, this is desirable for visibility and movement traces, but not for bullets, for the traceline to hit SOLID_CORPSE you must temporarily force the player (or whatever) to SOLID_BBOX and then restore to SOLID_SLIDEBOX after the traceline.
1082
1083 //DP_SPRITE32
1084 //idea: LordHavoc
1085 //darkplaces implementation: LordHavoc
1086 //description:
1087 //the engine supports .spr32 sprites.
1088
1089 //DP_SV_BOTCLIENT
1090 //idea: LordHavoc
1091 //darkplaces implementation: LordHavoc
1092 //constants:
1093 float CLIENTTYPE_DISCONNECTED = 0;
1094 float CLIENTTYPE_REAL = 1;
1095 float CLIENTTYPE_BOT = 2;
1096 float CLIENTTYPE_NOTACLIENT = 3;
1097 //builtin definitions:
1098 entity() spawnclient = #454; // like spawn but for client slots (also calls relevant connect/spawn functions), returns world if no clients available
1099 float(entity clent) clienttype = #455; // returns one of the CLIENTTYPE_* constants
1100 //description:
1101 //spawns a client with no network connection, to allow bots to use client slots with no hacks.
1102 //How to use:
1103 /*
1104         // to spawn a bot
1105         local entity oldself;
1106         oldself = self;
1107         self = spawnclient();
1108         if (!self)
1109         {
1110                 bprint("Can not add bot, server full.\n");
1111                 self = oldself;
1112                 return;
1113         }
1114         self.netname = "Yoyobot";
1115         self.clientcolors = 12 * 16 + 4; // yellow (12) shirt and red (4) pants
1116         ClientConnect();
1117         PutClientInServer();
1118         self = oldself;
1119
1120         // to remove all bots
1121         local entity head;
1122         head = find(world, classname, "player");
1123         while (head)
1124         {
1125                 if (clienttype(head) == CLIENTTYPE_BOT)
1126                         dropclient(head);
1127                 head = find(head, classname, "player");
1128         }
1129
1130         // to identify if a client is a bot (for example in PlayerPreThink)
1131         if (clienttype(self) == CLIENTTYPE_BOT)
1132                 botthink();
1133 */
1134 //see also DP_SV_CLIENTCOLORS DP_SV_CLIENTNAME DP_SV_DROPCLIENT
1135 //How it works:
1136 //creates a new client, calls SetNewParms and stores the parms, and returns the client.
1137 //this intentionally does not call SV_SendServerinfo to allow the QuakeC a chance to set the netname and clientcolors fields before actually spawning the bot by calling ClientConnect and PutClientInServer manually
1138 //on level change ClientConnect and PutClientInServer are called by the engine to spawn in the bot (this is why clienttype() exists to tell you on the next level what type of client this is).
1139 //parms work the same on bot clients as they do on real clients, and do carry from level to level
1140
1141 //DP_SV_CLIENTCOLORS
1142 //idea: LordHavoc
1143 //darkplaces implementation: LordHavoc
1144 //field definitions:
1145 .float clientcolors; // colors of the client (format: pants + shirt * 16)
1146 //description:
1147 //allows qc to read and modify the client colors associated with a client entity (not particularly useful on other entities), and automatically sends out any appropriate network updates if changed
1148
1149 //DP_SV_CLIENTNAME
1150 //idea: LordHavoc
1151 //darkplaces implementation: LordHavoc
1152 //description:
1153 //allows qc to modify the client's .netname, and automatically sends out any appropriate network updates if changed
1154
1155 //DP_SV_CUSTOMIZEENTITYFORCLIENT
1156 //idea: LordHavoc
1157 //darkplaces implementation: [515] and LordHavoc
1158 //field definitions:
1159 .float() customizeentityforclient; // self = this entity, other = client entity
1160 //description:
1161 //allows qc to modify an entity before it is sent to each client, the function returns TRUE if it should send, FALSE if it should not, and is fully capable of editing the entity's fields, this allows cloaked players to appear less transparent to their teammates, navigation markers to only show to their team, etc
1162 //tips on writing customize functions:
1163 //it is a good idea to return FALSE early in the function if possible to reduce cpu usage, because this function may be called many thousands of times per frame if there are many customized entities on a 64+ player server.
1164 //you are free to change anything in self, but please do not change any other entities (the results may be very inconsistent).
1165 //example ideas for use of this extension:
1166 //making icons over teammates' heads which are only visible to teammates.  for exasmple: float() playericon_customizeentityforclient = {return self.owner.team == other.team;};
1167 //making cloaked players more visible to their teammates than their enemies.  for example: float() player_customizeentityforclient = {if (self.items & IT_CLOAKING) {if (self.team == other.team) self.alpha = 0.6;else self.alpha = 0.1;} return TRUE;};
1168 //making explosion models that face the viewer (does not work well with chase_active).  for example: float() explosion_customizeentityforclient = {self.angles = vectoangles(other.origin + other.view_ofs - self.origin);self.angles_x = 0 - self.angles_x;};
1169 //implementation notes:
1170 //entity customization is done before per-client culling (visibility for instance) because the entity may be doing setorigin to display itself in different locations on different clients, may be altering its .modelindex, .effects and other fields important to culling, so customized entities increase cpu usage (non-customized entities can use all the early culling they want however, as they are not changing on a per client basis).
1171
1172 //DP_SV_DRAWONLYTOCLIENT
1173 //idea: LordHavoc
1174 //darkplaces implementation: LordHavoc
1175 //field definitions:
1176 .entity drawonlytoclient;
1177 //description:
1178 //the entity is only visible to the specified client.
1179
1180 //DP_SV_DROPCLIENT
1181 //idea: FrikaC
1182 //darkplaces implementation: LordHavoc
1183 //builtin definitions:
1184 void(entity clent) dropclient = #453;
1185 //description:
1186 //causes the server to immediately drop the client, more reliable than stuffcmd(clent, "disconnect\n"); which could be intentionally ignored by the client engine
1187
1188 //DP_SV_EFFECT
1189 //idea: LordHavoc
1190 //darkplaces implementation: LordHavoc
1191 //builtin definitions:
1192 void(vector org, string modelname, float startframe, float endframe, float framerate) effect = #404;
1193 //SVC definitions:
1194 //float svc_effect = #52; // [vector] org [byte] modelindex [byte] startframe [byte] framecount [byte] framerate
1195 //float svc_effect2 = #53; // [vector] org [short] modelindex [byte] startframe [byte] framecount [byte] framerate
1196 //description:
1197 //clientside playback of simple custom sprite effects (explosion sprites, etc).
1198
1199 //DP_SV_ENTITYCONTENTSTRANSITION
1200 //idea: Dresk
1201 //darkplaces implementation: Dresk
1202 //field definitions:
1203 .void(float nOriginalContents, float nNewContents) contentstransition;
1204 //description:
1205 //This field function, when provided, is triggered on an entity when the contents (ie. liquid / water / etc) is changed.
1206 //The first parameter provides the entities original contents, prior to the transition.  The second parameter provides the new contents.
1207 //NOTE: If this field function is provided on an entity, the standard watersplash sound IS SUPPRESSED to allow for authors to create their own transition sounds.
1208
1209 //DP_SV_MOVETYPESTEP_LANDEVENT
1210 //idea: Dresk
1211 //darkplaces implementation: Dresk
1212 //field definitions:
1213 .void(vector vImpactVelocity) movetypesteplandevent;
1214 //description:
1215 //This field function, when provided, is triggered on a MOVETYPE_STEP entity when it experiences  "land event".
1216 // The standard engine behavior for this event is to play the sv_sound_land CVar sound.
1217 //The parameter provides the velocity of the entity at the time of the impact.  The z value may therefore be used to calculate how "hard" the entity struck the surface.
1218 //NOTE: If this field function is provided on a MOVETYPE_STEP entity, the standard sv_sound_land sound IS SUPPRESSED to allow for authors to create their own feedback.
1219
1220 //DP_SV_POINTSOUND
1221 //idea: Dresk
1222 //darkplaces implementation: Dresk
1223 //builtin definitions:
1224 void(vector origin, string sample, float volume, float attenuation) pointsound = #483;
1225 //description:
1226 //Similar to the standard QC sound function, this function takes an origin instead of an entity and omits the channel parameter.
1227 // This allows sounds to be played at arbitrary origins without spawning entities.
1228
1229 //DP_SV_ONENTITYNOSPAWNFUNCTION
1230 //idea: Dresk
1231 //darkplaces implementation: Dresk
1232 //engine-called QC prototypes:
1233 //void() SV_OnEntityNoSpawnFunction;
1234 //description:
1235 // This function is called whenever an entity on the server has no spawn function, and therefore has no defined QC behavior.
1236 // You may as such dictate the behavior as to what happens to the entity.
1237 // To mimic the engine's default behavior, simply call remove(self).
1238
1239 //DP_SV_ONENTITYPREPOSTSPAWNFUNCTION
1240 //idea: div0
1241 //darkplaces implementation: div0
1242 //engine-called QC prototypes:
1243 //void() SV_OnEntityPreSpawnFunction;
1244 //void() SV_OnEntityPostSpawnFunction;
1245 //description:
1246 // These functions are called BEFORE or AFTER an entity is spawned the regular way.
1247 // You may as such dictate the behavior as to what happens to the entity.
1248 // SV_OnEntityPreSpawnFunction is called before even looking for the spawn function, so you can even change its classname in there. If it remove()s the entity, the spawn function will not be looked for.
1249 // SV_OnEntityPostSpawnFunction is called ONLY after its spawn function or SV_OnEntityNoSpawnFunction was called, and skipped if the entity got removed by either.
1250
1251 //DP_SV_MODELFLAGS_AS_EFFECTS
1252 //idea: LordHavoc, Dresk
1253 //darkplaces implementation: LordHavoc
1254 //field definitions:
1255 .float modelflags;
1256 //constant definitions:
1257 float EF_NOMODELFLAGS = 8388608; // ignore any effects in a model file and substitute your own
1258 float MF_ROCKET  =   1; // leave a trail
1259 float MF_GRENADE =   2; // leave a trail
1260 float MF_GIB     =   4; // leave a trail
1261 float MF_ROTATE  =   8; // rotate (bonus items)
1262 float MF_TRACER  =  16; // green split trail
1263 float MF_ZOMGIB  =  32; // small blood trail
1264 float MF_TRACER2 =  64; // orange split trail
1265 float MF_TRACER3 = 128; // purple trail
1266 //description:
1267 //this extension allows model flags to be specified on entities so you can add a rocket trail and glow to any entity, etc.
1268 //setting any of these will override the flags the model already has, to disable the model's flags without supplying any of your own you must use EF_NOMODELFLAGS.
1269 //
1270 //silly example modification #1 to W_FireRocket in weapons.qc:
1271 //missile.effects = EF_NOMODELFLAGS; // rocket without a glow/fire trail
1272 //silly example modification #2 to W_FireRocket in weapons.qc:
1273 //missile.modelflags = MF_GIB; // leave a blood trail instead of glow/fire trail
1274 //
1275 //note: you can not combine multiple kinds of trail, only one of them will be active, you can combine MF_ROTATE and the other MF_ flags however, and using EF_NOMODELFLAGS along with these does no harm.
1276 //
1277 //note to engine coders: they are internally encoded in the protocol as extra EF_ flags (shift the values left 24 bits and send them in the protocol that way), so no protocol change was required (however 32bit effects is a protocol extension itself), within the engine they are referred to as EF_ for the 24bit shifted values.
1278
1279 //DP_SV_NETADDRESS
1280 //idea: Dresk
1281 //darkplaces implementation: Dresk
1282 //field definitions:
1283 .string netaddress;
1284 //description:
1285 // provides the netaddress of the associated entity (ie. 127.0.0.1) and "null/botclient" if the netconnection of the entity is invalid
1286
1287 //DP_SV_NODRAWTOCLIENT
1288 //idea: LordHavoc
1289 //darkplaces implementation: LordHavoc
1290 //field definitions:
1291 .entity nodrawtoclient;
1292 //description:
1293 //the entity is not visible to the specified client.
1294
1295 //DP_SV_PING
1296 //idea: LordHavoc
1297 //darkplaces implementation: LordHavoc
1298 //field definitions:
1299 .float ping;
1300 //description:
1301 //continuously updated field indicating client's ping (based on average of last 16 packet time differences).
1302
1303 //DP_SV_POINTPARTICLES
1304 //idea: Spike
1305 //darkplaces implementation: LordHavoc
1306 //function definitions:
1307 float(string effectname) particleeffectnum = #335; // same as in CSQC
1308 void(entity ent, float effectnum, vector start, vector end) trailparticles = #336; // same as in CSQC
1309 void(float effectnum, vector org, vector vel, float howmany) pointparticles = #337; // same as in CSQC
1310 //SVC definitions:
1311 //float svc_trailparticles = 60; // [short] entnum [short] effectnum [vector] start [vector] end
1312 //float svc_pointparticles = 61; // [short] effectnum [vector] start [vector] velocity [short] count
1313 //float svc_pointparticles1 = 62; // [short] effectnum [vector] start, same as svc_pointparticles except velocity is zero and count is 1
1314 //description:
1315 //provides the ability to spawn non-standard particle effects, typically these are defined in a particle effect information file such as effectinfo.txt in darkplaces.
1316 //this is a port of particle effect features from clientside QC (EXT_CSQC) to server QC, as these effects are potentially useful to all games even if they do not make use of EXT_CSQC.
1317 //warning: server must have same order of effects in effectinfo.txt as client does or the numbers would not match up, except for standard quake effects which are always the same numbers.
1318
1319 //DP_SV_PUNCHVECTOR
1320 //idea: LordHavoc
1321 //darkplaces implementation: LordHavoc
1322 //field definitions:
1323 .vector punchvector;
1324 //description:
1325 //offsets client view in worldspace, similar to view_ofs but all 3 components are used and are sent with at least 8 bits of fraction, this allows the view to be kicked around by damage or hard landings or whatever else, note that unlike punchangle this is not faded over time, it is up to the mod to fade it (see also DP_SV_PLAYERPHYSICS).
1326
1327 //DP_SV_PLAYERPHYSICS
1328 //idea: LordHavoc
1329 //darkplaces implementation: LordHavoc
1330 //field definitions:
1331 .vector movement;
1332 //cvar definitions:
1333 //"sv_playerphysicsqc" (0/1, default 1, allows user to disable qc player physics)
1334 //engine-called QC prototypes:
1335 //void() SV_PlayerPhysics;
1336 //description:
1337 //.movement vector contains the movement input from the player, allowing QC to do as it wishs with the input, and SV_PlayerPhysics will completely replace the player physics if present (works for all MOVETYPE's), see darkplaces mod source for example of this function (in playermovement.qc, adds HalfLife ladders support, as well as acceleration/deceleration while airborn (rather than the quake sudden-stop while airborn), and simplifies the physics a bit)
1338
1339 //DP_SV_PRINT
1340 //idea: id Software (QuakeWorld Server)
1341 //darkplaces implementation: Black, LordHavoc
1342 void(string s, ...) print = #339; // same number as in EXT_CSQC
1343 //description:
1344 //this is identical to dprint except that it always prints regardless of the developer cvar.
1345
1346 //DP_SV_PRECACHEANYTIME
1347 //idea: id Software (Quake2)
1348 //darkplaces implementation: LordHavoc
1349 //description:
1350 //this extension allows precache_model and precache_sound (and any variants) to be used during the game (with automatic messages to clients to precache the new model/sound indices), also setmodel/sound/ambientsound can be called without precaching first (they will cause an automatic precache).
1351
1352 //DP_SV_QCSTATUS
1353 //idea: div0
1354 //darkplaces implementation: div0
1355 //1. A global variable
1356 string worldstatus;
1357 //Its content is set as "qcstatus" field in the rules.
1358 //It may be at most 255 characters, and must not contain newlines or backslashes.
1359 //2. A per-client field
1360 .string clientstatus;
1361 //It is sent instead of the "frags" in status responses.
1362 //It should always be set in a way so that stof(player.clientstatus) is a meaningful score value. Other info may be appended. If used this way, the cvar sv_status_use_qcstatus may be set to 1, and then this value will replace the frags in "status".
1363 //Currently, qstat does not support this and will not show player info if used and set to anything other than ftos(some integer).
1364
1365 //DP_SV_ROTATINGBMODEL
1366 //idea: id Software
1367 //darkplaces implementation: LordHavoc
1368 //description:
1369 //this extension merely indicates that MOVETYPE_PUSH supports avelocity, allowing rotating brush models to be created, they rotate around their origin (needs rotation supporting qbsp/light utilities because id ones expected bmodel entity origins to be '0 0 0', recommend setting "origin" key in the entity fields in the map before compiling, there may be other methods depending on your qbsp, most are more complicated however).
1370 //tip: level designers can create a func_wall with an origin, and avelocity (for example "avelocity" "0 90 0"), and "nextthink" "99999999" to make a rotating bmodel without any qc modifications, such entities will be solid in stock quake but will not rotate)
1371
1372 //DP_SV_SETCOLOR
1373 //idea: LordHavoc
1374 //darkplaces implementation: LordHavoc
1375 //builtin definitions:
1376 void(entity ent, float colors) setcolor = #401;
1377 //engine called QC functions (optional):
1378 //void(float color) SV_ChangeTeam;
1379 //description:
1380 //setcolor sets the color on a client and updates internal color information accordingly (equivilant to stuffing a "color" command but immediate)
1381 //SV_ChangeTeam is called by the engine whenever a "color" command is recieved, it may decide to do anything it pleases with the color passed by the client, including rejecting it (by doing nothing), or calling setcolor to apply it, preventing team changes is one use for this.
1382 //the color format is pants + shirt * 16 (0-255 potentially)
1383
1384 //DP_SV_SLOWMO
1385 //idea: LordHavoc
1386 //darkplaces implementation: LordHavoc
1387 //cvars:
1388 //"slowmo" (0+, default 1)
1389 //description:
1390 //sets the time scale of the server, mainly intended for use in singleplayer by the player, however potentially useful for mods, so here's an extension for it.
1391 //range is 0 to infinite, recommended values to try are 0.1 (very slow, 10% speed), 1 (normal speed), 5 (500% speed).
1392
1393 //DP_SV_WRITEPICTURE
1394 //idea: div0
1395 //darkplaces implementation: div0
1396 //builtin definitions:
1397 void(float to, string s, float sz) WritePicture = #501;
1398 //description:
1399 //writes a picture to the data stream so CSQC can read it using ReadPicture, which has the definition
1400 //  string(void) ReadPicture = #501;
1401 //The picture data is sent as at most sz bytes, by compressing to low quality
1402 //JPEG. The data being sent will be equivalent to:
1403 //  WriteString(to, s);
1404 //  WriteShort(to, imagesize);
1405 //  for(i = 0; i < imagesize; ++i)
1406 //    WriteByte(to, [the i-th byte of the compressed JPEG image]);
1407
1408 //DP_SV_WRITEUNTERMINATEDSTRING
1409 //idea: FrikaC
1410 //darkplaces implementation: Sajt
1411 //builtin definitions:
1412 void(float to, string s) WriteUnterminatedString = #456;
1413 //description:
1414 //like WriteString, but does not write a terminating 0 after the string. This means you can include things like a player's netname in the middle of a string sent over the network. Just be sure to end it up with either a call to WriteString (which includes the trailing 0) or WriteByte(0) to terminate it yourself.
1415 //A historical note: this extension was suggested by FrikaC years ago, more recently Shadowalker has been badmouthing LordHavoc and Spike for stealing 'his' extension writestring2 which does exactly the same thing but uses a different builtin number and name and extension string, this argument hinges on the idea that it was his idea in the first place, which is incorrect as FrikaC first suggested it and used a rough equivilant of it in his FrikBot mod years ago involving WriteByte calls on each character.
1416
1417 //DP_TE_BLOOD
1418 //idea: LordHavoc
1419 //darkplaces implementation: LordHavoc
1420 //builtin definitions:
1421 void(vector org, vector velocity, float howmany) te_blood = #405;
1422 //temp entity definitions:
1423 float TE_BLOOD = 50;
1424 //protocol:
1425 //vector origin
1426 //byte xvelocity (-128 to +127)
1427 //byte yvelocity (-128 to +127)
1428 //byte zvelocity (-128 to +127)
1429 //byte count (0 to 255, how much blood)
1430 //description:
1431 //creates a blood effect.
1432
1433 //DP_TE_BLOODSHOWER
1434 //idea: LordHavoc
1435 //darkplaces implementation: LordHavoc
1436 //builtin definitions:
1437 void(vector mincorner, vector maxcorner, float explosionspeed, float howmany) te_bloodshower = #406;
1438 //temp entity definitions:
1439 //float TE_BLOODSHOWER = 52;
1440 //protocol:
1441 //vector mins (minimum corner of the cube)
1442 //vector maxs (maximum corner of the cube)
1443 //coord explosionspeed (velocity of blood particles flying out of the center)
1444 //short count (number of blood particles)
1445 //description:
1446 //creates an exploding shower of blood, for making gibbings more convincing.
1447
1448 //DP_TE_CUSTOMFLASH
1449 //idea: LordHavoc
1450 //darkplaces implementation: LordHavoc
1451 //builtin definitions:
1452 void(vector org, float radius, float lifetime, vector color) te_customflash = #417;
1453 //temp entity definitions:
1454 //float TE_CUSTOMFLASH = 73;
1455 //protocol:
1456 //vector origin
1457 //byte radius ((MSG_ReadByte() + 1) * 8, meaning 8-2048 unit radius)
1458 //byte lifetime ((MSG_ReadByte() + 1) / 256.0, meaning approximately 0-1 second lifetime)
1459 //byte red (0.0 to 1.0 converted to 0-255)
1460 //byte green (0.0 to 1.0 converted to 0-255)
1461 //byte blue (0.0 to 1.0 converted to 0-255)
1462 //description:
1463 //creates a customized light flash.
1464
1465 //DP_TE_EXPLOSIONRGB
1466 //idea: LordHavoc
1467 //darkplaces implementation: LordHavoc
1468 //builtin definitions:
1469 void(vector org, vector color) te_explosionrgb = #407;
1470 //temp entity definitions:
1471 //float TE_EXPLOSIONRGB = 53;
1472 //protocol:
1473 //vector origin
1474 //byte red (0.0 to 1.0 converted to 0 to 255)
1475 //byte green (0.0 to 1.0 converted to 0 to 255)
1476 //byte blue (0.0 to 1.0 converted to 0 to 255)
1477 //description:
1478 //creates a colored explosion effect.
1479
1480 //DP_TE_FLAMEJET
1481 //idea: LordHavoc
1482 //darkplaces implementation: LordHavoc
1483 //builtin definitions:
1484 void(vector org, vector vel, float howmany) te_flamejet = #457;
1485 //temp entity definitions:
1486 //float TE_FLAMEJET = 74;
1487 //protocol:
1488 //vector origin
1489 //vector velocity
1490 //byte count (0 to 255, how many flame particles)
1491 //description:
1492 //creates a single puff of flame particles.  (not very useful really)
1493
1494 //DP_TE_PARTICLECUBE
1495 //idea: LordHavoc
1496 //darkplaces implementation: LordHavoc
1497 //builtin definitions:
1498 void(vector mincorner, vector maxcorner, vector vel, float howmany, float color, float gravityflag, float randomveljitter) te_particlecube = #408;
1499 //temp entity definitions:
1500 //float TE_PARTICLECUBE = 54;
1501 //protocol:
1502 //vector mins (minimum corner of the cube)
1503 //vector maxs (maximum corner of the cube)
1504 //vector velocity
1505 //short count
1506 //byte color (palette color)
1507 //byte gravity (TRUE or FALSE, FIXME should this be a scaler instead?)
1508 //coord randomvel (how much to jitter the velocity)
1509 //description:
1510 //creates a cloud of particles, useful for forcefields but quite customizable.
1511
1512 //DP_TE_PARTICLERAIN
1513 //idea: LordHavoc
1514 //darkplaces implementation: LordHavoc
1515 //builtin definitions:
1516 void(vector mincorner, vector maxcorner, vector vel, float howmany, float color) te_particlerain = #409;
1517 //temp entity definitions:
1518 //float TE_PARTICLERAIN = 55;
1519 //protocol:
1520 //vector mins (minimum corner of the cube)
1521 //vector maxs (maximum corner of the cube)
1522 //vector velocity (velocity of particles)
1523 //short count (number of particles)
1524 //byte color (8bit palette color)
1525 //description:
1526 //creates a shower of rain, the rain will appear either at the top (if falling down) or bottom (if falling up) of the cube.
1527
1528 //DP_TE_PARTICLESNOW
1529 //idea: LordHavoc
1530 //darkplaces implementation: LordHavoc
1531 //builtin definitions:
1532 void(vector mincorner, vector maxcorner, vector vel, float howmany, float color) te_particlesnow = #410;
1533 //temp entity definitions:
1534 //float TE_PARTICLERAIN = 56;
1535 //protocol:
1536 //vector mins (minimum corner of the cube)
1537 //vector maxs (maximum corner of the cube)
1538 //vector velocity (velocity of particles)
1539 //short count (number of particles)
1540 //byte color (8bit palette color)
1541 //description:
1542 //creates a shower of snow, the snow will appear either at the top (if falling down) or bottom (if falling up) of the cube, low velocities are advisable for convincing snow.
1543
1544 //DP_TE_PLASMABURN
1545 //idea: LordHavoc
1546 //darkplaces implementation: LordHavoc
1547 //builtin definitions:
1548 void(vector org) te_plasmaburn = #433;
1549 //temp entity definitions:
1550 //float TE_PLASMABURN = 75;
1551 //protocol:
1552 //vector origin
1553 //description:
1554 //creates a small light flash (radius 200, time 0.2) and marks the walls.
1555
1556 //DP_TE_QUADEFFECTS1
1557 //idea: LordHavoc
1558 //darkplaces implementation: LordHavoc
1559 //builtin definitions:
1560 void(vector org) te_gunshotquad = #412;
1561 void(vector org) te_spikequad = #413;
1562 void(vector org) te_superspikequad = #414;
1563 void(vector org) te_explosionquad = #415;
1564 //temp entity definitions:
1565 //float   TE_GUNSHOTQUAD  = 57; // [vector] origin
1566 //float   TE_SPIKEQUAD    = 58; // [vector] origin
1567 //float   TE_SUPERSPIKEQUAD = 59; // [vector] origin
1568 //float   TE_EXPLOSIONQUAD = 70; // [vector] origin
1569 //protocol:
1570 //vector origin
1571 //description:
1572 //all of these just take a location, and are equivilant in function (but not appearance :) to the original TE_GUNSHOT, etc.
1573
1574 //DP_TE_SMALLFLASH
1575 //idea: LordHavoc
1576 //darkplaces implementation: LordHavoc
1577 //builtin definitions:
1578 void(vector org) te_smallflash = #416;
1579 //temp entity definitions:
1580 //float TE_SMALLFLASH = 72;
1581 //protocol:
1582 //vector origin
1583 //description:
1584 //creates a small light flash (radius 200, time 0.2).
1585
1586 //DP_TE_SPARK
1587 //idea: LordHavoc
1588 //darkplaces implementation: LordHavoc
1589 //builtin definitions:
1590 void(vector org, vector vel, float howmany) te_spark = #411;
1591 //temp entity definitions:
1592 //float TE_SPARK = 51;
1593 //protocol:
1594 //vector origin
1595 //byte xvelocity (-128 to 127)
1596 //byte yvelocity (-128 to 127)
1597 //byte zvelocity (-128 to 127)
1598 //byte count (number of sparks)
1599 //description:
1600 //creates a shower of sparks and a smoke puff.
1601
1602 //DP_TE_STANDARDEFFECTBUILTINS
1603 //idea: LordHavoc
1604 //darkplaces implementation: LordHavoc
1605 //builtin definitions:
1606 void(vector org) te_gunshot = #418;
1607 void(vector org) te_spike = #419;
1608 void(vector org) te_superspike = #420;
1609 void(vector org) te_explosion = #421;
1610 void(vector org) te_tarexplosion = #422;
1611 void(vector org) te_wizspike = #423;
1612 void(vector org) te_knightspike = #424;
1613 void(vector org) te_lavasplash = #425;
1614 void(vector org) te_teleport = #426;
1615 void(vector org, float color, float colorlength) te_explosion2 = #427;
1616 void(entity own, vector start, vector end) te_lightning1 = #428;
1617 void(entity own, vector start, vector end) te_lightning2 = #429;
1618 void(entity own, vector start, vector end) te_lightning3 = #430;
1619 void(entity own, vector start, vector end) te_beam = #431;
1620 //description:
1621 //to make life easier on mod coders.
1622
1623 //DP_TRACE_HITCONTENTSMASK_SURFACEINFO
1624 //idea: LordHavoc
1625 //darkplaces implementation: LordHavoc
1626 //globals:
1627 .float dphitcontentsmask; // if non-zero on the entity passed to traceline/tracebox/tracetoss this will override the normal collidable contents rules and instead hit these contents values (for example AI can use tracelines that hit DONOTENTER if it wants to, by simply changing this field on the entity passed to traceline), this affects normal movement as well as trace calls
1628 float trace_dpstartcontents; // DPCONTENTS_ value at start position of trace
1629 float trace_dphitcontents; // DPCONTENTS_ value of impacted surface (not contents at impact point, just contents of the surface that was hit)
1630 float trace_dphitq3surfaceflags; // Q3SURFACEFLAG_ value of impacted surface
1631 string trace_dphittexturename; // texture name of impacted surface
1632 //constants:
1633 float DPCONTENTS_SOLID = 1; // hit a bmodel, not a bounding box
1634 float DPCONTENTS_WATER = 2;
1635 float DPCONTENTS_SLIME = 4;
1636 float DPCONTENTS_LAVA = 8;
1637 float DPCONTENTS_SKY = 16;
1638 float DPCONTENTS_BODY = 32; // hit a bounding box, not a bmodel
1639 float DPCONTENTS_CORPSE = 64; // hit a SOLID_CORPSE entity
1640 float DPCONTENTS_NODROP = 128; // an area where backpacks should not spawn
1641 float DPCONTENTS_PLAYERCLIP = 256; // blocks player movement
1642 float DPCONTENTS_MONSTERCLIP = 512; // blocks monster movement
1643 float DPCONTENTS_DONOTENTER = 1024; // AI hint brush
1644 float DPCONTENTS_LIQUIDSMASK = 14; // WATER | SLIME | LAVA
1645 float Q3SURFACEFLAG_NODAMAGE = 1;
1646 float Q3SURFACEFLAG_SLICK = 2; // low friction surface
1647 float Q3SURFACEFLAG_SKY = 4; // sky surface (also has NOIMPACT and NOMARKS set)
1648 float Q3SURFACEFLAG_LADDER = 8; // climbable surface
1649 float Q3SURFACEFLAG_NOIMPACT = 16; // projectiles should remove themselves on impact (this is set on sky)
1650 float Q3SURFACEFLAG_NOMARKS = 32; // projectiles should not leave marks, such as decals (this is set on sky)
1651 float Q3SURFACEFLAG_FLESH = 64; // projectiles should do a fleshy effect (blood?) on impact
1652 //float Q3SURFACEFLAG_NODRAW = 128; // compiler hint (not important to qc)
1653 //float Q3SURFACEFLAG_HINT = 256; // compiler hint (not important to qc)
1654 //float Q3SURFACEFLAG_SKIP = 512; // compiler hint (not important to qc)
1655 //float Q3SURFACEFLAG_NOLIGHTMAP = 1024; // compiler hint (not important to qc)
1656 //float Q3SURFACEFLAG_POINTLIGHT = 2048; // compiler hint (not important to qc)
1657 float Q3SURFACEFLAG_METALSTEPS = 4096; // walking on this surface should make metal step sounds
1658 float Q3SURFACEFLAG_NOSTEPS = 8192; // walking on this surface should not make footstep sounds
1659 //float Q3SURFACEFLAG_NONSOLID = 16384; // compiler hint (not important to qc)
1660 //float Q3SURFACEFLAG_LIGHTFILTER = 32768; // compiler hint (not important to qc)
1661 //float Q3SURFACEFLAG_ALPHASHADOW = 65536; // compiler hint (not important to qc)
1662 //float Q3SURFACEFLAG_NODLIGHT = 131072; // compiler hint (not important to qc)
1663 //float Q3SURFACEFLAG_DUST = 262144; // translucent 'light beam' effect (not important to qc)
1664 //description:
1665 //adds additional information after a traceline/tracebox/tracetoss call.
1666 //also (very important) sets trace_* globals before calling .touch functions,
1667 //this allows them to inspect the nature of the collision (for example
1668 //determining if a projectile hit sky), clears trace_* variables for the other
1669 //object in a touch event (that is to say, a projectile moving will see the
1670 //trace results in its .touch function, but the player it hit will see very
1671 //little information in the trace_ variables as it was not moving at the time)
1672
1673 //DP_VIEWZOOM
1674 //idea: LordHavoc
1675 //darkplaces implementation: LordHavoc
1676 //field definitions:
1677 .float viewzoom;
1678 //description:
1679 //scales fov and sensitivity of player, valid range is 0 to 1 (intended for sniper rifle zooming, and such)
1680
1681 //EXT_BITSHIFT
1682 //idea: Spike
1683 //darkplaces implementation: [515]
1684 //builtin definitions:
1685 float(float number, float quantity) bitshift = #218;
1686 //description:
1687 //multiplies number by a power of 2 corresponding to quantity (0 = *1, 1 = *2, 2 = *4, 3 = *8, -1 = /2, -2 = /4x, etc), and rounds down (due to integer math) like other bit operations do (& and | and the like).
1688 //note: it is faster to use multiply if you are shifting by a constant, avoiding the quakec function call cost, however that does not do a floor for you.
1689
1690 //FRIK_FILE
1691 //idea: FrikaC
1692 //darkplaces implementation: LordHavoc
1693 //builtin definitions:
1694 float(string s) stof = #81; // get numerical value from a string
1695 float(string filename, float mode) fopen = #110; // opens a file inside quake/gamedir/data/ (mode is FILE_READ, FILE_APPEND, or FILE_WRITE), returns fhandle >= 0 if successful, or fhandle < 0 if unable to open file for any reason
1696 void(float fhandle) fclose = #111; // closes a file
1697 string(float fhandle) fgets = #112; // reads a line of text from the file and returns as a tempstring
1698 void(float fhandle, string s, ...) fputs = #113; // writes a line of text to the end of the file
1699 float(string s) strlen = #114; // returns how many characters are in a string
1700 string(string s1, string s2, ...) strcat = #115; // concatenates two or more strings (for example "abc", "def" would return "abcdef") and returns as a tempstring
1701 string(string s, float start, float length) substring = #116; // returns a section of a string as a tempstring
1702 vector(string s) stov = #117; // returns vector value from a string
1703 string(string s, ...) strzone = #118; // makes a copy of a string into the string zone and returns it, this is often used to keep around a tempstring for longer periods of time (tempstrings are replaced often)
1704 void(string s) strunzone = #119; // removes a copy of a string from the string zone (you can not use that string again or it may crash!!!)
1705 //constants:
1706 float FILE_READ = 0;
1707 float FILE_APPEND = 1;
1708 float FILE_WRITE = 2;
1709 //cvars:
1710 //pr_zone_min_strings : default 64 (64k), min 64 (64k), max 8192 (8mb)
1711 //description:
1712 //provides text file access functions and string manipulation functions, note that you may want to set pr_zone_min_strings in the worldspawn function if 64k is not enough string zone space.
1713 //
1714 //NOTE: strzone functionality is partially superseded by
1715 //DP_QC_UNLIMITEDTEMPSTRINGS when longterm storage is not needed
1716
1717 //KRIMZON_SV_PARSECLIENTCOMMAND
1718 //idea: KrimZon
1719 //darkplaces implementation: KrimZon, LordHavoc
1720 //engine-called QC prototypes:
1721 //void(string s) SV_ParseClientCommand;
1722 //builtin definitions:
1723 void(entity e, string s) clientcommand = #440;
1724 float(string s) tokenize = #441;
1725 string(float n) argv = #442;
1726 //description:
1727 //provides QC the ability to completely control server interpretation of client commands ("say" and "color" for example, clientcommand is necessary for this and substring (FRIK_FILE) is useful) as well as adding new commands (tokenize, argv, and stof (FRIK_FILE) are useful for this)), whenever a clc_stringcmd is received the QC function is called, and it is up to the QC to decide what (if anything) to do with it
1728
1729 //NEH_CMD_PLAY2
1730 //idea: Nehahra
1731 //darkplaces implementation: LordHavoc
1732 //description:
1733 //shows that the engine supports the "play2" console command (plays a sound without spatialization).
1734
1735 //NEH_RESTOREGAME
1736 //idea: Nehahra
1737 //darkplaces implementation: LordHavoc
1738 //engine-called QC prototypes:
1739 //void() RestoreGame;
1740 //description:
1741 //when a savegame is loaded, this function is called
1742
1743 //NEXUIZ_PLAYERMODEL
1744 //idea: Nexuiz
1745 //darkplaces implementation: Black
1746 //console commands:
1747 //playermodel <name> - FIXME: EXAMPLE NEEDED
1748 //playerskin <name> - FIXME: EXAMPLE NEEDED
1749 //field definitions:
1750 .string playermodel; // name of player model sent by client
1751 .string playerskin; // name of player skin sent by client
1752 //description:
1753 //these client properties are used by Nexuiz.
1754
1755 //NXQ_GFX_LETTERBOX
1756 //idea: nxQuake
1757 //darkplaces implementation: LordHavoc
1758 //description:
1759 //shows that the engine supports the "r_letterbox" console variable, set to values in the range 0-100 this restricts the view vertically (and turns off sbar and crosshair), value is a 0-100 percentage of how much to constrict the view, <=0 = normal view height, 25 = 75% of normal view height, 50 = 50%, 75 = 25%, >=100 = no view
1760
1761 //PRYDON_CLIENTCURSOR
1762 //idea: FrikaC
1763 //darkplaces implementation: LordHavoc
1764 //effects bit:
1765 float EF_SELECTABLE = 16384; // allows cursor to highlight entity (brighten)
1766 //field definitions:
1767 .float cursor_active; // true if cl_prydoncursor mode is on
1768 .vector cursor_screen; // screen position of cursor as -1 to +1 in _x and _y (_z unused)
1769 .vector cursor_trace_start; // position of camera
1770 .vector cursor_trace_endpos; // position of cursor in world (as traced from camera)
1771 .entity cursor_trace_ent; // entity the cursor is pointing at (server forces this to world if the entity is currently free at time of receipt)
1772 //cvar definitions:
1773 //cl_prydoncursor (0/1+, default 0, 1 and above use cursors named gfx/prydoncursor%03i.lmp - or .tga and such if DP_GFX_EXTERNALTEXTURES is implemented)
1774 //description:
1775 //shows that the engine supports the cl_prydoncursor cvar, this puts a clientside mouse pointer on the screen and feeds input to the server for the QuakeC to use as it sees fit.
1776 //the mouse pointer triggers button4 if cursor is at left edge of screen, button5 if at right edge of screen, button6 if at top edge of screen, button7 if at bottom edge of screen.
1777 //the clientside trace skips transparent entities (except those marked EF_SELECTABLE).
1778 //the selected entity highlights only if EF_SELECTABLE is set, a typical selection method would be doubling the brightness of the entity by some means (such as colormod[] *= 2).
1779 //intended to be used by Prydon Gate.
1780
1781 //TENEBRAE_GFX_DLIGHTS
1782 //idea: Tenebrae
1783 //darkplaces implementation: LordHavoc
1784 //fields:
1785 .float light_lev; // radius (does not affect brightness), typical value 350
1786 .vector color; // color (does not affect radius), typical value '1 1 1' (bright white), can be up to '255 255 255' (nuclear blast)
1787 .float style; // light style (like normal light entities, flickering torches or switchable, etc)
1788 .float pflags; // flags (see PFLAGS_ constants)
1789 .vector angles; // orientation of the light
1790 .float skin; // cubemap filter number, can be 1-255 (0 is assumed to be none, and tenebrae only allows 16-255), this selects a projective light filter, a value of 1 loads cubemaps/1posx.tga and cubemaps/1negx.tga and posy, negy, posz, and negz, similar to skybox but some sides need to be rotated or flipped
1791 //constants:
1792 float PFLAGS_NOSHADOW = 1; // light does not cast shadows
1793 float PFLAGS_CORONA = 2; // light has a corona flare
1794 float PFLAGS_FULLDYNAMIC = 128; // light enable (without this set no light is produced!)
1795 //description:
1796 //more powerful dynamic light settings
1797 //warning: it is best not to use cubemaps on a light entity that has a model, as using a skin number that a model does not have will cause issues in glquake, and produce warnings in darkplaces (use developer 1 to see them)
1798 //changes compared to tenebrae (because they're too 'leet' for standards):
1799 //note: networking should send entities with PFLAGS_FULLDYNAMIC set even if they have no model (lights in general do not have a model, nor should they)
1800 //EF_FULLDYNAMIC effects flag replaced by PFLAGS_FULLDYNAMIC flag (EF_FULLDYNAMIC conflicts with EF_NODRAW)
1801
1802 //TW_SV_STEPCONTROL
1803 //idea: Transfusion
1804 //darkplaces implementation: LordHavoc
1805 //cvars:
1806 //sv_jumpstep (0/1, default 1)
1807 //sv_stepheight (default 18)
1808 //description:
1809 //sv_jumpstep allows stepping up onto stairs while airborn, sv_stepheight controls how high a single step can be.
1810
1811 //FTE_QC_CHECKPVS
1812 //idea: Urre
1813 //darkplaces implementation: div0
1814 //builtin definitions:
1815 float checkpvs(vector viewpos, entity viewee) = #240;
1816 //description:
1817 //returns true if viewee can be seen from viewpos according to PVS data
1818
1819 //FTE_STRINGS
1820 //idea: many
1821 //darkplaces implementation: KrimZon
1822 //description:
1823 //various string manipulation functions
1824 float(string str, string sub, float startpos) strstrofs = #221;
1825 float(string str, float ofs) str2chr = #222;
1826 string(float c, ...) chr2str = #223;
1827 string(float ccase, float calpha, float cnum, string s, ...) strconv = #224;
1828 string(float chars, string s, ...) strpad = #225;
1829 string(string info, string key, string value, ...) infoadd = #226;
1830 string(string info, string key) infoget = #227;
1831 float(string s1, string s2, float len) strncmp = #228;
1832 float(string s1, string s2) strcasecmp = #229;
1833 float(string s1, string s2, float len) strncasecmp = #230;
1834
1835 //DP_CON_BESTWEAPON
1836 //idea: many
1837 //darkplaces implementation: div0
1838 //description:
1839 //allows QC to register weapon properties for use by the bestweapon command, for mods that change required ammo count or type for the weapons
1840 //it is done using console commands sent via stuffcmd:
1841 //  register_bestweapon quake
1842 //  register_bestweapon clear
1843 //  register_bestweapon <shortname> <impulse> <itemcode> <activeweaponcode> <ammostat> <ammomin>
1844 //for example, this is what Quake uses:
1845 //  register_bestweapon 1 1 4096 4096 6 0 // STAT_SHELLS is 6
1846 //  register_bestweapon 2 2    1    1 6 1
1847 //  register_bestweapon 3 3    2    2 6 1
1848 //  register_bestweapon 4 4    4    4 7 1 // STAT_NAILS is 7
1849 //  register_bestweapon 5 5    8    8 7 1
1850 //  register_bestweapon 6 6   16   16 8 1 // STAT_ROCKETS is 8
1851 //  register_bestweapon 7 7   32   32 8 1
1852 //  register_bestweapon 8 8   64   64 9 1 // STAT_CELLS is 9
1853 //after each map client initialization, this is reset back to Quake settings. So you should send these data in ClientConnect.
1854 //also, this extension introduces a new "cycleweapon" command to the user.
1855
1856 //DP_QC_STRINGBUFFERS
1857 //idea: ??
1858 //darkplaces implementation: LordHavoc
1859 //functions to manage string buffer objects - that is, arbitrary length string arrays that are handled by the engine
1860 float() buf_create = #460;
1861 void(float bufhandle) buf_del = #461;
1862 float(float bufhandle) buf_getsize = #462;
1863 void(float bufhandle_from, float bufhandle_to) buf_copy = #463;
1864 void(float bufhandle, float sortpower, float backward) buf_sort = #464;
1865 string(float bufhandle, string glue) buf_implode = #465;
1866 string(float bufhandle, float string_index) bufstr_get = #466;
1867 void(float bufhandle, float string_index, string str) bufstr_set = #467;
1868 float(float bufhandle, string str, float order) bufstr_add = #468;
1869 void(float bufhandle, float string_index) bufstr_free = #469;
1870
1871 //DP_QC_STRINGBUFFERS_CVARLIST
1872 //idea: div0
1873 //darkplaces implementation: div0
1874 //functions to list cvars and store their names into a stringbuffer
1875 //cvars that start with pattern but not with antipattern will be stored into the buffer
1876 void(float bufhandle, string pattern, string antipattern) buf_cvarlist = #517;
1877
1878 //DP_QC_STRREPLACE
1879 //idea: Sajt
1880 //darkplaces implementation: Sajt
1881 //builtin definitions:
1882 string(string search, string replace, string subject) strreplace = #484;
1883 string(string search, string replace, string subject) strireplace = #485;
1884 //description:
1885 //strreplace replaces all occurrences of 'search' with 'replace' in the string 'subject', and returns the result as a tempstring.
1886 //strireplace does the same but uses case-insensitive matching of the 'search' term
1887 //
1888 //DP_QC_CRC16
1889 //idea: div0
1890 //darkplaces implementation: div0
1891 //Some hash function to build hash tables with. This has to be be the CRC-16-CCITT that is also required for the QuakeWorld download protocol.
1892 //When caseinsensitive is set, the CRC is calculated of the lower cased string.
1893 float(float caseinsensitive, string s, ...) crc16 = #494;
1894
1895 //DP_SV_SHUTDOWN
1896 //idea: div0
1897 //darkplaces implementation: div0
1898 //A function that gets called just before progs exit. To save persistent data from.
1899 //It is not called on a crash or error.
1900 //void SV_Shutdown();
1901
1902 //EXT_CSQC
1903 // #232 void(float index, float type, .void field) SV_AddStat (EXT_CSQC)
1904 void(float index, float type, ...) addstat = #232;
1905
1906 //ZQ_PAUSE
1907 //idea: ZQuake
1908 //darkplaces implementation: GreEn`mArine
1909 //builtin definitions:
1910 void(float pause) setpause = #531;
1911 //function definitions:
1912 //void(float elapsedtime) SV_PausedTic;
1913 //description:
1914 //during pause the world is not updated (time does not advance), SV_PausedTic is the only function you can be sure will be called at regular intervals during the pause, elapsedtime is the current system time in seconds since the pause started (not affected by slowmo or anything else).
1915 //
1916 //calling setpause(0) will end a pause immediately.
1917 //
1918 //Note: it is worth considering that network-related functions may be called during the pause (including customizeentityforclient for example), and it is also important to consider the continued use of the KRIMZON_SV_PARSECLIENTCOMMAND extension while paused (chatting players, etc), players may also join/leave during the pause.  In other words, the only things that are not called are think and other time-related functions.
1919