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