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