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