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