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