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