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