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