Crypto: handle properly whether the a server key is signed or not.
[xonotic/darkplaces.git] / dpdefs / dpextensions.qc
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_DYNAMICMODELLIGHT
117 //idea: C.Brutail, divVerent, maikmerten
118 //darkplaces implementation: divVerent
119 //effects bit:
120 float   EF_DYNAMICMODELLIGHT     = 131072;
121 //description:
122 //force dynamic model light on the entity, even if it's a BSP model (or anything else with lightmaps or light colors)
123
124 //DP_EF_FLAME
125 //idea: LordHavoc
126 //darkplaces implementation: LordHavoc
127 //effects bit:
128 float   EF_FLAME        = 1024;
129 //description:
130 //entity is on fire
131
132 //DP_EF_FULLBRIGHT
133 //idea: LordHavoc
134 //darkplaces implementation: LordHavoc
135 //effects bit:
136 float   EF_FULLBRIGHT   = 512;
137 //description:
138 //entity is always brightly lit
139
140 //DP_EF_NODEPTHTEST
141 //idea: Supa
142 //darkplaces implementation: LordHavoc
143 //effects bit:
144 float   EF_NODEPTHTEST       = 8192;
145 //description:
146 //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
147
148 //DP_EF_NODRAW
149 //idea: id Software
150 //darkplaces implementation: LordHavoc
151 //effects bit:
152 float   EF_NODRAW       = 16;
153 //description:
154 //prevents server from sending entity to client (forced invisible, even if it would have been a light source or other such things)
155
156 //DP_EF_NOGUNBOB
157 //idea: Chris Page, Dresk
158 //darkplaces implementation: LordHAvoc
159 //effects bit:
160 float   EF_NOGUNBOB     = 256;
161 //description:
162 //this has different meanings depending on the entity it is used on:
163 //player entity - prevents gun bobbing on player.viewmodel
164 //viewmodelforclient entity - prevents gun bobbing on an entity attached to the player's view
165 //other entities - no effect
166 //uses:
167 //disabling gun bobbing on a diving mask or other model used as a .viewmodel.
168 //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)
169
170 //DP_EF_NOSHADOW
171 //idea: LordHavoc
172 //darkplaces implementation: LordHavoc
173 //effects bit:
174 float   EF_NOSHADOW     = 4096;
175 //description:
176 //realtime lights will not cast shadows from this entity (but can still illuminate it)
177
178 //DP_EF_RED
179 //idea: id Software
180 //darkplaces implementation: LordHavoc
181 //effects bit:
182 float   EF_RED          = 128;
183 //description:
184 //entity emits red light (used for invulnerability)
185
186 //DP_EF_RESTARTANIM_BIT
187 //idea: id software
188 //darkplaces implementation: divVerent
189 //effects bit:
190 float   EF_RESTARTANIM_BIT = 1048576;
191 //description:
192 //when toggled, the current animation is restarted. Useful for weapon animation.
193 //to toggle this bit in QC, you can do:
194 //  self.effects += (EF_RESTARTANIM_BIT - 2 * (self.effects & EF_RESTARTANIM_BIT));
195
196 //DP_EF_STARDUST
197 //idea: MythWorks Inc
198 //darkplaces implementation: LordHavoc
199 //effects bit:
200 float   EF_STARDUST     = 2048;
201 //description:
202 //entity emits bouncing sparkles in every direction
203
204 //DP_EF_TELEPORT_BIT
205 //idea: id software
206 //darkplaces implementation: divVerent
207 //effects bit:
208 float   EF_TELEPORT_BIT = 2097152;
209 //description:
210 //when toggled, interpolation of the entity is skipped for one frame. Useful for teleporting.
211 //to toggle this bit in QC, you can do:
212 //  self.effects += (EF_TELEPORT_BIT - 2 * (self.effects & EF_TELEPORT_BIT));
213
214 //DP_ENT_ALPHA
215 //idea: Nehahra
216 //darkplaces implementation: LordHavoc
217 //fields:
218 .float alpha;
219 //description:
220 //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).
221
222 //DP_ENT_COLORMOD
223 //idea: LordHavoc
224 //darkplaces implementation: LordHavoc
225 //field definition:
226 .vector colormod;
227 //description:
228 //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).
229
230 //DP_ENT_CUSTOMCOLORMAP
231 //idea: LordHavoc
232 //darkplaces implementation: LordHavoc
233 //description:
234 //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.
235
236 /*
237 //NOTE: no longer supported by darkplaces because all entities are delta compressed now
238 //DP_ENT_DELTACOMPRESS // no longer supported
239 //idea: LordHavoc
240 //darkplaces implementation: LordHavoc
241 //effects bit:
242 float EF_DELTA = 8388608;
243 //description:
244 //(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).
245 */
246
247 //DP_ENT_EXTERIORMODELTOCLIENT
248 //idea: LordHavoc
249 //darkplaces implementation: LordHavoc
250 //fields:
251 .entity exteriormodeltoclient;
252 //description:
253 //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.
254
255 //DP_ENT_GLOW
256 //idea: LordHavoc
257 //darkplaces implementation: LordHavoc
258 //field definitions:
259 .float glow_color;
260 .float glow_size;
261 .float glow_trail;
262 //description:
263 //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.
264
265 //DP_ENT_GLOWMOD
266 //idea: LordHavoc
267 //darkplaces implementation: LordHavoc
268 //field definition:
269 .vector glowmod;
270 //description:
271 //controls color of the entity's glow texture (fullbrights), '0 0 0', is forced to be '1 1 1' (otherwise everything would be black), used for tinting objects, see colormod (same color restrictions apply).
272
273 //DP_ENT_LOWPRECISION
274 //idea: LordHavoc
275 //darkplaces implementation: LordHavoc
276 //effects bit:
277 float EF_LOWPRECISION = 4194304;
278 //description:
279 //uses low quality origin coordinates, reducing network traffic compared to the default high precision, intended for numerous objects (projectiles/gibs/bullet holes/etc).
280
281 //DP_ENT_SCALE
282 //idea: LordHavoc
283 //darkplaces implementation: LordHavoc
284 //field definitions:
285 .float scale;
286 //description:
287 //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.
288
289 //DP_ENT_TRAILEFFECTNUM
290 //idea: LordHavoc
291 //darkplaces implementation: LordHavoc
292 //field definitions:
293 .float traileffectnum;
294 //description:
295 //use a custom effectinfo.txt effect on this entity, assign it like this:
296 //self.traileffectnum = particleeffectnum("mycustomeffect");
297 //this will do both the dlight and particle trail as described in the effect, basically equivalent to trailparticles() in CSQC but performed on a server entity.
298
299 //DP_ENT_VIEWMODEL
300 //idea: LordHavoc
301 //darkplaces implementation: LordHavoc
302 //field definitions:
303 .entity viewmodelforclient;
304 //description:
305 //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.
306
307 //DP_GFX_EXTERNALTEXTURES
308 //idea: LordHavoc
309 //darkplaces implementation: LordHavoc
310 //description:
311 //loads external textures found in various directories (tenebrae compatible)...
312 /*
313 in all examples .tga is merely the base texture, it can be any of these:
314 .tga (base texture)
315 _glow.tga (fullbrights or other glowing overlay stuff, NOTE: this is done using additive blend, not alpha)
316 _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)
317 _shirt.tga (same idea as pants, but for shirt color)
318 _diffuse.tga (this may be used instead of base texture for per pixel lighting)
319 _gloss.tga (specular texture for per pixel lighting, note this can be in color (tenebrae only supports greyscale))
320 _norm.tga (normalmap texture for per pixel lighting)
321 _bump.tga (bumpmap, converted to normalmap at load time, supported only for reasons of tenebrae compatibility)
322 _luma.tga (same as _glow but supported only for reasons of tenebrae compatibility)
323
324 due to glquake's incomplete Targa(r) loader, this section describes
325 required Targa(r) features support:
326 types:
327 type 1 (uncompressed 8bit paletted with 24bit/32bit palette)
328 type 2 (uncompressed 24bit/32bit true color, glquake supported this)
329 type 3 (uncompressed 8bit greyscale)
330 type 9 (RLE compressed 8bit paletted with 24bit/32bit palette)
331 type 10 (RLE compressed 24bit/32bit true color, glquake supported this)
332 type 11 (RLE compressed 8bit greyscale)
333 attribute bit 0x20 (Origin At Top Left, top to bottom, left to right)
334
335 image formats guaranteed to be supported: tga, pcx, lmp
336 image formats that are optional: png, jpg
337
338 mdl/spr/spr32 examples:
339 skins are named _A (A being a number) and skingroups are named like _A_B
340 these act as suffixes on the model name...
341 example names for skin _2_1 of model "progs/armor.mdl":
342 game/override/progs/armor.mdl_2_1.tga
343 game/textures/progs/armor.mdl_2_1.tga
344 game/progs/armor.mdl_2_1.tga
345 example names for skin _0 of the model "progs/armor.mdl":
346 game/override/progs/armor.mdl_0.tga
347 game/textures/progs/armor.mdl_0.tga
348 game/progs/armor.mdl_0.tga
349 note that there can be more skins files (of the _0 naming) than the mdl
350 contains, this is only useful to save space in the .mdl file if classic quake
351 compatibility is not a concern.
352
353 bsp/md2/md3 examples:
354 example names for the texture "quake" of model "maps/start.bsp":
355 game/override/quake.tga
356 game/textures/quake.tga
357 game/quake.tga
358
359 sbar/menu/console textures: for example the texture "conchars" (console font) in gfx.wad
360 game/override/gfx/conchars.tga
361 game/textures/gfx/conchars.tga
362 game/gfx/conchars.tga
363 */
364
365 //DP_GFX_EXTERNALTEXTURES_PERMAPTEXTURES
366 //idea: Fuh?
367 //darkplaces implementation: LordHavoc
368 //description:
369 //Q1BSP and HLBSP map loading loads external textures found in textures/<mapname>/ as well as textures/.
370 //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)
371 //example:
372 //maps/e1m1.bsp uses textures in the directory textures/e1m1/ and falls back to textures/
373 //maps/b_batt0.bsp uses textures in the directory textures/b_batt0.bsp and falls back to textures/
374 //as a more extreme example:
375 //progs/something/blah.bsp uses textures in the directory textures/progs/something/blah/ and falls back to textures/
376
377 //DP_GFX_FOG
378 //idea: LordHavoc
379 //darkplaces implementation: LordHavoc
380 //worldspawn fields:
381 //"fog" (parameters: "density red green blue", example: "0.1 0.3 0.3 0.3")
382 //description:
383 //global fog for the map, can not be changed by QC
384
385 //DP_GFX_QUAKE3MODELTAGS
386 //idea: id Software
387 //darkplaces implementation: LordHavoc
388 //field definitions:
389 .entity tag_entity; // entity this is attached to (call setattachment to set this)
390 .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)
391 //builtin definitions:
392 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)
393 //description:
394 //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).
395 //note 2: if the tag is not found, it defaults to "" (attach to origin/angles of entity)
396 //note 3: attaching to world turns off attachment
397 //note 4: the entity that this is attached to must be visible for this to work
398 //note 5: if an entity is attached to the player entity it will not be drawn in first person.
399
400 //DP_GFX_SKINFILES
401 //idea: LordHavoc
402 //darkplaces implementation: LordHavoc
403 //description:
404 //alias models (mdl, md2, md3) can have .skin files to replace conventional texture naming, these have a naming format such as:
405 //progs/test.md3_0.skin
406 //progs/test.md3_1.skin
407 //...
408 //
409 //these files contain replace commands (replace meshname shadername), example:
410 //replace "helmet" "progs/test/helmet1.tga" // this is a mesh shader replacement
411 //replace "teamstripes" "progs/test/redstripes.tga"
412 //replace "visor" "common/nodraw" // this makes the visor mesh invisible
413 ////it is not possible to rename tags using this format
414 //
415 //Or the Quake3 syntax (100% compatible with Quake3's .skin files):
416 //helmet,progs/test/helmet1.tga // this is a mesh shader replacement
417 //teamstripes,progs/test/redstripes.tga
418 //visor,common/nodraw // this makes the visor mesh invisible
419 //tag_camera, // this defines that the first tag in the model is called tag_camera
420 //tag_test, // this defines that the second tag in the model is called tag_test
421 //
422 //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.
423 //this feature is intended to allow multiple skin sets on md3 models (which otherwise only have one skin set).
424 //other commands might be added someday but it is not expected.
425
426 //DP_GFX_SKYBOX
427 //idea: LordHavoc
428 //darkplaces implementation: LordHavoc
429 //worldspawn fields:
430 //"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)
431 //description:
432 //global skybox for the map, can not be changed by QC
433
434 //DP_UTF8
435 //idea: Blub\0, divVerent
436 //darkplaces implementation: Blub\0
437 //cvar definitions:
438 //   utf8_enable: enable utf8 encoding
439 //description: utf8 characters are allowed inside cvars, protocol strings, files, progs strings, etc., 
440 //and count as 1 char for string functions like strlen, substring, etc.
441 // note: utf8_enable is run-time cvar, could be changed during execution
442 // note: beware that str2chr() could return value bigger than 255 once utf8 is enabled
443
444 //DP_HALFLIFE_MAP
445 //idea: LordHavoc
446 //darkplaces implementation: LordHavoc
447 //description:
448 //simply indicates that the engine supports HalfLife maps (BSP version 30, NOT the QER RGBA ones which are also version 30).
449
450 //DP_HALFLIFE_MAP_CVAR
451 //idea: LordHavoc
452 //darkplaces implementation: LordHavoc
453 //cvars:
454 //halflifebsp 0/1
455 //description:
456 //engine sets this cvar when loading a map to indicate if it is halflife format or not.
457
458 //DP_HALFLIFE_SPRITE
459 //idea: LordHavoc
460 //darkplaces implementation: LordHavoc
461 //description:
462 //simply indicates that the engine supports HalfLife sprites.
463
464 //DP_INPUTBUTTONS
465 //idea: LordHavoc
466 //darkplaces implementation: LordHavoc
467 //field definitions:
468 .float button3;
469 .float button4;
470 .float button5;
471 .float button6;
472 .float button7;
473 .float button8;
474 .float button9;
475 .float button10;
476 .float button11;
477 .float button12;
478 .float button13;
479 .float button14;
480 .float button15;
481 .float button16;
482 //description:
483 //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).
484 //the exact mapping of protocol button bits on the server is:
485 //self.button0 = (bits & 1) != 0;
486 ///* button1 is skipped because mods abuse it as a variable, and accordingly it has no bit */
487 //self.button2 = (bits & 2) != 0;
488 //self.button3 = (bits & 4) != 0;
489 //self.button4 = (bits & 8) != 0;
490 //self.button5 = (bits & 16) != 0;
491 //self.button6 = (bits & 32) != 0;
492 //self.button7 = (bits & 64) != 0;
493 //self.button8 = (bits & 128) != 0;
494
495 // DP_LIGHTSTYLE_STATICVALUE
496 // idea: VorteX
497 // darkplaces implementation: VorteX
498 // description: allows alternative 'static' lightstyle syntax : "=value"
499 // examples: "=0.5", "=2.0", "=2.75"
500 // could be used to control switchable lights or making styled lights with brightness > 2
501 // Warning: this extension is experimental. It safely works in CSQC, but SVQC use is limited by the fact 
502 // that other engines (which do not support this extension) could connect to a game and misunderstand this kind of lightstyle syntax
503
504 //DP_LITSPRITES
505 //idea: LordHavoc
506 //darkplaces implementation: LordHavoc
507 //description:
508 //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).
509
510 //DP_LITSUPPORT
511 //idea: LordHavoc
512 //darkplaces implementation: LordHavoc
513 //description:
514 //indicates this engine loads .lit files for any quake1 format .bsp files it loads to enhance maps with colored lighting.
515 //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.
516
517 //DP_MONSTERWALK
518 //idea: LordHavoc
519 //darkplaces implementation: LordHavoc
520 //description:
521 //MOVETYPE_WALK is permitted on non-clients, so bots can move smoothly, run off ledges, etc, just like a real player.
522
523 //DP_MOVETYPEBOUNCEMISSILE
524 //idea: id Software
525 //darkplaces implementation: id Software
526 //movetype definitions:
527 //float MOVETYPE_BOUNCEMISSILE = 11; // already in defs.qc
528 //description:
529 //MOVETYPE_BOUNCE but without gravity, and with full reflection (no speed loss like grenades have), in other words - bouncing laser bolts.
530
531 //DP_MOVETYPEFLYWORLDONLY
532 //idea: Samual
533 //darkplaces implementation: Samual
534 //movetype definitions:
535 float MOVETYPE_FLY_WORLDONLY = 33;
536 //description:
537 //like MOVETYPE_FLY, but does all traces with MOVE_WORLDONLY, and is ignored by MOVETYPE_PUSH. Should only be combined with SOLID_NOT and SOLID_TRIGGER.
538
539 //DP_NULL_MODEL
540 //idea: Chris
541 //darkplaces implementation: divVerent
542 //definitions:
543 //string dp_null_model = "null";
544 //description:
545 //setmodel(e, "null"); makes an entity invisible, have a zero bbox, but
546 //networked. useful for shared CSQC entities.
547
548 //DP_MOVETYPEFOLLOW
549 //idea: id Software, LordHavoc (redesigned)
550 //darkplaces implementation: LordHavoc
551 //movetype definitions:
552 float MOVETYPE_FOLLOW = 12;
553 //description:
554 //MOVETYPE_FOLLOW implemented, this uses existing entity fields in unusual ways:
555 //aiment - the entity this is attached to.
556 //punchangle - the original angles when the follow began.
557 //view_ofs - the relative origin (note that this is un-rotated by punchangle, and that is actually the only purpose of punchangle).
558 //v_angle - the relative angles.
559 //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:
560 //hole.movetype = MOVETYPE_FOLLOW; // make the hole follow
561 //hole.solid = SOLID_NOT; // MOVETYPE_FOLLOW is always non-solid
562 //hole.aiment = bmodel; // make the hole follow bmodel
563 //hole.punchangle = bmodel.angles; // the original angles of bmodel
564 //hole.view_ofs = hole.origin - bmodel.origin; // relative origin
565 //hole.v_angle = hole.angles - bmodel.angles; // relative angles
566
567 //DP_QC_ASINACOSATANATAN2TAN
568 //idea: Urre
569 //darkplaces implementation: LordHavoc
570 //constant definitions:
571 float DEG2RAD = 0.0174532925199432957692369076848861271344287188854172545609719144;
572 float RAD2DEG = 57.2957795130823208767981548141051703324054724665643215491602438612;
573 float PI      = 3.1415926535897932384626433832795028841971693993751058209749445923;
574 //builtin definitions:
575 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
576 float(float c) acos = #472; // returns angle in radians for a given cos() value, the result is in the range 0 to PI
577 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
578 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)
579 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
580 //description:
581 //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).
582 //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)
583
584 //DP_QC_AUTOCVARS
585 //idea: divVerent
586 //darkplaces implementation: divVerent
587 //description:
588 //allows QC variables to be bound to cvars
589 //(works for float, string, vector types)
590 //example:
591 // float autocvar_developer;
592 // float autocvar_registered;
593 // string autocvar__cl_name;
594 //NOTE: copying a string-typed autocvar to another variable/field, and then
595 //changing the cvar or returning from progs is UNDEFINED. Writing to autocvar
596 //globals is UNDEFINED. Accessing autocvar globals after changing that cvar in
597 //the same frame by any means other than cvar_set() from the same QC VM is
598 //IMPLEMENTATION DEFINED (an implementation may either yield the previous, or
599 //the current, value). Changing them via cvar_set() in the same QC VM
600 //immediately must reflect on the autocvar globals. Whether autocvar globals,
601 //after restoring a savegame, have the cvar's current value, or the original
602 //value at time of saving, is UNDEFINED. Restoring a savegame however must not
603 //restore the cvar values themselves.
604 //In case the cvar does NOT exist, then it is automatically created with the
605 //value of the autocvar initializer, if given. This is possible with e.g.
606 //frikqcc and fteqcc the following way:
607 // var float autocvar_whatever = 42;
608 //If no initializer is given, the cvar will be initialized to a string
609 //equivalent to the NULL value of the given data type, that is, the empty
610 //string, 0, or '0 0 0'. However, when automatic cvar creation took place, a
611 //warning is printed to the game console.
612 //NOTE: to prevent an ambiguity with float names for vector types, autocvar
613 //names MUST NOT end with _x, _y or _z!
614
615 //DP_QC_CHANGEPITCH
616 //idea: id Software
617 //darkplaces implementation: id Software
618 //field definitions:
619 .float idealpitch;
620 .float pitch_speed;
621 //builtin definitions:
622 void(entity ent) changepitch = #63;
623 //description:
624 //equivalent to changeyaw, ent is normally self. (this was a Q2 builtin)
625
626 //DP_QC_COPYENTITY
627 //idea: LordHavoc
628 //darkplaces implementation: LordHavoc
629 //builtin definitions:
630 void(entity from, entity to) copyentity = #400;
631 //description:
632 //copies all data in the entity to another entity.
633
634 //DP_QC_CRC16
635 //idea: divVerent
636 //darkplaces implementation: divVerent
637 //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.
638 //When caseinsensitive is set, the CRC is calculated of the lower cased string.
639 float(float caseinsensitive, string s, ...) crc16 = #494;
640
641 //DP_QC_CVAR_DEFSTRING
642 //idea: id Software (Doom3), LordHavoc
643 //darkplaces implementation: LordHavoc
644 //builtin definitions:
645 string(string s) cvar_defstring = #482;
646 //description:
647 //returns the default value of a cvar, as a tempstring.
648
649 //DP_QC_CVAR_DESCRIPTION
650 //idea: divVerent
651 //DarkPlaces implementation: divVerent
652 //builtin definitions:
653 string(string name) cvar_description = #518;
654 //description:
655 //returns the description of a cvar
656
657 //DP_QC_CVAR_STRING
658 //idea: VorteX
659 //DarkPlaces implementation: VorteX, LordHavoc
660 //builtin definitions:
661 string(string s) cvar_string = #448;
662 //description:
663 //returns the value of a cvar, as a tempstring.
664
665 //DP_QC_CVAR_TYPE
666 //idea: divVerent
667 //DarkPlaces implementation: divVerent
668 //builtin definitions:
669 float(string name) cvar_type = #495;
670 float CVAR_TYPEFLAG_EXISTS = 1;
671 float CVAR_TYPEFLAG_SAVED = 2;
672 float CVAR_TYPEFLAG_PRIVATE = 4;
673 float CVAR_TYPEFLAG_ENGINE = 8;
674 float CVAR_TYPEFLAG_HASDESCRIPTION = 16;
675 float CVAR_TYPEFLAG_READONLY = 32;
676
677 //DP_QC_DIGEST
678 //idea: motorsep, Spike
679 //DarkPlaces implementation: divVerent
680 //builtin definitions:
681 string(string digest, string data, ...) digest_hex = #639;
682 //description:
683 //returns a given hex digest of given data
684 //the returned digest is always encoded in hexadecimal
685 //only the "MD4" digest is always supported!
686 //if the given digest is not supported, string_null is returned
687 //the digest string is matched case sensitively, use "MD4", not "md4"!
688
689 //DP_QC_DIGEST_SHA256
690 //idea: motorsep, Spike
691 //DarkPlaces implementation: divVerent
692 //description:
693 //"SHA256" is also an allowed digest type
694
695 //DP_QC_EDICT_NUM
696 //idea: 515
697 //DarkPlaces implementation: LordHavoc
698 //builtin definitions:
699 entity(float entnum) edict_num = #459;
700 float(entity ent) wasfreed = #353; // same as in EXT_CSQC extension
701 //description:
702 //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.
703 //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).
704
705 //DP_QC_ENTITYDATA
706 //idea: KrimZon
707 //darkplaces implementation: KrimZon
708 //builtin definitions:
709 float() numentityfields = #496;
710 string(float fieldnum) entityfieldname = #497;
711 float(float fieldnum) entityfieldtype = #498;
712 string(float fieldnum, entity ent) getentityfieldstring = #499;
713 float(float fieldnum, entity ent, string s) putentityfieldstring = #500;
714 //constants:
715 //Returned by entityfieldtype
716 float FIELD_STRING   = 1;
717 float FIELD_FLOAT    = 2;
718 float FIELD_VECTOR   = 3;
719 float FIELD_ENTITY   = 4;
720 float FIELD_FUNCTION = 6;
721 //description:
722 //Versatile functions intended for storing data from specific entities between level changes, but can be customized for some kind of partial savegame.
723 //WARNING: .entity fields cannot be saved and restored between map loads as they will leave dangling pointers.
724 //numentityfields returns the number of entity fields. NOT offsets. Vectors comprise 4 fields: v, v_x, v_y and v_z.
725 //entityfieldname returns the name as a string, eg. "origin" or "classname" or whatever.
726 //entityfieldtype returns a value that the constants represent, but the field may be of another type in more exotic progs.dat formats or compilers.
727 //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.
728 //putentityfieldstring puts the data returned by getentityfieldstring back into the entity.
729
730 //DP_QC_ENTITYSTRING
731 void(string s) loadfromdata = #529;
732 void(string s) loadfromfile = #530;
733 void(string s) callfunction = #605;
734 void(float fh, entity e) writetofile = #606;
735 float(string s) isfunction = #607;
736 void(entity e, string s) parseentitydata = #608;
737
738 //DP_QC_ETOS
739 //idea: id Software
740 //darkplaces implementation: id Software
741 //builtin definitions:
742 string(entity ent) etos = #65;
743 //description:
744 //prints "entity 1" or similar into a string. (this was a Q2 builtin)
745
746 //DP_QC_EXTRESPONSEPACKET
747 //idea: divVerent
748 //darkplaces implementation: divVerent
749 //builtin definitions:
750 string(void) getextresponse = #624;
751 //description:
752 //returns a string of the form "\"ipaddress:port\" data...", or the NULL string
753 //if no packet was found. Packets can be queued into the client/server by
754 //sending a packet starting with "\xFF\xFF\xFF\xFFextResponse " to the
755 //listening port.
756
757 //DP_QC_FINDCHAIN
758 //idea: LordHavoc
759 //darkplaces implementation: LordHavoc
760 //builtin definitions:
761 entity(.string fld, string match) findchain = #402;
762 //description:
763 //similar to find() but returns a chain of entities like findradius.
764
765 //DP_QC_FINDCHAIN_TOFIELD
766 //idea: divVerent
767 //darkplaces implementation: divVerent
768 //builtin definitions:
769 entity(.string fld, float match, .entity tofield) findradius_tofield = #22;
770 entity(.string fld, string match, .entity tofield) findchain_tofield = #402;
771 entity(.string fld, float match, .entity tofield) findchainflags_tofield = #450;
772 entity(.string fld, float match, .entity tofield) findchainfloat_tofield = #403;
773 //description:
774 //similar to findchain() etc, but stores the chain into .tofield instead of .chain
775 //actually, the .entity tofield is an optional field of the the existing findchain* functions
776
777 //DP_QC_FINDCHAINFLAGS
778 //idea: Sajt
779 //darkplaces implementation: LordHavoc
780 //builtin definitions:
781 entity(.float fld, float match) findchainflags = #450;
782 //description:
783 //similar to findflags() but returns a chain of entities like findradius.
784
785 //DP_QC_FINDCHAINFLOAT
786 //idea: LordHavoc
787 //darkplaces implementation: LordHavoc
788 //builtin definitions:
789 entity(.entity fld, entity match) findchainentity = #403;
790 entity(.float fld, float match) findchainfloat = #403;
791 //description:
792 //similar to findentity()/findfloat() but returns a chain of entities like findradius.
793
794 //DP_QC_FINDFLAGS
795 //idea: Sajt
796 //darkplaces implementation: LordHavoc
797 //builtin definitions:
798 entity(entity start, .float fld, float match) findflags = #449;
799 //description:
800 //finds an entity with the specified flag set in the field, similar to find()
801
802 //DP_QC_FINDFLOAT
803 //idea: LordHavoc
804 //darkplaces implementation: LordHavoc
805 //builtin definitions:
806 entity(entity start, .entity fld, entity match) findentity = #98;
807 entity(entity start, .float fld, float match) findfloat = #98;
808 //description:
809 //finds an entity or float field value, similar to find(), but for entity and float fields.
810
811 //DP_QC_FS_SEARCH
812 //idea: Black
813 //darkplaces implementation: Black
814 //builtin definitions:
815 float(string pattern, float caseinsensitive, float quiet) search_begin = #444;
816 void(float handle) search_end = #445;
817 float(float handle) search_getsize = #446;
818 string(float handle, float num) search_getfilename = #447;
819 //description:
820 //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).
821 //search_end frees a search slot (also done at progs reload).
822 //search_getsize returns how many filenames were found.
823 //search_getfilename returns a filename from the search.
824
825 //DP_QC_GETLIGHT
826 //idea: LordHavoc
827 //darkplaces implementation: LordHavoc
828 //builtin definitions:
829 vector(vector org) getlight = #92;
830 //description:
831 //returns the lighting at the requested location (in color), 0-255 range (can exceed 255).
832
833 //DP_QC_GETSURFACE
834 //idea: LordHavoc
835 //darkplaces implementation: LordHavoc
836 //builtin definitions:
837 float(entity e, float s) getsurfacenumpoints = #434;
838 vector(entity e, float s, float n) getsurfacepoint = #435;
839 vector(entity e, float s) getsurfacenormal = #436;
840 string(entity e, float s) getsurfacetexture = #437;
841 float(entity e, vector p) getsurfacenearpoint = #438;
842 vector(entity e, float s, vector p) getsurfaceclippedpoint = #439;
843 //description:
844 //functions to query surface information.
845
846 //DP_QC_GETSURFACEPOINTATTRIBUTE
847 //idea: BlackHC
848 //darkplaces implementation: BlackHC
849 // constants
850 float SPA_POSITION = 0;
851 float SPA_S_AXIS = 1;
852 float SPA_T_AXIS = 2;
853 float SPA_R_AXIS = 3; // same as SPA_NORMAL
854 float SPA_TEXCOORDS0 = 4;
855 float SPA_LIGHTMAP0_TEXCOORDS = 5;
856 float SPA_LIGHTMAP0_COLOR = 6;
857 //builtin definitions:
858 vector(entity e, float s, float n, float a) getsurfacepointattribute = #486;
859
860 //description:
861 //function to query extended information about a point on a certain surface
862
863 //DP_QC_GETSURFACETRIANGLE
864 //idea: divVerent
865 //darkplaces implementation: divVerent
866 //builtin definitions:
867 float(entity e, float s) getsurfacenumtriangles = #628;
868 vector(entity e, float s, float n) getsurfacetriangle = #629;
869 //description:
870 //function to query triangles of a surface
871
872 //DP_QC_GETTAGINFO
873 //idea: VorteX, LordHavoc
874 //DarkPlaces implementation: VorteX
875 //builtin definitions:
876 float(entity ent, string tagname) gettagindex = #451;
877 vector(entity ent, float tagindex) gettaginfo = #452;
878 //description:
879 //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).
880 //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.
881
882 //DP_QC_GETTAGINFO_BONEPROPERTIES
883 //idea: daemon
884 //DarkPlaces implementation: divVerent
885 //global definitions:
886 float gettaginfo_parent;
887 string gettaginfo_name;
888 vector gettaginfo_offset;
889 vector gettaginfo_forward;
890 vector gettaginfo_right;
891 vector gettaginfo_up;
892 //description:
893 //when this extension is present, gettaginfo fills in some globals with info about the bone that had been queried
894 //gettaginfo_parent is set to the number of the parent bone, or 0 if it is a root bone
895 //gettaginfo_name is set to the name of the bone whose index had been specified in gettaginfo
896 //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.
897
898 //DP_QC_GETTIME
899 //idea: tZork
900 //darkplaces implementation: tZork, divVerent
901 //constant definitions:
902 float GETTIME_FRAMESTART = 0; // time of start of frame relative to an arbitrary point in time
903 float GETTIME_REALTIME = 1; // current absolute time (OS specific)
904 float GETTIME_HIRES = 2; // like REALTIME, but may reset between QC invocations and thus can be higher precision
905 float GETTIME_UPTIME = 3; // time of start of frame since start of the engine
906 //builtin definitions:
907 float(float tmr) gettime = #519;
908 //description:
909 //some timers to query...
910
911 //DP_QC_GETTIME_CDTRACK
912 //idea: divVerent
913 //darkplaces implementation: divVerent
914 //constant definitions:
915 float GETTIME_CDTRACK = 4;
916 //description:
917 //returns the playing time of the current cdtrack when passed to gettime()
918 //see DP_END_GETSOUNDTIME for similar functionality but for entity sound channels
919
920 //DP_QC_I18N
921 //idea: divVerent
922 //darkplaces implementation: divVerent
923 //description:
924 //
925 //The engine supports translating by gettext compatible .po files.
926 //progs.dat uses progs.dat.<LANGUAGE>.po
927 //menu.dat uses menu.dat.<LANGUAGE>.po
928 //csprogs.dat uses csprogs.dat.<LANGUAGE>.po
929 //
930 //To create a string that can be translated, define it as
931 //  string dotranslate_FILENOTFOUND = "File not found";
932 //Note: if the compiler does constant folding, this will only work if there is
933 //no other "File not found" string in the progs!
934 //
935 //Alternatively, if using the Xonotic patched fteqcc compiler, you can simplify
936 //this by using _("File not found") directly in the source code.
937 //
938 //The language is set by the "prvm_language" cvar: if prvm_language is set to
939 //"de", it will read progs.dat.de.po for translating strings in progs.dat.
940 //
941 //If prvm_language is set to the special name "dump", progs.dat.pot will be
942 //written, which is a translation template to be edited by filling out the
943 //msgstr entries.
944
945 //DP_QC_LOG
946 //darkplaces implementation: divVerent
947 //builtin definitions:
948 float log(float f) = #532;
949 //description:
950 //logarithm
951
952 //DP_QC_MINMAXBOUND
953 //idea: LordHavoc
954 //darkplaces implementation: LordHavoc
955 //builtin definitions:
956 float(float a, float b, ...) min = #94;
957 float(float a, float b, float c) min3 = #94;
958 float(float a, float b, float c, float d) min4 = #94;
959 float(float a, float b, float c, float d, float e) min5 = #94;
960 float(float a, float b, float c, float d, float e, float f) min6 = #94;
961 float(float a, float b, float c, float d, float e, float f, float g) min7 = #94;
962 float(float a, float b, float c, float d, float e, float f, float g, float h) min8 = #94;
963 float(float a, float b, ...) max = #95;
964 float(float a, float b, float c) max3 = #95;
965 float(float a, float b, float c, float d) max4 = #95;
966 float(float a, float b, float c, float d, float e) max5 = #95;
967 float(float a, float b, float c, float d, float e, float f) max6 = #95;
968 float(float a, float b, float c, float d, float e, float f, float g) max7 = #95;
969 float(float a, float b, float c, float d, float e, float f, float g, float h) max8 = #95;
970 float(float minimum, float val, float maximum) bound = #96;
971 //description:
972 //min returns the lowest of all the supplied numbers.
973 //max returns the highest of all the supplied numbers.
974 //bound clamps the value to the range and returns it.
975
976 //DP_QC_MULTIPLETEMPSTRINGS
977 //idea: LordHavoc
978 //darkplaces implementation: LordHavoc
979 //description:
980 //this extension makes all builtins returning tempstrings (ftos for example)
981 //cycle through a pool of multiple tempstrings (at least 16), allowing
982 //multiple ftos results to be gathered before putting them to use, normal
983 //quake only had 1 tempstring, causing many headaches.
984 //
985 //Note that for longer term storage (or compatibility on engines having
986 //FRIK_FILE but not this extension) the FRIK_FILE extension's
987 //strzone/strunzone builtins provide similar functionality (slower though).
988 //
989 //NOTE: this extension is superseded by DP_QC_UNLIMITEDTEMPSTRINGS
990
991 //DP_QC_NUM_FOR_EDICT
992 //idea: Blub\0
993 //darkplaces implementation: Blub\0
994 //Function to get the number of an entity - a clean way.
995 float(entity num) num_for_edict = #512;
996
997 //DP_QC_RANDOMVEC
998 //idea: LordHavoc
999 //darkplaces implementation: LordHavoc
1000 //builtin definitions:
1001 vector() randomvec = #91;
1002 //description:
1003 //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)
1004
1005 //DP_QC_SINCOSSQRTPOW
1006 //idea: id Software, LordHavoc
1007 //darkplaces implementation: id Software, LordHavoc
1008 //builtin definitions:
1009 float(float val) sin = #60;
1010 float(float val) cos = #61;
1011 float(float val) sqrt = #62;
1012 float(float a, float b) pow = #97;
1013 //description:
1014 //useful math functions, sine of val, cosine of val, square root of val, and raise a to power b, respectively.
1015
1016 //DP_QC_SPRINTF
1017 //idea: divVerent
1018 //darkplaces implementation: divVerent
1019 //builtin definitions:
1020 string(string format, ...) sprintf = #627;
1021 //description:
1022 //you know sprintf :P
1023 //supported stuff:
1024 //  %
1025 //  optional: <argpos>$ for the argument to format (the arg counter then is not increased)
1026 //  flags: #0- +
1027 //  optional: <width>, *, or *<argpos>$ for the field width (width is read before value and precision)
1028 //  optional: .<precision>, .*, or .*<argpos>$ for the precision (precision is read before value)
1029 //  length modifiers: h for forcing a float, l for forcing an entity (by default, %d etc. cast a float to int), ll for forcing an int
1030 //  conversions:
1031 //    d takes a float if no length is specified or h is, and an entity if l is specified as length, and an int if ll is specified as length, and cast it to an int
1032 //    i takes an entity if no length is specified or l is, and a float if h is specified as length, and an int if ll is specified as length, and cast it to an int
1033 //    ouxXc take a float if no length is specified or h is, and an entity if l is specified as length, and an int if ll is specified as length, and cast it to an unsigned int
1034 //    eEfFgG take a float if no length is specified or h is, and an entity if l is specified as length, and an int if ll is specified as length, and cast it to a double
1035 //    s takes a string
1036 //    vV takes a vector, and processes the three components as if it were a gG for all three components, separated by space
1037 //    For conversions s and c, the flag # makes precision and width interpreted
1038 //      as byte count, by default it is interpreted as character count in UTF-8
1039 //      enabled engines. No other conversions can create wide characters, and #
1040 //      has another meaning in these. When in character count mode, color codes
1041 //      are ignored. To get UTF-8 semantics WITHOUT color code parsing, use
1042 //      the + flag.
1043
1044 //DP_QC_STRFTIME
1045 //idea: LordHavoc
1046 //darkplaces implementation: LordHavoc
1047 //builtin definitions:
1048 string(float uselocaltime, string format, ...) strftime = #478;
1049 //description:
1050 //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:
1051 //example: "%Y-%m-%d %H:%M:%S"   (result looks like: 2007-02-08 01:03:15)
1052 //note: "%F %T" gives the same result as "%Y-%m-%d %H:%M:%S" (ISO 8601 date format and 24-hour time)
1053 //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.
1054 //
1055 //practical uses:
1056 //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);
1057 //printing current date/time for competitive multiplayer games, such as the beginning/end of each round in real world time.
1058 //activating eastereggs in singleplayer games on certain dates.
1059 //
1060 //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.
1061 //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)".
1062 //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!).
1063 //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.
1064
1065 //DP_QC_STRINGCOLORFUNCTIONS
1066 //idea: Dresk
1067 //darkplaces implementation: Dresk
1068 //builtin definitions:
1069 float(string s) strlennocol = #476; // returns how many characters are in a string, minus color codes
1070 string(string s) strdecolorize = #477; // returns a string minus the color codes of the string provided
1071 //description:
1072 //provides additional functionality to strings by supporting functions that isolate and identify strings with color codes
1073
1074 //DP_QC_STRING_CASE_FUNCTIONS
1075 //idea: Dresk
1076 //darkplaces implementation: LordHavoc / Dresk
1077 //builtin definitions:
1078 string(string s) strtolower = #480; // returns the passed in string in pure lowercase form
1079 string(string s) strtoupper = #481; // returns the passed in string in pure uppercase form
1080 //description:
1081 //provides simple string uppercase and lowercase functions
1082
1083 //DP_QC_TOKENIZEBYSEPARATOR
1084 //idea: Electro, SavageX, LordHavoc
1085 //darkplaces implementation: LordHavoc
1086 //builtin definitions:
1087 float(string s, string separator1, ...) tokenizebyseparator = #479;
1088 //description:
1089 //this function returns tokens separated by any of the supplied separator strings, example:
1090 //numnumbers = tokenizebyseparator("10.2.3.4", ".");
1091 //returns 4 and the tokens are "10" "2" "3" "4"
1092 //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")
1093
1094 //DP_QC_TOKENIZE_CONSOLE
1095 //idea: divVerent
1096 //darkplaces implementation: divVerent
1097 //builtin definitions:
1098 float(string s) tokenize_console = #514;
1099 float(float i) argv_start_index = #515;
1100 float(float i) argv_end_index = #516;
1101 //description:
1102 //this function returns tokens separated just like the console does
1103 //also, functions are provided to get the index of the first and last character of each token in the original string
1104 //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.
1105
1106 //DP_QC_TRACEBOX
1107 //idea: id Software
1108 //darkplaces implementation: id Software
1109 //builtin definitions:
1110 void(vector v1, vector min, vector max, vector v2, float nomonsters, entity forent) tracebox = #90;
1111 //description:
1112 //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).
1113
1114 //DP_QC_TRACETOSS
1115 //idea: id Software
1116 //darkplaces implementation: id Software
1117 //builtin definitions:
1118 void(entity ent, entity ignore) tracetoss = #64;
1119 //description:
1120 //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.
1121
1122 //DP_QC_TRACE_MOVETYPE_HITMODEL
1123 //idea: LordHavoc
1124 //darkplaces implementation: LordHavoc
1125 //constant definitions:
1126 float MOVE_HITMODEL = 4;
1127 //description:
1128 //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)
1129
1130 //DP_QC_TRACE_MOVETYPE_WORLDONLY
1131 //idea: LordHavoc
1132 //darkplaces implementation: LordHavoc
1133 //constant definitions:
1134 float MOVE_WORLDONLY = 3;
1135 //description:
1136 //allows traces to hit only world (ignoring all entities, unlike MOVE_NOMONSTERS which hits all bmodels), use as the nomonsters parameter to trace functions
1137
1138 //DP_QC_UNLIMITEDTEMPSTRINGS
1139 //idea: divVerent
1140 //darkplaces implementation: LordHavoc
1141 //description:
1142 //this extension alters Quake behavior such that instead of reusing a single
1143 //tempstring (or multiple) there are an unlimited number of tempstrings, which
1144 //are removed only when a QC function invoked by the engine returns,
1145 //eliminating almost all imaginable concerns with string handling in QuakeC.
1146 //
1147 //in short:
1148 //you can now use and abuse tempstrings as much as you like, you still have to
1149 //use strzone (FRIK_FILE) for permanent storage however.
1150 //
1151 //
1152 //
1153 //implementation notes for other engine coders:
1154 //these tempstrings are expected to be stored in a contiguous buffer in memory
1155 //which may be fixed size or controlled by a cvar, or automatically grown on
1156 //demand (in the case of DarkPlaces).
1157 //
1158 //this concept is similar to quake's Zone system, however these are all freed
1159 //when the QC interpreter returns.
1160 //
1161 //this is basically a poor man's garbage collection system for strings.
1162
1163 //DP_QC_VECTOANGLES_WITH_ROLL
1164 //idea: LordHavoc
1165 //darkplaces implementation: LordHavoc
1166 //builtin definitions:
1167 vector(vector forward, vector up) vectoangles2 = #51; // same number as vectoangles
1168 //description:
1169 //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)
1170 //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
1171
1172 //DP_QC_VECTORVECTORS
1173 //idea: LordHavoc
1174 //darkplaces implementation: LordHavoc
1175 //builtin definitions:
1176 void(vector dir) vectorvectors = #432;
1177 //description:
1178 //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.
1179
1180 //DP_QC_WHICHPACK
1181 //idea: divVerent
1182 //darkplaces implementation: divVerent
1183 //builtin definitions:
1184 string(string filename) whichpack = #503;
1185 //description:
1186 //for files in a pak/pk3/whatever, returns the pack's file name in FRIK_FILE name space.
1187 //for physical files, returns "".
1188 //in case of error, returns string_null.
1189
1190 //DP_QC_URI_ESCAPE
1191 //idea: divVerent
1192 //darkplaces implementation: divVerent
1193 //URI::Escape's functionality
1194 string(string in) uri_escape = #510;
1195 string(string in) uri_unescape = #511;
1196
1197 //DP_QC_URI_GET
1198 //idea: divVerent
1199 //darkplaces implementation: divVerent
1200 //loads text from an URL into a string
1201 //returns 1 on success of initiation, 0 if there are too many concurrent
1202 //connections already or if the URL is invalid
1203 //the following callback will receive the data and MUST exist!
1204 //  void(float id, float status, string data) URI_Get_Callback;
1205 //status is either
1206 //  negative for an internal error,
1207 //  0 for success, or
1208 //  the HTTP response code on server error (e.g. 404)
1209 //if 1 is returned by uri_get, the callback will be called in the future
1210 float(string url, float id) uri_get = #513;
1211
1212 //DP_QC_URI_POST
1213 //idea: divVerent
1214 //darkplaces implementation: divVerent
1215 //loads text from an URL into a string after POSTing via HTTP
1216 //works like uri_get, but uri_post sends data with Content-Type: content_type to the server
1217 //and uri_post sends the string buffer buf, joined using the delimiter delim
1218 float(string url, float id, string content_type, string data) uri_post = #513;
1219 float(string url, float id, string content_type, string delim, float buf) uri_postbuf = #513;
1220
1221 //DP_SKELETONOBJECTS
1222 //idea: LordHavoc
1223 //darkplaces implementation: LordHavoc
1224 //description:
1225 //this extension indicates that FTE_CSQC_SKELETONOBJECTS functionality is available in server QC (as well as CSQC).
1226
1227 //DP_SV_SPAWNFUNC_PREFIX
1228 //idea: divVerent
1229 //darkplaces implementation: divVerent
1230 //Make functions whose name start with spawnfunc_ take precedence as spawn function for loading entities.
1231 //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).
1232 //Optionally, you can declare a global "float require_spawnfunc_prefix;" which will require ANY spawn function to start with that prefix.
1233
1234
1235 //DP_QUAKE2_MODEL
1236 //idea: quake community
1237 //darkplaces implementation: LordHavoc
1238 //description:
1239 //shows that the engine supports Quake2 .md2 files.
1240
1241 //DP_QUAKE2_SPRITE
1242 //idea: LordHavoc
1243 //darkplaces implementation: Elric
1244 //description:
1245 //shows that the engine supports Quake2 .sp2 files.
1246
1247 //DP_QUAKE3_MAP
1248 //idea: quake community
1249 //darkplaces implementation: LordHavoc
1250 //description:
1251 //shows that the engine supports Quake3 .bsp files.
1252
1253 //DP_QUAKE3_MODEL
1254 //idea: quake community
1255 //darkplaces implementation: LordHavoc
1256 //description:
1257 //shows that the engine supports Quake3 .md3 files.
1258
1259 //DP_REGISTERCVAR
1260 //idea: LordHavoc
1261 //darkplaces implementation: LordHavoc
1262 //builtin definitions:
1263 float(string name, string value) registercvar = #93;
1264 //description:
1265 //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.
1266 //NOTE: DP_CON_SET is much better.
1267
1268 //DP_SND_DIRECTIONLESSATTNNONE
1269 //idea: LordHavoc
1270 //darkplaces implementation: LordHavoc
1271 //description:
1272 //make sounds with ATTN_NONE have no spatialization (enabling easy use as music sources).
1273
1274 //DP_SND_FAKETRACKS
1275 //idea: requested
1276
1277 //darkplaces implementation: Elric
1278 //description:
1279 //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.
1280 //Note: also plays .ogg with DP_SND_OGGVORBIS extension.
1281
1282 //DP_SND_SOUND7_WIP1
1283 //DP_SND_SOUND7_WIP2
1284 //idea: divVerent
1285 //darkplaces implementation: divVerent
1286 //builtin definitions:
1287 void(entity e, float chan, string samp, float vol, float atten, float speed, float flags) sound7 = #8;
1288 float SOUNDFLAG_RELIABLE = 1;
1289 //description:
1290 //plays a sound, with some more flags
1291 //extensions to sound():
1292 //- channel may be in the range from -128 to 127; channels -128 to 0 are "auto",
1293 //  i.e. support multiple sounds at once, but cannot be stopped/restarted
1294 //- a value 0 in the speed parameter means no change; otherwise, it is a
1295 //  percentage of playback speed ("pitch shifting"). 100 is normal pitch, 50 is
1296 //  half speed, 200 is double speed, etc. (DP_SND_SOUND7_WIP2)
1297 //- the flag SOUNDFLAG_RELIABLE can be specified, which makes the sound send
1298 //  to MSG_ALL (reliable) instead of MSG_BROADCAST (unreliable, default);
1299 //  similarily, SOUNDFLAG_RELIABLE_TO_ONE sends to MSG_ONE
1300 //- channel 0 is controlled by snd_channel0volume; channel 1 and -1 by
1301 //  snd_channel1volume, etc. (so, a channel shares the cvar with its respective
1302 //  auto-channel); however, the mod MUST define snd_channel8volume and upwards
1303 //  in default.cfg if they are to be used, as the engine does not create them
1304 //  to not litter the cvar list
1305 //- this extension applies to CSQC as well; CSQC_Event_Sound will get speed and
1306 //  flags as extra 7th and 8th argument
1307 //- WIP2 ideas: SOUNDFLAG_RELIABLE_TO_ONE, SOUNDFLAG_NOPHS, SOUNDFLAG_FORCELOOP
1308 //- NOTE: to check for this, ALSO OR a check with DP_SND_SOUND7 to also support
1309 //  the finished extension once done
1310
1311 //DP_SND_OGGVORBIS
1312 //idea: Transfusion
1313 //darkplaces implementation: Elric
1314 //description:
1315 //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).
1316
1317 //DP_SND_STEREOWAV
1318 //idea: LordHavoc
1319 //darkplaces implementation: LordHavoc
1320 //description:
1321 //the engine supports stereo WAV files.  (useful with DP_SND_DIRECTIONLESSATTNNONE for music)
1322
1323 //DP_SND_GETSOUNDTIME
1324 //idea: VorteX
1325 //darkplaces implementation: VorteX
1326 //constant definitions:
1327 float(entity e, float channel) getsoundtime = #533; // get currently sound playing position on entity channel, -1 if not playing or error
1328 float(string sample) soundlength = #534; // returns length of sound sample in seconds, -1 on error (sound not precached, sound system not initialized etc.)
1329 //description: provides opportunity to query length of sound samples and realtime tracking of sound playing on entities (similar to DP_GETTIME_CDTRACK)
1330 //note: beware dedicated server not running sound engine at all, so in dedicated mode this builtins will not work in server progs
1331 //note also: menu progs not supporting getsoundtime() (will give a warning) since it has no sound playing on entities
1332 //examples of use:
1333 //  - QC-driven looped sounds
1334 //  - QC events when sound playing is finished
1335 //  - toggleable ambientsounds
1336 //  - subtitles
1337
1338 //DP_VIDEO_DPV
1339 //idea: LordHavoc
1340 //darkplaces implementation: LordHavoc
1341 //console commands:
1342 //  playvideo <videoname> - start playing video
1343 //  stopvideo - stops current video
1344 //description: indicated that engine support playing videos in DPV format
1345
1346 //DP_VIDEO_SUBTITLES
1347 //idea: VorteX
1348 //darkplaces implementation: VorteX
1349 //cvars:
1350 //  cl_video_subtitles - toggles subtitles showing
1351 //  cl_video_subtitles_lines - how many lines to reserve for subtitles
1352 //  cl_video_subtitles_textsize - font size
1353 //console commands:
1354 //  playvideo <videoname> <custom_subtitles_file> - start playing video
1355 //  stopvideo - stops current video
1356 //description: indicates that engine support subtitles on videos
1357 //subtitles stored in external text files, each video file has it's default subtitles file ( <videoname>.dpsubs )
1358 //example: for video/act1.dpv default subtitles file will be video/act1.dpsubs
1359 //also video could be played with custom subtitles file by utilizing second parm of playvideo command
1360 //syntax of .dpsubs files: each line in .dpsubs file defines 1 subtitle, there are three tokens:
1361 //   <start> <end> "string"
1362 //   start: subtitle start time in seconds
1363 //     end: subtitle time-to-show in seconds, if 0 - subtitle will be showed until next subtitle is started, 
1364 //          if below 0 - show until next subtitles minus this number of seconds
1365 //    text: subtitle text, color codes (Q3-style and ^xRGB) are allowed
1366 //example of subtitle file:
1367 //   3  0       "Vengeance! Vengeance for my eternity of suffering!"
1368 //   9  0       "Whelp! As if you knew what eternity was!"
1369 //   13 0       "Grovel before your true master."
1370 //   17 0       "Never!" 
1371 //   18 7       "I'll hack you from crotch to gizzard and feed what's left of you to your brides..."
1372
1373 //DP_SOLIDCORPSE
1374 //idea: LordHavoc
1375 //darkplaces implementation: LordHavoc
1376 //solid definitions:
1377 float SOLID_CORPSE = 5;
1378 //description:
1379 //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.
1380
1381 //DP_SPRITE32
1382 //idea: LordHavoc
1383 //darkplaces implementation: LordHavoc
1384 //description:
1385 //the engine supports .spr32 sprites.
1386
1387 //DP_SV_BOTCLIENT
1388 //idea: LordHavoc
1389 //darkplaces implementation: LordHavoc
1390 //constants:
1391 float CLIENTTYPE_DISCONNECTED = 0;
1392 float CLIENTTYPE_REAL = 1;
1393 float CLIENTTYPE_BOT = 2;
1394 float CLIENTTYPE_NOTACLIENT = 3;
1395 //builtin definitions:
1396 entity() spawnclient = #454; // like spawn but for client slots (also calls relevant connect/spawn functions), returns world if no clients available
1397 float(entity clent) clienttype = #455; // returns one of the CLIENTTYPE_* constants
1398 //description:
1399 //spawns a client with no network connection, to allow bots to use client slots with no hacks.
1400 //How to use:
1401 /*
1402         // to spawn a bot
1403         local entity oldself;
1404         oldself = self;
1405         self = spawnclient();
1406         if (!self)
1407         {
1408                 bprint("Can not add bot, server full.\n");
1409                 self = oldself;
1410                 return;
1411         }
1412         self.netname = "Yoyobot";
1413         self.clientcolors = 12 * 16 + 4; // yellow (12) shirt and red (4) pants
1414         ClientConnect();
1415         PutClientInServer();
1416         self = oldself;
1417
1418         // to remove all bots
1419         local entity head;
1420         head = find(world, classname, "player");
1421         while (head)
1422         {
1423                 if (clienttype(head) == CLIENTTYPE_BOT)
1424                         dropclient(head);
1425                 head = find(head, classname, "player");
1426         }
1427
1428         // to identify if a client is a bot (for example in PlayerPreThink)
1429         if (clienttype(self) == CLIENTTYPE_BOT)
1430                 botthink();
1431 */
1432 //see also DP_SV_CLIENTCOLORS DP_SV_CLIENTNAME DP_SV_DROPCLIENT
1433 //How it works:
1434 //creates a new client, calls SetNewParms and stores the parms, and returns the client.
1435 //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
1436 //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).
1437 //parms work the same on bot clients as they do on real clients, and do carry from level to level
1438
1439 //DP_SV_BOUNCEFACTOR
1440 //idea: divVerent
1441 //darkplaces implementation: divVerent
1442 //field definitions:
1443 .float bouncefactor; // velocity multiplier after a bounce
1444 .float bouncestop; // bounce stops if velocity to bounce plane is < bouncestop * gravity AFTER the bounce
1445 //description:
1446 //allows qc to customize MOVETYPE_BOUNCE a bit
1447
1448 //DP_SV_CLIENTCAMERA
1449 //idea: LordHavoc, others
1450 //darkplaces implementation: Black
1451 //field definitions:
1452 .entity clientcamera; // override camera entity
1453 //description:
1454 //allows another entity to be the camera for a client, for example a remote camera, this is similar to sending svc_setview manually except that it also changes the network culling appropriately.
1455
1456 //DP_SV_CLIENTCOLORS
1457 //idea: LordHavoc
1458 //darkplaces implementation: LordHavoc
1459 //field definitions:
1460 .float clientcolors; // colors of the client (format: pants + shirt * 16)
1461 //description:
1462 //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
1463
1464 //DP_SV_CLIENTNAME
1465 //idea: LordHavoc
1466 //darkplaces implementation: LordHavoc
1467 //description:
1468 //allows qc to modify the client's .netname, and automatically sends out any appropriate network updates if changed
1469
1470 //DP_SV_CUSTOMIZEENTITYFORCLIENT
1471 //idea: LordHavoc
1472 //darkplaces implementation: [515] and LordHavoc
1473 //field definitions:
1474 .float() customizeentityforclient; // self = this entity, other = client entity
1475 //description:
1476 //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
1477 //tips on writing customize functions:
1478 //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.
1479 //you are free to change anything in self, but please do not change any other entities (the results may be very inconsistent).
1480 //example ideas for use of this extension:
1481 //making icons over teammates' heads which are only visible to teammates.  for exasmple: float() playericon_customizeentityforclient = {return self.owner.team == other.team;};
1482 //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;};
1483 //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;};
1484 //implementation notes:
1485 //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).
1486
1487 //DP_SV_DISCARDABLEDEMO
1488 //idea: parasti
1489 //darkplaces implementation: parasti
1490 //field definitions:
1491 .float discardabledemo;
1492 //description:
1493 //when this field is set to a non-zero value on a player entity, a possibly recorded server-side demo for the player is discarded
1494 //Note that this extension only works if:
1495 //  auto demos are enabled (the cvar sv_autodemo_perclient is set)
1496 //  discarding demos is enabled (the cvar sv_autodemo_perclient_discardable is set)
1497
1498 //DP_SV_DRAWONLYTOCLIENT
1499 //idea: LordHavoc
1500 //darkplaces implementation: LordHavoc
1501 //field definitions:
1502 .entity drawonlytoclient;
1503 //description:
1504 //the entity is only visible to the specified client.
1505
1506 //DP_SV_DROPCLIENT
1507 //idea: FrikaC
1508 //darkplaces implementation: LordHavoc
1509 //builtin definitions:
1510 void(entity clent) dropclient = #453;
1511 //description:
1512 //causes the server to immediately drop the client, more reliable than stuffcmd(clent, "disconnect\n"); which could be intentionally ignored by the client engine
1513
1514 //DP_SV_EFFECT
1515 //idea: LordHavoc
1516 //darkplaces implementation: LordHavoc
1517 //builtin definitions:
1518 void(vector org, string modelname, float startframe, float endframe, float framerate) effect = #404;
1519 //SVC definitions:
1520 //float svc_effect = #52; // [vector] org [byte] modelindex [byte] startframe [byte] framecount [byte] framerate
1521 //float svc_effect2 = #53; // [vector] org [short] modelindex [byte] startframe [byte] framecount [byte] framerate
1522 //description:
1523 //clientside playback of simple custom sprite effects (explosion sprites, etc).
1524
1525 //DP_SV_ENTITYCONTENTSTRANSITION
1526 //idea: Dresk
1527 //darkplaces implementation: Dresk
1528 //field definitions:
1529 .void(float nOriginalContents, float nNewContents) contentstransition;
1530 //description:
1531 //This field function, when provided, is triggered on an entity when the contents (ie. liquid / water / etc) is changed.
1532 //The first parameter provides the entities original contents, prior to the transition.  The second parameter provides the new contents.
1533 //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.
1534
1535 //DP_SV_MOVETYPESTEP_LANDEVENT
1536 //idea: Dresk
1537 //darkplaces implementation: Dresk
1538 //field definitions:
1539 .void(vector vImpactVelocity) movetypesteplandevent;
1540 //description:
1541 //This field function, when provided, is triggered on a MOVETYPE_STEP entity when it experiences  "land event".
1542 // The standard engine behavior for this event is to play the sv_sound_land CVar sound.
1543 //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.
1544 //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.
1545
1546 //DP_SV_POINTSOUND
1547 //idea: Dresk
1548 //darkplaces implementation: Dresk
1549 //builtin definitions:
1550 void(vector origin, string sample, float volume, float attenuation) pointsound = #483;
1551 //description:
1552 //Similar to the standard QC sound function, this function takes an origin instead of an entity and omits the channel parameter.
1553 // This allows sounds to be played at arbitrary origins without spawning entities.
1554
1555 //DP_SV_ONENTITYNOSPAWNFUNCTION
1556 //idea: Dresk
1557 //darkplaces implementation: Dresk
1558 //engine-called QC prototypes:
1559 //void() SV_OnEntityNoSpawnFunction;
1560 //description:
1561 // This function is called whenever an entity on the server has no spawn function, and therefore has no defined QC behavior.
1562 // You may as such dictate the behavior as to what happens to the entity.
1563 // To mimic the engine's default behavior, simply call remove(self).
1564
1565 //DP_SV_ONENTITYPREPOSTSPAWNFUNCTION
1566 //idea: divVerent
1567 //darkplaces implementation: divVerent
1568 //engine-called QC prototypes:
1569 //void() SV_OnEntityPreSpawnFunction;
1570 //void() SV_OnEntityPostSpawnFunction;
1571 //description:
1572 // These functions are called BEFORE or AFTER an entity is spawned the regular way.
1573 // You may as such dictate the behavior as to what happens to the entity.
1574 // 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.
1575 // SV_OnEntityPostSpawnFunction is called ONLY after its spawn function or SV_OnEntityNoSpawnFunction was called, and skipped if the entity got removed by either.
1576
1577 //DP_SV_MODELFLAGS_AS_EFFECTS
1578 //idea: LordHavoc, Dresk
1579 //darkplaces implementation: LordHavoc
1580 //field definitions:
1581 .float modelflags;
1582 //constant definitions:
1583 float EF_NOMODELFLAGS = 8388608; // ignore any effects in a model file and substitute your own
1584 float MF_ROCKET  =   1; // leave a trail
1585 float MF_GRENADE =   2; // leave a trail
1586 float MF_GIB     =   4; // leave a trail
1587 float MF_ROTATE  =   8; // rotate (bonus items)
1588 float MF_TRACER  =  16; // green split trail
1589 float MF_ZOMGIB  =  32; // small blood trail
1590 float MF_TRACER2 =  64; // orange split trail
1591 float MF_TRACER3 = 128; // purple trail
1592 //description:
1593 //this extension allows model flags to be specified on entities so you can add a rocket trail and glow to any entity, etc.
1594 //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.
1595 //
1596 //silly example modification #1 to W_FireRocket in weapons.qc:
1597 //missile.effects = EF_NOMODELFLAGS; // rocket without a glow/fire trail
1598 //silly example modification #2 to W_FireRocket in weapons.qc:
1599 //missile.modelflags = MF_GIB; // leave a blood trail instead of glow/fire trail
1600 //
1601 //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.
1602 //
1603 //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.
1604
1605 //DP_SV_NETADDRESS
1606 //idea: Dresk
1607 //darkplaces implementation: Dresk
1608 //field definitions:
1609 .string netaddress;
1610 //description:
1611 // provides the netaddress of the associated entity (ie. 127.0.0.1) and "null/botclient" if the netconnection of the entity is invalid
1612
1613 //DP_SV_NODRAWTOCLIENT
1614 //idea: LordHavoc
1615 //darkplaces implementation: LordHavoc
1616 //field definitions:
1617 .entity nodrawtoclient;
1618 //description:
1619 //the entity is not visible to the specified client.
1620
1621 //DP_SV_PING
1622 //idea: LordHavoc
1623 //darkplaces implementation: LordHavoc
1624 //field definitions:
1625 .float ping;
1626 //description:
1627 //continuously updated field indicating client's ping (based on average of last 16 packet time differences).
1628
1629 //DP_SV_PING_PACKETLOSS
1630 //idea: LordHavoc
1631 //darkplaces implementation: LordHavoc
1632 //field definitions:
1633 .float ping_packetloss;
1634 .float ping_movementloss;
1635 //description:
1636 //continuously updated field indicating client's packet loss, and movement loss (i.e. packet loss affecting player movement).
1637
1638 //DP_SV_POINTPARTICLES
1639 //idea: Spike
1640 //darkplaces implementation: LordHavoc
1641 //function definitions:
1642 float(string effectname) particleeffectnum = #335; // same as in CSQC
1643 void(entity ent, float effectnum, vector start, vector end) trailparticles = #336; // same as in CSQC
1644 void(float effectnum, vector org, vector vel, float howmany) pointparticles = #337; // same as in CSQC
1645 //SVC definitions:
1646 //float svc_trailparticles = 60; // [short] entnum [short] effectnum [vector] start [vector] end
1647 //float svc_pointparticles = 61; // [short] effectnum [vector] start [vector] velocity [short] count
1648 //float svc_pointparticles1 = 62; // [short] effectnum [vector] start, same as svc_pointparticles except velocity is zero and count is 1
1649 //description:
1650 //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.
1651 //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.
1652 //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.
1653
1654 //DP_SV_PUNCHVECTOR
1655 //idea: LordHavoc
1656 //darkplaces implementation: LordHavoc
1657 //field definitions:
1658 .vector punchvector;
1659 //description:
1660 //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).
1661
1662 //DP_SV_PLAYERPHYSICS
1663 //idea: LordHavoc
1664 //darkplaces implementation: LordHavoc
1665 //field definitions:
1666 .vector movement;
1667 //cvar definitions:
1668 //"sv_playerphysicsqc" (0/1, default 1, allows user to disable qc player physics)
1669 //engine-called QC prototypes:
1670 //void() SV_PlayerPhysics;
1671 //description:
1672 //.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)
1673
1674 //DP_PHYSICS_ODE
1675 //idea: LordHavoc
1676 //darkplaces implementation: LordHavoc
1677 //globals:
1678 //new movetypes:
1679 const float MOVETYPE_PHYSICS = 32; // need to be set before any physics_* builtins applied
1680 //new solid types (deprecated):
1681 const float SOLID_PHYSICS_BOX = 32;
1682 const float SOLID_PHYSICS_SPHERE = 33;
1683 const float SOLID_PHYSICS_CAPSULE = 34;
1684 const float SOLID_PHYSICS_TRIMESH = 35;
1685 const float SOLID_PHYSICS_CYLINDER = 36;
1686 //geometry types:
1687 const float GEOMTYPE_NONE = -1;       // entity will be entirely skipped by ODE
1688 const float GEOMTYPE_SOLID = 0;       // geometry type will be set based on .solid field
1689 const float GEOMTYPE_BOX = 1;         // entity bound box
1690 const float GEOMTYPE_SPHERE = 2;      // sphere with radius picked from x axis of entity bound box
1691 const float GEOMTYPE_CAPSULE = 3;     // with leading axis automatically determined from longest one, radius is picked as minimal of the rest 2 axes
1692 const float GEOMTYPE_TRIMESH = 4;     // triangle mesh
1693 const float GEOMTYPE_CYLINDER = 5;    // like capsule but not capped
1694                                       // note that ODE's builtin cylinder support is experimental, somewhat bugged and unfinished (no cylinder-cylinder collision)
1695                                                                           // to use properly working cylinder should build ODE with LIBCCD extension
1696 const float GEOMTYPE_CAPSULE_X = 6;   // capsule with fixed leading axis
1697 const float GEOMTYPE_CAPSULE_Y = 7;
1698 const float GEOMTYPE_CAPSULE_Z = 8;
1699 const float GEOMTYPE_CYLINDER_X = 9;  // cylinder with fixed leading axis
1700 const float GEOMTYPE_CYLINDER_Y = 10;
1701 const float GEOMTYPE_CYLINDER_Z = 11;
1702 //joint types:
1703 const float JOINTTYPE_NONE = 0;
1704 const float JOINTTYPE_POINT = 1;
1705 const float JOINTTYPE_HINGE = 2;
1706 const float JOINTTYPE_SLIDER = 3;
1707 const float JOINTTYPE_UNIVERSAL = 4;
1708 const float JOINTTYPE_HINGE2 = 5;
1709 const float JOINTTYPE_FIXED = -1;
1710 //force types:
1711 const float FORCETYPE_NONE = 0;
1712 const float FORCETYPE_FORCE = 1; // applied at center of mass
1713 const float FORCETYPE_FORCEATPOS = 2;
1714 const float FORCETYPE_TORQUE = 3;
1715 // common joint properties:
1716 // .entity aiment; // connected objects
1717 // .entity enemy; // connected objects, forces
1718 // .vector movedir;
1719 //   for a spring:
1720 //     movedir_x = spring constant (force multiplier, must be > 0)
1721 //     movedir_y = spring dampening constant to prevent oscillation (must be > 0)
1722 //     movedir_z = spring stop position (+/-)
1723 //   for a motor:
1724 //     movedir_x = desired motor velocity
1725 //     movedir_y = -1 * max motor force to use
1726 //     movedir_z = stop position (+/-), set to 0 for no stop
1727 //   note that ODE does not support both in one anyway
1728 //   for a force:
1729 //     force vector to apply
1730 //field definitions:
1731 .float  geomtype;     // see GEOMTYPE_*, a more correct way to set collision shape, allows to set SOLID_CORPSE and trimesh collisions
1732 .float  maxcontacts;  // maximum number of contacts to make for this object, lesser = faster (but setting it too low will could make object pass though walls), default is 16, maximum is 32
1733 .float  mass;         // ODE mass, standart value is 1
1734 .vector massofs;      // offsets a mass center out of object center, if not set a center of model bounds is used
1735 .float  friction;     // a friction of object, get multiplied by second objects's friction on contact
1736 .float  bouncefactor;
1737 .float  bouncestop; 
1738 .float  jointtype;    // type of joint
1739 .float  forcetype;    // type of force
1740 .float  erp;          // error restitution parameter, makes ODE solver attempt to fix errors in contacts, 
1741                       // bringing together 2 joints or fixing object being stuch in other object, 
1742                                   // a value of 0.1 will fix slightly, a value of 1.0 attempts to fix whole error in one frame
1743                                   // use with care as high values makes system unstable and likely to explode
1744 //builtin definitions:
1745 void(entity e, float physics_enabled) physics_enable = #540; // enable or disable physics on object
1746 void(entity e, vector force, vector force_pos) physics_addforce = #541; // deprecated, apply a force from certain origin, length of force vector is power of force
1747 void(entity e, vector torque) physics_addtorque = #542; // deprecated, add relative torque
1748 //description: provides Open Dynamics Engine support, requires extenal dll to be present or engine compiled with statical link option
1749 //be sure to checkextension for it to know if library is loaded and ready, also to enable physics set "physics_ode" cvar to 1
1750 //note: this extension is highly experimental and may be unstable
1751
1752 //DP_SV_PRINT
1753 //idea: id Software (QuakeWorld Server)
1754 //darkplaces implementation: Black, LordHavoc
1755 void(string s, ...) print = #339; // same number as in EXT_CSQC
1756 //description:
1757 //this is identical to dprint except that it always prints regardless of the developer cvar.
1758
1759 //DP_SV_PRECACHEANYTIME
1760 //idea: id Software (Quake2)
1761 //darkplaces implementation: LordHavoc
1762 //description:
1763 //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).
1764
1765 //DP_SV_QCSTATUS
1766 //idea: divVerent
1767 //darkplaces implementation: divVerent
1768 //1. A global variable
1769 string worldstatus;
1770 //Its content is set as "qcstatus" field in the rules.
1771 //It may be at most 255 characters, and must not contain newlines or backslashes.
1772 //2. A per-client field
1773 .string clientstatus;
1774 //It is sent instead of the "frags" in status responses.
1775 //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".
1776 //Currently, qstat does not support this and will not show player info if used and set to anything other than ftos(some integer).
1777
1778 //DP_SV_ROTATINGBMODEL
1779 //idea: id Software
1780 //darkplaces implementation: LordHavoc
1781 //description:
1782 //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).
1783 //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)
1784
1785 //DP_SV_SETCOLOR
1786 //idea: LordHavoc
1787 //darkplaces implementation: LordHavoc
1788 //builtin definitions:
1789 void(entity ent, float colors) setcolor = #401;
1790 //engine called QC functions (optional):
1791 //void(float color) SV_ChangeTeam;
1792 //description:
1793 //setcolor sets the color on a client and updates internal color information accordingly (equivalent to stuffing a "color" command but immediate)
1794 //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.
1795 //the color format is pants + shirt * 16 (0-255 potentially)
1796
1797 //DP_SV_SLOWMO
1798 //idea: LordHavoc
1799 //darkplaces implementation: LordHavoc
1800 //cvars:
1801 //"slowmo" (0+, default 1)
1802 //description:
1803 //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.
1804 //range is 0 to infinite, recommended values to try are 0.1 (very slow, 10% speed), 1 (normal speed), 5 (500% speed).
1805
1806 //DP_SV_WRITEPICTURE
1807 //idea: divVerent
1808 //darkplaces implementation: divVerent
1809 //builtin definitions:
1810 void(float to, string s, float sz) WritePicture = #501;
1811 //description:
1812 //writes a picture to the data stream so CSQC can read it using ReadPicture, which has the definition
1813 //  string(void) ReadPicture = #501;
1814 //The picture data is sent as at most sz bytes, by compressing to low quality
1815 //JPEG. The data being sent will be equivalent to:
1816 //  WriteString(to, s);
1817 //  WriteShort(to, imagesize);
1818 //  for(i = 0; i < imagesize; ++i)
1819 //    WriteByte(to, [the i-th byte of the compressed JPEG image]);
1820
1821 //DP_SV_WRITEUNTERMINATEDSTRING
1822 //idea: FrikaC
1823 //darkplaces implementation: Sajt
1824 //builtin definitions:
1825 void(float to, string s) WriteUnterminatedString = #456;
1826 //description:
1827 //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.
1828 //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 equivalent of it in his FrikBot mod years ago involving WriteByte calls on each character.
1829
1830 //DP_TE_BLOOD
1831 //idea: LordHavoc
1832 //darkplaces implementation: LordHavoc
1833 //builtin definitions:
1834 void(vector org, vector velocity, float howmany) te_blood = #405;
1835 //temp entity definitions:
1836 float TE_BLOOD = 50;
1837 //protocol:
1838 //vector origin
1839 //byte xvelocity (-128 to +127)
1840 //byte yvelocity (-128 to +127)
1841 //byte zvelocity (-128 to +127)
1842 //byte count (0 to 255, how much blood)
1843 //description:
1844 //creates a blood effect.
1845
1846 //DP_TE_BLOODSHOWER
1847 //idea: LordHavoc
1848 //darkplaces implementation: LordHavoc
1849 //builtin definitions:
1850 void(vector mincorner, vector maxcorner, float explosionspeed, float howmany) te_bloodshower = #406;
1851 //temp entity definitions:
1852 //float TE_BLOODSHOWER = 52;
1853 //protocol:
1854 //vector mins (minimum corner of the cube)
1855 //vector maxs (maximum corner of the cube)
1856 //coord explosionspeed (velocity of blood particles flying out of the center)
1857 //short count (number of blood particles)
1858 //description:
1859 //creates an exploding shower of blood, for making gibbings more convincing.
1860
1861 //DP_TE_CUSTOMFLASH
1862 //idea: LordHavoc
1863 //darkplaces implementation: LordHavoc
1864 //builtin definitions:
1865 void(vector org, float radius, float lifetime, vector color) te_customflash = #417;
1866 //temp entity definitions:
1867 //float TE_CUSTOMFLASH = 73;
1868 //protocol:
1869 //vector origin
1870 //byte radius ((MSG_ReadByte() + 1) * 8, meaning 8-2048 unit radius)
1871 //byte lifetime ((MSG_ReadByte() + 1) / 256.0, meaning approximately 0-1 second lifetime)
1872 //byte red (0.0 to 1.0 converted to 0-255)
1873 //byte green (0.0 to 1.0 converted to 0-255)
1874 //byte blue (0.0 to 1.0 converted to 0-255)
1875 //description:
1876 //creates a customized light flash.
1877
1878 //DP_TE_EXPLOSIONRGB
1879 //idea: LordHavoc
1880 //darkplaces implementation: LordHavoc
1881 //builtin definitions:
1882 void(vector org, vector color) te_explosionrgb = #407;
1883 //temp entity definitions:
1884 //float TE_EXPLOSIONRGB = 53;
1885 //protocol:
1886 //vector origin
1887 //byte red (0.0 to 1.0 converted to 0 to 255)
1888 //byte green (0.0 to 1.0 converted to 0 to 255)
1889 //byte blue (0.0 to 1.0 converted to 0 to 255)
1890 //description:
1891 //creates a colored explosion effect.
1892
1893 //DP_TE_FLAMEJET
1894 //idea: LordHavoc
1895 //darkplaces implementation: LordHavoc
1896 //builtin definitions:
1897 void(vector org, vector vel, float howmany) te_flamejet = #457;
1898 //temp entity definitions:
1899 //float TE_FLAMEJET = 74;
1900 //protocol:
1901 //vector origin
1902 //vector velocity
1903 //byte count (0 to 255, how many flame particles)
1904 //description:
1905 //creates a single puff of flame particles.  (not very useful really)
1906
1907 //DP_TE_PARTICLECUBE
1908 //idea: LordHavoc
1909 //darkplaces implementation: LordHavoc
1910 //builtin definitions:
1911 void(vector mincorner, vector maxcorner, vector vel, float howmany, float color, float gravityflag, float randomveljitter) te_particlecube = #408;
1912 //temp entity definitions:
1913 //float TE_PARTICLECUBE = 54;
1914 //protocol:
1915 //vector mins (minimum corner of the cube)
1916 //vector maxs (maximum corner of the cube)
1917 //vector velocity
1918 //short count
1919 //byte color (palette color)
1920 //byte gravity (TRUE or FALSE, FIXME should this be a scaler instead?)
1921 //coord randomvel (how much to jitter the velocity)
1922 //description:
1923 //creates a cloud of particles, useful for forcefields but quite customizable.
1924
1925 //DP_TE_PARTICLERAIN
1926 //idea: LordHavoc
1927 //darkplaces implementation: LordHavoc
1928 //builtin definitions:
1929 void(vector mincorner, vector maxcorner, vector vel, float howmany, float color) te_particlerain = #409;
1930 //temp entity definitions:
1931 //float TE_PARTICLERAIN = 55;
1932 //protocol:
1933 //vector mins (minimum corner of the cube)
1934 //vector maxs (maximum corner of the cube)
1935 //vector velocity (velocity of particles)
1936 //short count (number of particles)
1937 //byte color (8bit palette color)
1938 //description:
1939 //creates a shower of rain, the rain will appear either at the top (if falling down) or bottom (if falling up) of the cube.
1940
1941 //DP_TE_PARTICLESNOW
1942 //idea: LordHavoc
1943 //darkplaces implementation: LordHavoc
1944 //builtin definitions:
1945 void(vector mincorner, vector maxcorner, vector vel, float howmany, float color) te_particlesnow = #410;
1946 //temp entity definitions:
1947 //float TE_PARTICLERAIN = 56;
1948 //protocol:
1949 //vector mins (minimum corner of the cube)
1950 //vector maxs (maximum corner of the cube)
1951 //vector velocity (velocity of particles)
1952 //short count (number of particles)
1953 //byte color (8bit palette color)
1954 //description:
1955 //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.
1956
1957 //DP_TE_PLASMABURN
1958 //idea: LordHavoc
1959 //darkplaces implementation: LordHavoc
1960 //builtin definitions:
1961 void(vector org) te_plasmaburn = #433;
1962 //temp entity definitions:
1963 //float TE_PLASMABURN = 75;
1964 //protocol:
1965 //vector origin
1966 //description:
1967 //creates a small light flash (radius 200, time 0.2) and marks the walls.
1968
1969 //DP_TE_QUADEFFECTS1
1970 //idea: LordHavoc
1971 //darkplaces implementation: LordHavoc
1972 //builtin definitions:
1973 void(vector org) te_gunshotquad = #412;
1974 void(vector org) te_spikequad = #413;
1975 void(vector org) te_superspikequad = #414;
1976 void(vector org) te_explosionquad = #415;
1977 //temp entity definitions:
1978 //float   TE_GUNSHOTQUAD  = 57; // [vector] origin
1979 //float   TE_SPIKEQUAD    = 58; // [vector] origin
1980 //float   TE_SUPERSPIKEQUAD = 59; // [vector] origin
1981 //float   TE_EXPLOSIONQUAD = 70; // [vector] origin
1982 //protocol:
1983 //vector origin
1984 //description:
1985 //all of these just take a location, and are equivalent in function (but not appearance :) to the original TE_GUNSHOT, etc.
1986
1987 //DP_TE_SMALLFLASH
1988 //idea: LordHavoc
1989 //darkplaces implementation: LordHavoc
1990 //builtin definitions:
1991 void(vector org) te_smallflash = #416;
1992 //temp entity definitions:
1993 //float TE_SMALLFLASH = 72;
1994 //protocol:
1995 //vector origin
1996 //description:
1997 //creates a small light flash (radius 200, time 0.2).
1998
1999 //DP_TE_SPARK
2000 //idea: LordHavoc
2001 //darkplaces implementation: LordHavoc
2002 //builtin definitions:
2003 void(vector org, vector vel, float howmany) te_spark = #411;
2004 //temp entity definitions:
2005 //float TE_SPARK = 51;
2006 //protocol:
2007 //vector origin
2008 //byte xvelocity (-128 to 127)
2009 //byte yvelocity (-128 to 127)
2010 //byte zvelocity (-128 to 127)
2011 //byte count (number of sparks)
2012 //description:
2013 //creates a shower of sparks and a smoke puff.
2014
2015 //DP_TE_STANDARDEFFECTBUILTINS
2016 //idea: LordHavoc
2017 //darkplaces implementation: LordHavoc
2018 //builtin definitions:
2019 void(vector org) te_gunshot = #418;
2020 void(vector org) te_spike = #419;
2021 void(vector org) te_superspike = #420;
2022 void(vector org) te_explosion = #421;
2023 void(vector org) te_tarexplosion = #422;
2024 void(vector org) te_wizspike = #423;
2025 void(vector org) te_knightspike = #424;
2026 void(vector org) te_lavasplash = #425;
2027 void(vector org) te_teleport = #426;
2028 void(vector org, float color, float colorlength) te_explosion2 = #427;
2029 void(entity own, vector start, vector end) te_lightning1 = #428;
2030 void(entity own, vector start, vector end) te_lightning2 = #429;
2031 void(entity own, vector start, vector end) te_lightning3 = #430;
2032 void(entity own, vector start, vector end) te_beam = #431;
2033 //description:
2034 //to make life easier on mod coders.
2035
2036 //DP_TRACE_HITCONTENTSMASK_SURFACEINFO
2037 //idea: LordHavoc
2038 //darkplaces implementation: LordHavoc
2039 //globals:
2040 .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
2041 float trace_dpstartcontents; // DPCONTENTS_ value at start position of trace
2042 float trace_dphitcontents; // DPCONTENTS_ value of impacted surface (not contents at impact point, just contents of the surface that was hit)
2043 float trace_dphitq3surfaceflags; // Q3SURFACEFLAG_ value of impacted surface
2044 string trace_dphittexturename; // texture name of impacted surface
2045 //constants:
2046 float DPCONTENTS_SOLID = 1; // hit a bmodel, not a bounding box
2047 float DPCONTENTS_WATER = 2;
2048 float DPCONTENTS_SLIME = 4;
2049 float DPCONTENTS_LAVA = 8;
2050 float DPCONTENTS_SKY = 16;
2051 float DPCONTENTS_BODY = 32; // hit a bounding box, not a bmodel
2052 float DPCONTENTS_CORPSE = 64; // hit a SOLID_CORPSE entity
2053 float DPCONTENTS_NODROP = 128; // an area where backpacks should not spawn
2054 float DPCONTENTS_PLAYERCLIP = 256; // blocks player movement
2055 float DPCONTENTS_MONSTERCLIP = 512; // blocks monster movement
2056 float DPCONTENTS_DONOTENTER = 1024; // AI hint brush
2057 float DPCONTENTS_LIQUIDSMASK = 14; // WATER | SLIME | LAVA
2058 float DPCONTENTS_BOTCLIP = 2048; // AI hint brush
2059 float DPCONTENTS_OPAQUE = 4096; // only fully opaque brushes get this (may be useful for line of sight checks)
2060 float Q3SURFACEFLAG_NODAMAGE = 1;
2061 float Q3SURFACEFLAG_SLICK = 2; // low friction surface
2062 float Q3SURFACEFLAG_SKY = 4; // sky surface (also has NOIMPACT and NOMARKS set)
2063 float Q3SURFACEFLAG_LADDER = 8; // climbable surface
2064 float Q3SURFACEFLAG_NOIMPACT = 16; // projectiles should remove themselves on impact (this is set on sky)
2065 float Q3SURFACEFLAG_NOMARKS = 32; // projectiles should not leave marks, such as decals (this is set on sky)
2066 float Q3SURFACEFLAG_FLESH = 64; // projectiles should do a fleshy effect (blood?) on impact
2067 float Q3SURFACEFLAG_NODRAW = 128; // compiler hint (not important to qc)
2068 //float Q3SURFACEFLAG_HINT = 256; // compiler hint (not important to qc)
2069 //float Q3SURFACEFLAG_SKIP = 512; // compiler hint (not important to qc)
2070 //float Q3SURFACEFLAG_NOLIGHTMAP = 1024; // compiler hint (not important to qc)
2071 //float Q3SURFACEFLAG_POINTLIGHT = 2048; // compiler hint (not important to qc)
2072 float Q3SURFACEFLAG_METALSTEPS = 4096; // walking on this surface should make metal step sounds
2073 float Q3SURFACEFLAG_NOSTEPS = 8192; // walking on this surface should not make footstep sounds
2074 float Q3SURFACEFLAG_NONSOLID = 16384; // compiler hint (not important to qc)
2075 //float Q3SURFACEFLAG_LIGHTFILTER = 32768; // compiler hint (not important to qc)
2076 //float Q3SURFACEFLAG_ALPHASHADOW = 65536; // compiler hint (not important to qc)
2077 //float Q3SURFACEFLAG_NODLIGHT = 131072; // compiler hint (not important to qc)
2078 //float Q3SURFACEFLAG_DUST = 262144; // translucent 'light beam' effect (not important to qc)
2079 //description:
2080 //adds additional information after a traceline/tracebox/tracetoss call.
2081 //also (very important) sets trace_* globals before calling .touch functions,
2082 //this allows them to inspect the nature of the collision (for example
2083 //determining if a projectile hit sky), clears trace_* variables for the other
2084 //object in a touch event (that is to say, a projectile moving will see the
2085 //trace results in its .touch function, but the player it hit will see very
2086 //little information in the trace_ variables as it was not moving at the time)
2087
2088 //DP_VIEWZOOM
2089 //idea: LordHavoc
2090 //darkplaces implementation: LordHavoc
2091 //field definitions:
2092 .float viewzoom;
2093 //description:
2094 //scales fov and sensitivity of player, valid range is 0 to 1 (intended for sniper rifle zooming, and such)
2095
2096 //EXT_BITSHIFT
2097 //idea: Spike
2098 //darkplaces implementation: [515]
2099 //builtin definitions:
2100 float(float number, float quantity) bitshift = #218;
2101 //description:
2102 //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).
2103 //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.
2104
2105 //FRIK_FILE
2106 //idea: FrikaC
2107 //darkplaces implementation: LordHavoc
2108 //builtin definitions:
2109 float(string s) stof = #81; // get numerical value from a string
2110 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
2111 void(float fhandle) fclose = #111; // closes a file
2112 string(float fhandle) fgets = #112; // reads a line of text from the file and returns as a tempstring
2113 void(float fhandle, string s, ...) fputs = #113; // writes a line of text to the end of the file
2114 float(string s) strlen = #114; // returns how many characters are in a string
2115 string(string s1, string s2, ...) strcat = #115; // concatenates two or more strings (for example "abc", "def" would return "abcdef") and returns as a tempstring
2116 string(string s, float start, float length) substring = #116; // returns a section of a string as a tempstring - see FTE_STRINGS for enhanced version
2117 vector(string s) stov = #117; // returns vector value from a string
2118 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)
2119 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!!!)
2120 //constants:
2121 float FILE_READ = 0;
2122 float FILE_APPEND = 1;
2123 float FILE_WRITE = 2;
2124 //cvars:
2125 //pr_zone_min_strings : default 64 (64k), min 64 (64k), max 8192 (8mb)
2126 //description:
2127 //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.
2128 //
2129 //NOTE: strzone functionality is partially superseded by
2130 //DP_QC_UNLIMITEDTEMPSTRINGS when longterm storage is not needed
2131 //NOTE: substring is upgraded by FTE_STRINGS extension with negative start/length handling identical to php 5.2.0
2132
2133 //FTE_CSQC_SKELETONOBJECTS
2134 //idea: Spike, LordHavoc
2135 //darkplaces implementation: LordHavoc
2136 //builtin definitions:
2137 // all skeleton numbers are 1-based (0 being no skeleton)
2138 // all bone numbers are 1-based (0 being invalid)
2139 float(float modlindex) skel_create = #263; // create a skeleton (be sure to assign this value into .skeletonindex for use), returns skeleton index (1 or higher) on success, returns 0 on failure (for example if the modelindex is not skeletal), it is recommended that you create a new skeleton if you change modelindex, as the skeleton uses the hierarchy from the model.
2140 float(float skel, entity ent, float modlindex, float retainfrac, float firstbone, float lastbone) skel_build = #264; // blend in a percentage of standard animation, 0 replaces entirely, 1 does nothing, 0.5 blends half, etc, and this only alters the bones in the specified range for which out of bounds values like 0,100000 are safe (uses .frame, .frame2, .frame3, .frame4, .lerpfrac, .lerpfrac3, .lerpfrac4, .frame1time, .frame2time, .frame3time, .frame4time), returns skel on success, 0 on failure
2141 float(float skel) skel_get_numbones = #265; // returns how many bones exist in the created skeleton, 0 if skeleton does not exist
2142 string(float skel, float bonenum) skel_get_bonename = #266; // returns name of bone (as a tempstring), "" if invalid bonenum (< 1 for example) or skeleton does not exist
2143 float(float skel, float bonenum) skel_get_boneparent = #267; // returns parent num for supplied bonenum, 0 if bonenum has no parent or bone does not exist (returned value is always less than bonenum, you can loop on this)
2144 float(float skel, string tagname) skel_find_bone = #268; // get number of bone with specified name, 0 on failure, bonenum (1-based) on success, same as using gettagindex but takes modelindex instead of entity
2145 vector(float skel, float bonenum) skel_get_bonerel = #269; // get matrix of bone in skeleton relative to its parent - sets v_forward, v_right, v_up, returns origin (relative to parent bone)
2146 vector(float skel, float bonenum) skel_get_boneabs = #270; // get matrix of bone in skeleton in model space - sets v_forward, v_right, v_up, returns origin (relative to entity)
2147 void(float skel, float bonenum, vector org) skel_set_bone = #271; // set matrix of bone relative to its parent, reads v_forward, v_right, v_up, takes origin as parameter (relative to parent bone)
2148 void(float skel, float bonenum, vector org) skel_mul_bone = #272; // transform bone matrix (relative to its parent) by the supplied matrix in v_forward, v_right, v_up, takes origin as parameter (relative to parent bone)
2149 void(float skel, float startbone, float endbone, vector org) skel_mul_bones = #273; // transform bone matrices (relative to their parents) by the supplied matrix in v_forward, v_right, v_up, takes origin as parameter (relative to parent bones)
2150 void(float skeldst, float skelsrc, float startbone, float endbone) skel_copybones = #274; // copy bone matrices (relative to their parents) from one skeleton to another, useful for copying a skeleton to a corpse
2151 void(float skel) skel_delete = #275; // deletes skeleton at the beginning of the next frame (you can add the entity, delete the skeleton, renderscene, and it will still work)
2152 float(float modlindex, string framename) frameforname = #276; // finds number of a specified frame in the animation, returns -1 if no match found
2153 float(float modlindex, float framenum) frameduration = #277; // returns the intended play time (in seconds) of the specified framegroup, if it does not exist the result is 0, if it is a single frame it may be a small value around 0.1 or 0.
2154 //fields:
2155 .float skeletonindex; // active skeleton overriding standard animation on model
2156 .float frame; // primary framegroup animation (strength = 1 - lerpfrac - lerpfrac3 - lerpfrac4)
2157 .float frame2; // secondary framegroup animation (strength = lerpfrac)
2158 .float frame3; // tertiary framegroup animation (strength = lerpfrac3)
2159 .float frame4; // quaternary framegroup animation (strength = lerpfrac4)
2160 .float lerpfrac; // strength of framegroup blend
2161 .float lerpfrac3; // strength of framegroup blend
2162 .float lerpfrac4; // strength of framegroup blend
2163 .float frame1time; // start time of framegroup animation
2164 .float frame2time; // start time of framegroup animation
2165 .float frame3time; // start time of framegroup animation
2166 .float frame4time; // start time of framegroup animation
2167 //description:
2168 //this extension provides a way to do complex skeletal animation on an entity.
2169 //
2170 //see also DP_SKELETONOBJECTS (this extension implemented on server as well as client)
2171 //
2172 //notes:
2173 //each model contains its own skeleton, reusing a skeleton with incompatible models will yield garbage (or not render).
2174 //each model contains its own animation data, you can use animations from other model files (for example saving out all character animations as separate model files).
2175 //if an engine supports loading an animation-only file format such as .md5anim in FTEQW, it can be used to animate any model with a compatible skeleton.
2176 //proper use of this extension may require understanding matrix transforms (v_forward, v_right, v_up, origin), and you must keep in mind that v_right is negative for this purpose.
2177 //
2178 //features include:
2179 //multiple animations blended together.
2180 //animating a model with animations from another model with a compatible skeleton.
2181 //restricting animation blends to certain bones of a model - for example independent animation of legs, torso, head.
2182 //custom bone controllers - for example making eyes track a target location.
2183 //
2184 //
2185 //
2186 //example code follows...
2187 //
2188 //this helper function lets you identify (by parentage) what group a bone
2189 //belongs to - for example "torso", "leftarm", would return 1 ("torso") for
2190 //all children of the bone named "torso", unless they are children of
2191 //"leftarm" (which is a child of "torso") which would return 2 instead...
2192 float(float skel, float bonenum, string g1, string g2, string g3, string g4, string g5, string g6) example_skel_findbonegroup =
2193 {
2194         local string bonename;
2195         while (bonenum >= 0)
2196         {
2197                 bonename = skel_get_bonename(skel, bonenum);
2198                 if (bonename == g1) return 1;
2199                 if (bonename == g2) return 2;
2200                 if (bonename == g3) return 3;
2201                 if (bonename == g4) return 4;
2202                 if (bonename == g5) return 5;
2203                 if (bonename == g6) return 6;
2204                 bonenum = skel_get_boneparent(skel, bonenum);
2205         }
2206         return 0;
2207 };
2208 // create a skeletonindex for our player using current modelindex
2209 void() example_skel_player_setup =
2210 {
2211         self.skeletonindex = skel_create(self.modelindex);
2212 };
2213 // setup bones of skeleton based on an animation
2214 // note: animmodelindex can be a different model than self.modelindex
2215 void(float animmodelindex, float framegroup, float framegroupstarttime) example_skel_player_update_begin =
2216 {
2217         // start with our standard animation
2218         self.frame = framegroup;
2219         self.frame2 = 0;
2220         self.frame3 = 0;
2221         self.frame4 = 0;
2222         self.frame1time = framegroupstarttime;
2223         self.frame2time = 0;
2224         self.frame3time = 0;
2225         self.frame4time = 0;
2226         self.lerpfrac = 0;
2227         self.lerpfrac3 = 0;
2228         self.lerpfrac4 = 0;
2229         skel_build(self.skeletonindex, self, animmodelindex, 0, 0, 100000);
2230 };
2231 // apply a different framegroup animation to bones with a specified parent
2232 void(float animmodelindex, float framegroup, float framegroupstarttime, float blendalpha, string groupbonename, string excludegroupname1, string excludegroupname2) example_skel_player_update_applyoverride =
2233 {
2234         local float bonenum;
2235         local float numbones;
2236         self.frame = framegroup;
2237         self.frame2 = 0;
2238         self.frame3 = 0;
2239         self.frame4 = 0;
2240         self.frame1time = framegroupstarttime;
2241         self.frame2time = 0;
2242         self.frame3time = 0;
2243         self.frame4time = 0;
2244         self.lerpfrac = 0;
2245         self.lerpfrac3 = 0;
2246         self.lerpfrac4 = 0;
2247         bonenum = 0;
2248         numbones = skel_get_numbones(self.skeletonindex);
2249         while (bonenum < numbones)
2250         {
2251                 if (example_skel_findbonegroup(self.skeletonindex, bonenum, groupbonename, excludegroupname1, excludegroupname2, "", "", "") == 1)
2252                         skel_build(self.skeletonindex, self, animmodelindex, 1 - blendalpha, bonenum, bonenum + 1);
2253                 bonenum = bonenum + 1;
2254         }
2255 };
2256 // make eyes point at a target location, be sure v_forward, v_right, v_up are set correctly before calling
2257 void(vector eyetarget, string bonename) example_skel_player_update_eyetarget =
2258 {
2259         local float bonenum;
2260         local vector ang;
2261         local vector oldforward, oldright, oldup;
2262         local vector relforward, relright, relup, relorg;
2263         local vector boneforward, boneright, boneup, boneorg;
2264         local vector parentforward, parentright, parentup, parentorg;
2265         local vector u, v;
2266         local vector modeleyetarget;
2267         bonenum = skel_find_bone(self.skeletonindex, bonename) - 1;
2268         if (bonenum < 0)
2269                 return;
2270         oldforward = v_forward;
2271         oldright = v_right;
2272         oldup = v_up;
2273         v = eyetarget - self.origin;
2274         modeleyetarget_x =   v * v_forward;
2275         modeleyetarget_y = 0-v * v_right;
2276         modeleyetarget_z =   v * v_up;
2277         // this is an eyeball, make it point at the target location
2278         // first get all the data we can...
2279         relorg = skel_get_bonerel(self.skeletonindex, bonenum);
2280         relforward = v_forward;
2281         relright = v_right;
2282         relup = v_up;
2283         boneorg = skel_get_boneabs(self.skeletonindex, bonenum);
2284         boneforward = v_forward;
2285         boneright = v_right;
2286         boneup = v_up;
2287         parentorg = skel_get_boneabs(self.skeletonindex, skel_get_boneparent(self.skeletonindex, bonenum));
2288         parentforward = v_forward;
2289         parentright = v_right;
2290         parentup = v_up;
2291         // get the vector from the eyeball to the target
2292         u = modeleyetarget - boneorg;
2293         // now transform it inversely by the parent matrix to produce new rel vectors
2294         v_x = u * parentforward;
2295         v_y = u * parentright;
2296         v_z = u * parentup;
2297         ang = vectoangles2(v, relup);
2298         ang_x = 0 - ang_x;
2299         makevectors(ang);
2300         // set the relative bone matrix
2301         skel_set_bone(self.skeletonindex, bonenum, relorg);
2302         // restore caller's v_ vectors
2303         v_forward = oldforward;
2304         v_right = oldright;
2305         v_up = oldup;
2306 };
2307 // delete skeleton when we're done with it
2308 // note: skeleton remains valid until next frame when it is really deleted
2309 void() example_skel_player_delete =
2310 {
2311         skel_delete(self.skeletonindex);
2312         self.skeletonindex = 0;
2313 };
2314 //
2315 // END OF EXAMPLES FOR FTE_CSQC_SKELETONOBJECTS
2316 //
2317
2318 //KRIMZON_SV_PARSECLIENTCOMMAND
2319 //idea: KrimZon
2320 //darkplaces implementation: KrimZon, LordHavoc
2321 //engine-called QC prototypes:
2322 //void(string s) SV_ParseClientCommand;
2323 //builtin definitions:
2324 void(entity e, string s) clientcommand = #440;
2325 float(string s) tokenize = #441;
2326 string(float n) argv = #442;
2327 //description:
2328 //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
2329
2330 //NEH_CMD_PLAY2
2331 //idea: Nehahra
2332 //darkplaces implementation: LordHavoc
2333 //description:
2334 //shows that the engine supports the "play2" console command (plays a sound without spatialization).
2335
2336 //NEH_RESTOREGAME
2337 //idea: Nehahra
2338 //darkplaces implementation: LordHavoc
2339 //engine-called QC prototypes:
2340 //void() RestoreGame;
2341 //description:
2342 //when a savegame is loaded, this function is called
2343
2344 //NEXUIZ_PLAYERMODEL
2345 //idea: Nexuiz
2346 //darkplaces implementation: Black
2347 //console commands:
2348 //playermodel <name> - FIXME: EXAMPLE NEEDED
2349 //playerskin <name> - FIXME: EXAMPLE NEEDED
2350 //field definitions:
2351 .string playermodel; // name of player model sent by client
2352 .string playerskin; // name of player skin sent by client
2353 //description:
2354 //these client properties are used by Nexuiz.
2355
2356 //NXQ_GFX_LETTERBOX
2357 //idea: nxQuake
2358 //darkplaces implementation: LordHavoc
2359 //description:
2360 //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
2361
2362 //PRYDON_CLIENTCURSOR
2363 //idea: FrikaC
2364 //darkplaces implementation: LordHavoc
2365 //effects bit:
2366 float EF_SELECTABLE = 16384; // allows cursor to highlight entity (brighten)
2367 //field definitions:
2368 .float cursor_active; // true if cl_prydoncursor mode is on
2369 .vector cursor_screen; // screen position of cursor as -1 to +1 in _x and _y (_z unused)
2370 .vector cursor_trace_start; // position of camera
2371 .vector cursor_trace_endpos; // position of cursor in world (as traced from camera)
2372 .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)
2373 //cvar definitions:
2374 //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)
2375 //description:
2376 //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.
2377 //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.
2378 //the clientside trace skips transparent entities (except those marked EF_SELECTABLE).
2379 //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).
2380 //intended to be used by Prydon Gate.
2381
2382 //TENEBRAE_GFX_DLIGHTS
2383 //idea: Tenebrae
2384 //darkplaces implementation: LordHavoc
2385 //fields:
2386 .float light_lev; // radius (does not affect brightness), typical value 350
2387 .vector color; // color (does not affect radius), typical value '1 1 1' (bright white), can be up to '255 255 255' (nuclear blast)
2388 .float style; // light style (like normal light entities, flickering torches or switchable, etc)
2389 .float pflags; // flags (see PFLAGS_ constants)
2390 .vector angles; // orientation of the light
2391 .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
2392 //constants:
2393 float PFLAGS_NOSHADOW = 1; // light does not cast shadows
2394 float PFLAGS_CORONA = 2; // light has a corona flare
2395 float PFLAGS_FULLDYNAMIC = 128; // light enable (without this set no light is produced!)
2396 //description:
2397 //more powerful dynamic light settings
2398 //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)
2399 //changes compared to tenebrae (because they're too 'leet' for standards):
2400 //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)
2401 //EF_FULLDYNAMIC effects flag replaced by PFLAGS_FULLDYNAMIC flag (EF_FULLDYNAMIC conflicts with EF_NODRAW)
2402
2403 //TW_SV_STEPCONTROL
2404 //idea: Transfusion
2405 //darkplaces implementation: LordHavoc
2406 //cvars:
2407 //sv_jumpstep (0/1, default 1)
2408 //sv_stepheight (default 18)
2409 //description:
2410 //sv_jumpstep allows stepping up onto stairs while airborn, sv_stepheight controls how high a single step can be.
2411
2412 //FTE_QC_CHECKPVS
2413 //idea: Urre
2414 //darkplaces implementation: divVerent
2415 //builtin definitions:
2416 float checkpvs(vector viewpos, entity viewee) = #240;
2417 //description:
2418 //returns true if viewee can be seen from viewpos according to PVS data
2419
2420 //FTE_STRINGS
2421 //idea: many
2422 //darkplaces implementation: KrimZon
2423 //builtin definitions:
2424 float(string str, string sub, float startpos) strstrofs = #221; // returns the offset into a string of the matching text, or -1 if not found, case sensitive
2425 float(string str, float ofs) str2chr = #222; // returns the character at the specified offset as an integer, or 0 if an invalid index, or byte value - 256 if the engine supports UTF8 and the byte is part of an extended character
2426 string(float c, ...) chr2str = #223; // returns a string representing the character given, if the engine supports UTF8 this may be a multi-byte sequence (length may be more than 1) for characters over 127.
2427 string(float ccase, float calpha, float cnum, string s, ...) strconv = #224; // reformat a string with special color characters in the font, DO NOT USE THIS ON UTF8 ENGINES (if you are lucky they will emit ^4 and such color codes instead), the parameter values are 0=same/1=lower/2=upper for ccase, 0=same/1=white/2=red/5=alternate/6=alternate-alternate for redalpha, 0=same/1=white/2=red/3=redspecial/4=whitespecial/5=alternate/6=alternate-alternate for rednum.
2428 string(float chars, string s, ...) strpad = #225; // pad string with spaces to a specified length, < 0 = left padding, > 0 = right padding
2429 string(string info, string key, string value, ...) infoadd = #226; // sets or adds a key/value pair to an infostring - note: forbidden characters are \ and "
2430 string(string info, string key) infoget = #227; // gets a key/value pair in an infostring, returns value or null if not found
2431 float(string s1, string s2) strcmp = #228; // compare two strings
2432 float(string s1, string s2, float len) strncmp = #228; // compare two strings up to the specified number of characters, if their length differs and is within the specified limit the result will be negative, otherwise it is the difference in value of their first non-matching character.
2433 float(string s1, string s2) strcasecmp = #229; // compare two strings with case-insensitive matching, characters a-z are considered equivalent to the matching A-Z character, no other differences, and this does not consider special characters equal even if they look similar
2434 float(string s1, string s2, float len) strncasecmp = #230; // same as strcasecmp but with a length limit, see strncmp
2435 //string(string s, float start, float length) substring = #116; // see note below
2436 //description:
2437 //various string manipulation functions
2438 //note: substring also exists in FRIK_FILE but this extension adds negative start and length as valid cases (see note above), substring is consistent with the php 5.2.0 substr function (not 5.2.3 behavior)
2439 //substring returns a section of a string as a tempstring, if given negative
2440 // start the start is measured back from the end of the string, if given a
2441 // negative length the length is the offset back from the end of the string to
2442 // stop at, rather than being relative to start, if start is negative and
2443 // larger than length it is treated as 0.
2444 // examples of substring:
2445 // substring("blah", -3, 3) returns "lah"
2446 // substring("blah", 3, 3) returns "h"
2447 // substring("blah", -10, 3) returns "bla"
2448 // substring("blah", -10, -3) returns "b"
2449
2450 //DP_CON_BESTWEAPON
2451 //idea: many
2452 //darkplaces implementation: divVerent
2453 //description:
2454 //allows QC to register weapon properties for use by the bestweapon command, for mods that change required ammo count or type for the weapons
2455 //it is done using console commands sent via stuffcmd:
2456 //  register_bestweapon quake
2457 //  register_bestweapon clear
2458 //  register_bestweapon <shortname> <impulse> <itemcode> <activeweaponcode> <ammostat> <ammomin>
2459 //for example, this is what Quake uses:
2460 //  register_bestweapon 1 1 4096 4096 6 0 // STAT_SHELLS is 6
2461 //  register_bestweapon 2 2    1    1 6 1
2462 //  register_bestweapon 3 3    2    2 6 1
2463 //  register_bestweapon 4 4    4    4 7 1 // STAT_NAILS is 7
2464 //  register_bestweapon 5 5    8    8 7 1
2465 //  register_bestweapon 6 6   16   16 8 1 // STAT_ROCKETS is 8
2466 //  register_bestweapon 7 7   32   32 8 1
2467 //  register_bestweapon 8 8   64   64 9 1 // STAT_CELLS is 9
2468 //after each map client initialization, this is reset back to Quake settings. So you should send these data in ClientConnect.
2469 //also, this extension introduces a new "cycleweapon" command to the user.
2470
2471 //DP_QC_STRINGBUFFERS
2472 //idea: ??
2473 //darkplaces implementation: LordHavoc
2474 //functions to manage string buffer objects - that is, arbitrary length string arrays that are handled by the engine
2475 float() buf_create = #460;
2476 void(float bufhandle) buf_del = #461;
2477 float(float bufhandle) buf_getsize = #462;
2478 void(float bufhandle_from, float bufhandle_to) buf_copy = #463;
2479 void(float bufhandle, float sortpower, float backward) buf_sort = #464;
2480 string(float bufhandle, string glue) buf_implode = #465;
2481 string(float bufhandle, float string_index) bufstr_get = #466;
2482 void(float bufhandle, float string_index, string str) bufstr_set = #467;
2483 float(float bufhandle, string str, float order) bufstr_add = #468;
2484 void(float bufhandle, float string_index) bufstr_free = #469;
2485
2486 //DP_QC_STRINGBUFFERS_CVARLIST
2487 //idea: divVerent
2488 //darkplaces implementation: divVerent
2489 //functions to list cvars and store their names into a stringbuffer
2490 //cvars that start with pattern but not with antipattern will be stored into the buffer
2491 void(float bufhandle, string pattern, string antipattern) buf_cvarlist = #517;
2492
2493 //DP_QC_STRINGBUFFERS_EXT_WIP
2494 //idea: VorteX
2495 //darkplaces implementation: VorteX
2496 //constant definitions:
2497 const float MATCH_AUTO = 0;
2498 const float MATCH_WHOLE = 1;
2499 const float MATCH_LEFT = 2;
2500 const float MATCH_RIGHT = 3;
2501 const float MATCH_MIDDLE = 4;
2502 const float MATCH_PATTERN = 5;
2503 //builtin definitions:
2504 float(string filename, float bufhandle) buf_loadfile = #535; // append each line of file as new buffer string, return 1 if succesful
2505 float(float filehandle, float bufhandle, float startpos, float numstrings) buf_writefile = #536; // writes buffer strings as lines, returns 1 if succesful
2506 float(float bufhandle, string match, float matchrule, float startpos, float step) bufstr_find = #537; // returns string index
2507 float(string s, string pattern, float matchrule) matchpattern = #538; // returns 0/1
2508 float(string s, string pattern, float matchrule, float pos) matchpatternofs = #538;
2509 //description:
2510 //provides a set of functions to manipulate with string buffers
2511 //pattern wildcards: * - any character (or no characters), ? - any 1 character
2512 //Warning: This extension is work-in-progress, it may be changed/revamped/removed at any time, dont use it if you dont want any trouble
2513 //wip note: UTF8 is not supported yet
2514
2515 //DP_QC_STRREPLACE
2516 //idea: Sajt
2517 //darkplaces implementation: Sajt
2518 //builtin definitions:
2519 string(string search, string replace, string subject) strreplace = #484;
2520 string(string search, string replace, string subject) strireplace = #485;
2521 //description:
2522 //strreplace replaces all occurrences of 'search' with 'replace' in the string 'subject', and returns the result as a tempstring.
2523 //strireplace does the same but uses case-insensitive matching of the 'search' term
2524
2525 //DP_SV_SHUTDOWN
2526 //idea: divVerent
2527 //darkplaces implementation: divVerent
2528 //A function that gets called just before progs exit. To save persistent data from.
2529 //It is not called on a crash or error.
2530 //void SV_Shutdown();
2531
2532 //EXT_CSQC
2533 // #232 void(float index, float type, .void field) SV_AddStat (EXT_CSQC)
2534 void(float index, float type, ...) addstat = #232;
2535
2536 //ZQ_PAUSE
2537 //idea: ZQuake
2538 //darkplaces implementation: GreEn`mArine
2539 //builtin definitions:
2540 void(float pause) setpause = #531;
2541 //function definitions:
2542 //void(float elapsedtime) SV_PausedTic;
2543 //description:
2544 //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).
2545 //
2546 //calling setpause(0) will end a pause immediately.
2547 //
2548 //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.
2549
2550 //DP_COVERAGE
2551 //idea: divVerent
2552 //darkplaces implementation: divVerent
2553 //function definitions:
2554 void coverage() = #642;  // Reports a coverage event. The engine counts for each of the calls to this builtin whether it has been called.
2555
2556
2557 // EXPERIMENTAL (not finalized) EXTENSIONS:
2558
2559 //DP_CRYPTO
2560 //idea: divVerent
2561 //darkplaces implementation: divVerent
2562 //field definitions: (SVQC)
2563 .string crypto_keyfp; // fingerprint of CA key the player used to authenticate
2564 .string crypto_mykeyfp; // fingerprint of CA key the server used to authenticate to the player
2565 .string crypto_idfp; // fingerprint of ID used by the player entity, or string_null if not identified
2566 .float crypto_idfp_signed; // set if the player's ID has been signed
2567 .string crypto_encryptmethod; // the string "AES128" if encrypting, and string_null if plaintext
2568 .string crypto_signmethod; // the string "HMAC-SHA256" if signing, and string_null if plaintext
2569 // there is no field crypto_myidfp, as that info contains no additional information the QC may have a use for
2570 //builtin definitions: (SVQC)
2571 float(string url, float id, string content_type, string delim, float buf, float keyid) crypto_uri_postbuf = #513;
2572 //description:
2573 //use -1 as buffer handle to justs end delim as postdata