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