]> icculus.org git repositories - divverent/nexuiz.git/blob - data/qcsrc/server/extensions.qh
handle self/oself CORRECTLY this time
[divverent/nexuiz.git] / data / qcsrc / server / extensions.qh
1
2 //DarkPlaces supported extension list, draft version 1.04
3
4 //things that don't have extensions yet:
5 .float disableclientprediction;
6
7 //definitions that id Software left out:
8 //these are passed as the 'nomonsters' parameter to traceline/tracebox (yes really this was supported in all quake engines, nomonsters is misnamed)
9 float MOVE_NORMAL = 0; // same as FALSE
10 float MOVE_NOMONSTERS = 1; // same as TRUE
11 float MOVE_MISSILE = 2; // save as movement with .movetype == MOVETYPE_FLYMISSILE
12
13 //checkextension function
14 //idea: expected by almost everyone
15 //darkplaces implementation: LordHavoc
16 float(string s) checkextension = #99;
17 //description:
18 //check if (cvar("pr_checkextension")) before calling this, this is the only
19 //guaranteed extension to be present in the extension system, it allows you
20 //to check if an extension is available, by name, to check for an extension
21 //use code like this:
22 //// (it is recommended this code be placed in worldspawn or a worldspawn called function somewhere)
23 //if (cvar("pr_checkextension"))
24 //if (checkextension("DP_SV_SETCOLOR"))
25 //      ext_setcolor = TRUE;
26 //from then on you can check ext_setcolor to know if that extension is available
27
28 //BX_WAL_SUPPORT
29 //idea: id Software
30 //darkplaces implementation: LordHavoc
31 //description:
32 //indicates the engine supports .wal textures for filenames in the textures/ directory
33 //(note: DarkPlaces has supported this since 2001 or 2002, but did not advertise it as an extension, then I noticed Betwix was advertising it and added the extension accordingly)
34
35 //DP_BUTTONCHAT
36 //idea: Vermeulen
37 //darkplaces implementation: LordHavoc
38 //field definitions:
39 .float buttonchat;
40 //description:
41 //true if the player is currently chatting (in messagemode, menus or console)
42
43 //DP_BUTTONUSE
44 //idea: id Software
45 //darkplaces implementation: LordHavoc
46 //field definitions:
47 .float buttonuse;
48 //client console commands:
49 //+use
50 //-use
51 //description:
52 //made +use and -use commands work, they now control the .buttonuse field (.button1 was used by many mods for other purposes).
53
54 // LordHavoc: HIGHLY experimental, do not implement this in other engines
55 //DP_CGAME
56 //idea: LordHavoc
57 //darkplaces implementation: LordHavoc
58 //SVC definitions:
59 float svc_cgame = 50; // [short] length [bytes] data
60 //description:
61 //contains network messages to client gamecode.
62
63 //DP_CL_LOADSKY
64 //idea: Nehahra, LordHavoc
65 //darkplaces implementation: LordHavoc
66 //client console commands:
67 //"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)
68 //description:
69 //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).
70
71 //DP_CON_SET
72 //idea: id Software
73 //darkplaces implementation: LordHavoc
74 //description:
75 //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.
76
77 //DP_CON_SETA
78 //idea: id Software
79 //darkplaces implementation: LordHavoc
80 //description:
81 //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.
82
83 //DP_CON_ALIASPARAMETERS
84 //idea: many
85 //darkplaces implementation: Black
86 //description:
87 //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).
88
89 //DP_CON_EXPANDCVAR
90 //idea: many, PHP
91 //darkplaces implementation: Black
92 //description:
93 //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.
94
95 //DP_CON_STARTMAP
96 //idea: LordHavoc
97 //darkplaces implementation: LordHavoc
98 //description:
99 //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".
100
101 //DP_EF_ADDITIVE
102 //idea: LordHavoc
103 //darkplaces implementation: LordHavoc
104 //effects bit:
105 float   EF_ADDITIVE     = 32;
106 //description:
107 //additive blending when this object is rendered
108
109 //DP_EF_BLUE
110 //idea: id Software
111 //darkplaces implementation: LordHavoc
112 //effects bit:
113 float   EF_BLUE         = 64;
114 //description:
115 //entity emits blue light (used for quad)
116
117 //DP_EF_DOUBLESIDED
118 //idea: LordHavoc
119 //darkplaces implementation: [515] and LordHavoc
120 //effects bit:
121 float EF_DOUBLESIDED = 32768;
122 //description:
123 //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.
124
125 //DP_EF_FLAME
126 //idea: LordHavoc
127 //darkplaces implementation: LordHavoc
128 //effects bit:
129 float   EF_FLAME        = 1024;
130 //description:
131 //entity is on fire
132
133 //DP_EF_FULLBRIGHT
134 //idea: LordHavoc
135 //darkplaces implementation: LordHavoc
136 //effects bit:
137 float   EF_FULLBRIGHT   = 512;
138 //description:
139 //entity is always brightly lit
140
141 //DP_EF_NODEPTHTEST
142 //idea: Supa
143 //darkplaces implementation: LordHavoc
144 //effects bit:
145 float   EF_NODEPTHTEST       = 8192;
146 //description:
147 //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
148
149 //DP_EF_NODRAW
150 //idea: id Software
151 //darkplaces implementation: LordHavoc
152 //effects bit:
153 float   EF_NODRAW       = 16;
154 //description:
155 //prevents server from sending entity to client (forced invisible, even if it would have been a light source or other such things)
156
157 //DP_EF_NOGUNBOB
158 //idea: Chris Page, Dresk
159 //darkplaces implementation: LordHAvoc
160 //effects bit:
161 float   EF_NOGUNBOB     = 256;
162 //description:
163 //this has different meanings depending on the entity it is used on:
164 //player entity - prevents gun bobbing on player.viewmodel
165 //viewmodelforclient entity - prevents gun bobbing on an entity attached to the player's view
166 //other entities - no effect
167 //uses:
168 //disabling gun bobbing on a diving mask or other model used as a .viewmodel.
169 //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)
170
171 //DP_EF_NOSHADOW
172 //idea: LordHavoc
173 //darkplaces implementation: LordHavoc
174 //effects bit:
175 float   EF_NOSHADOW     = 4096;
176 //description:
177 //realtime lights will not cast shadows from this entity (but can still illuminate it)
178
179 //DP_EF_RED
180 //idea: id Software
181 //darkplaces implementation: LordHavoc
182 //effects bit:
183 float   EF_RED          = 128;
184 //description:
185 //entity emits red light (used for invulnerability)
186
187 //DP_EF_STARDUST
188 //idea: MythWorks Inc
189 //darkplaces implementation: LordHavoc
190 //effects bit:
191 float   EF_STARDUST     = 2048;
192 //description:
193 //entity emits bouncing sparkles in every direction
194
195 //DP_ENT_ALPHA
196 //idea: Nehahra
197 //darkplaces implementation: LordHavoc
198 //fields:
199 .float alpha;
200 //description:
201 //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).
202
203 //DP_ENT_COLORMOD
204 //idea: LordHavoc
205 //darkplaces implementation: LordHavoc
206 //field definition:
207 .vector colormod;
208 //description:
209 //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).
210
211 //DP_ENT_CUSTOMCOLORMAP
212 //idea: LordHavoc
213 //darkplaces implementation: LordHavoc
214 //description:
215 //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.
216
217 /*
218 //NOTE: no longer supported by darkplaces because all entities are delta compressed now
219 //DP_ENT_DELTACOMPRESS // no longer supported
220 //idea: LordHavoc
221 //darkplaces implementation: LordHavoc
222 //effects bit:
223 float EF_DELTA = 8388608;
224 //description:
225 //(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).
226 */
227
228 //DP_ENT_EXTERIORMODELTOCLIENT
229 //idea: LordHavoc
230 //darkplaces implementation: LordHavoc
231 //fields:
232 .entity exteriormodeltoclient;
233 //description:
234 //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.
235
236 //DP_ENT_GLOW
237 //idea: LordHavoc
238 //darkplaces implementation: LordHavoc
239 //field definitions:
240 .float glow_color;
241 .float glow_size;
242 .float glow_trail;
243 //description:
244 //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.
245
246 //DP_ENT_LOWPRECISION
247 //idea: LordHavoc
248 //darkplaces implementation: LordHavoc
249 //effects bit:
250 float EF_LOWPRECISION = 4194304;
251 //description:
252 //uses low quality origin coordinates, reducing network traffic compared to the default high precision, intended for numerous objects (projectiles/gibs/bullet holes/etc).
253
254 //DP_ENT_SCALE
255 //idea: LordHavoc
256 //darkplaces implementation: LordHavoc
257 //field definitions:
258 .float scale;
259 //description:
260 //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.
261
262 //DP_ENT_VIEWMODEL
263 //idea: LordHavoc
264 //darkplaces implementation: LordHavoc
265 //field definitions:
266 .entity viewmodelforclient;
267 //description:
268 //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.
269
270 //DP_GFX_EXTERNALTEXTURES
271 //idea: LordHavoc
272 //darkplaces implementation: LordHavoc
273 //description:
274 //loads external textures found in various directories (tenebrae compatible)...
275 /*
276 in all examples .tga is merely the base texture, it can be any of these:
277 .tga (base texture)
278 _glow.tga (fullbrights or other glowing overlay stuff, NOTE: this is done using additive blend, not alpha)
279 _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)
280 _shirt.tga (same idea as pants, but for shirt color)
281 _diffuse.tga (this may be used instead of base texture for per pixel lighting)
282 _gloss.tga (specular texture for per pixel lighting, note this can be in color (tenebrae only supports greyscale))
283 _norm.tga (normalmap texture for per pixel lighting)
284 _bump.tga (bumpmap, converted to normalmap at load time, supported only for reasons of tenebrae compatibility)
285 _luma.tga (same as _glow but supported only for reasons of tenebrae compatibility)
286
287 due to glquake's incomplete Targa(r) loader, this section describes
288 required Targa(r) features support:
289 types:
290 type 1 (uncompressed 8bit paletted with 24bit/32bit palette)
291 type 2 (uncompressed 24bit/32bit true color, glquake supported this)
292 type 3 (uncompressed 8bit greyscale)
293 type 9 (RLE compressed 8bit paletted with 24bit/32bit palette)
294 type 10 (RLE compressed 24bit/32bit true color, glquake supported this)
295 type 11 (RLE compressed 8bit greyscale)
296 attribute bit 0x20 (Origin At Top Left, top to bottom, left to right)
297
298 image formats guaranteed to be supported: tga, pcx, lmp
299 image formats that are optional: png, jpg
300
301 mdl/spr/spr32 examples:
302 skins are named _A (A being a number) and skingroups are named like _A_B
303 these act as suffixes on the model name...
304 example names for skin _2_1 of model "progs/armor.mdl":
305 game/override/progs/armor.mdl_2_1.tga
306 game/textures/progs/armor.mdl_2_1.tga
307 game/progs/armor.mdl_2_1.tga
308 example names for skin _0 of the model "progs/armor.mdl":
309 game/override/progs/armor.mdl_0.tga
310 game/textures/progs/armor.mdl_0.tga
311 game/progs/armor.mdl_0.tga
312 note that there can be more skins files (of the _0 naming) than the mdl
313 contains, this is only useful to save space in the .mdl file if classic quake
314 compatibility is not a concern.
315
316 bsp/md2/md3 examples:
317 example names for the texture "quake" of model "maps/start.bsp":
318 game/override/quake.tga
319 game/textures/quake.tga
320 game/quake.tga
321
322 sbar/menu/console textures: for example the texture "conchars" (console font) in gfx.wad
323 game/override/gfx/conchars.tga
324 game/textures/gfx/conchars.tga
325 game/gfx/conchars.tga
326 */
327
328 //DP_GFX_EXTERNALTEXTURES_PERMAPTEXTURES
329 //idea: Fuh?
330 //darkplaces implementation: LordHavoc
331 //description:
332 //Q1BSP and HLBSP map loading loads external textures found in textures/<mapname>/ as well as textures/.
333 //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)
334 //example:
335 //maps/e1m1.bsp uses textures in the directory textures/e1m1/ and falls back to textures/
336 //maps/b_batt0.bsp uses textures in the directory textures/b_batt0.bsp and falls back to textures/
337 //as a more extreme example:
338 //progs/something/blah.bsp uses textures in the directory textures/progs/something/blah/ and falls back to textures/
339
340 //DP_GFX_FOG
341 //idea: LordHavoc
342 //darkplaces implementation: LordHavoc
343 //worldspawn fields:
344 //"fog" (parameters: "density red green blue", example: "0.1 0.3 0.3 0.3")
345 //description:
346 //global fog for the map, can not be changed by QC
347
348 //DP_GFX_QUAKE3MODELTAGS
349 //idea: id Software
350 //darkplaces implementation: LordHavoc
351 //field definitions:
352 .entity tag_entity; // entity this is attached to (call setattachment to set this)
353 .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)
354 //builtin definitions:
355 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)
356 //description:
357 //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).
358 //note 2: if the tag is not found, it defaults to "" (attach to origin/angles of entity)
359 //note 3: attaching to world turns off attachment
360 //note 4: the entity that this is attached to must be visible for this to work
361 //note 5: if an entity is attached to the player entity it will not be drawn in first person.
362
363 //DP_GFX_SKINFILES
364 //idea: LordHavoc
365 //darkplaces implementation: LordHavoc
366 //description:
367 //alias models (mdl, md2, md3) can have .skin files to replace conventional texture naming, these have a naming format such as:
368 //progs/test.md3_0.skin
369 //progs/test.md3_1.skin
370 //...
371 //
372 //these files contain replace commands (replace meshname shadername), example:
373 //replace "helmet" "progs/test/helmet1.tga" // this is a mesh shader replacement
374 //replace "teamstripes" "progs/test/redstripes.tga"
375 //replace "visor" "common/nodraw" // this makes the visor mesh invisible
376 ////it is not possible to rename tags using this format
377 //
378 //Or the Quake3 syntax (100% compatible with Quake3's .skin files):
379 //helmet,progs/test/helmet1.tga // this is a mesh shader replacement
380 //teamstripes,progs/test/redstripes.tga
381 //visor,common/nodraw // this makes the visor mesh invisible
382 //tag_camera, // this defines that the first tag in the model is called tag_camera
383 //tag_test, // this defines that the second tag in the model is called tag_test
384 //
385 //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.
386 //this feature is intended to allow multiple skin sets on md3 models (which otherwise only have one skin set).
387 //other commands might be added someday but it is not expected.
388
389 //DP_GFX_SKYBOX
390 //idea: LordHavoc
391 //darkplaces implementation: LordHavoc
392 //worldspawn fields:
393 //"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)
394 //description:
395 //global skybox for the map, can not be changed by QC
396
397 //DP_HALFLIFE_MAP
398 //idea: LordHavoc
399 //darkplaces implementation: LordHavoc
400 //description:
401 //simply indicates that the engine supports HalfLife maps (BSP version 30, NOT the QER RGBA ones which are also version 30).
402
403 //DP_HALFLIFE_MAP_CVAR
404 //idea: LordHavoc
405 //darkplaces implementation: LordHavoc
406 //cvars:
407 //halflifebsp 0/1
408 //description:
409 //engine sets this cvar when loading a map to indicate if it is halflife format or not.
410
411 //DP_HALFLIFE_SPRITE
412 //idea: LordHavoc
413 //darkplaces implementation: LordHavoc
414 //description:
415 //simply indicates that the engine supports HalfLife sprites.
416
417 //DP_INPUTBUTTONS
418 //idea: LordHavoc
419 //darkplaces implementation: LordHavoc
420 //field definitions:
421 .float button3;
422 .float button4;
423 .float button5;
424 .float button6;
425 .float button7;
426 .float button8;
427 //description:
428 //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).
429 //the exact mapping of protocol button bits on the server is:
430 //self.button0 = (bits & 1) != 0;
431 ///* button1 is skipped because mods abuse it as a variable, and accordingly it has no bit */
432 //self.button2 = (bits & 2) != 0;
433 //self.button3 = (bits & 4) != 0;
434 //self.button4 = (bits & 8) != 0;
435 //self.button5 = (bits & 16) != 0;
436 //self.button6 = (bits & 32) != 0;
437 //self.button7 = (bits & 64) != 0;
438 //self.button8 = (bits & 128) != 0;
439
440 //DP_LITSPRITES
441 //idea: LordHavoc
442 //darkplaces implementation: LordHavoc
443 //description:
444 //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).
445
446 //DP_LITSUPPORT
447 //idea: LordHavoc
448 //darkplaces implementation: LordHavoc
449 //description:
450 //indicates this engine loads .lit files for any quake1 format .bsp files it loads to enhance maps with colored lighting.
451 //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.
452
453 //DP_MONSTERWALK
454 //idea: LordHavoc
455 //darkplaces implementation: LordHavoc
456 //description:
457 //MOVETYPE_WALK is permitted on non-clients, so bots can move smoothly, run off ledges, etc, just like a real player.
458
459 //DP_MOVETYPEBOUNCEMISSILE
460 //idea: id Software
461 //darkplaces implementation: id Software
462 //movetype definitions:
463 //float MOVETYPE_BOUNCEMISSILE = 11; // already in defs.qc
464 //description:
465 //MOVETYPE_BOUNCE but without gravity, and with full reflection (no speed loss like grenades have), in other words - bouncing laser bolts.
466
467 //DP_MOVETYPEFOLLOW
468 //idea: id Software, LordHavoc (redesigned)
469 //darkplaces implementation: LordHavoc
470 //movetype definitions:
471 float MOVETYPE_FOLLOW = 12;
472 //description:
473 //MOVETYPE_FOLLOW implemented, this uses existing entity fields in unusual ways:
474 //aiment - the entity this is attached to.
475 //punchangle - the original angles when the follow began.
476 //view_ofs - the relative origin (note that this is un-rotated by punchangle, and that is actually the only purpose of punchangle).
477 //v_angle - the relative angles.
478 //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:
479 //hole.movetype = MOVETYPE_FOLLOW; // make the hole follow
480 //hole.solid = SOLID_NOT; // MOVETYPE_FOLLOW is always non-solid
481 //hole.aiment = bmodel; // make the hole follow bmodel
482 //hole.punchangle = bmodel.angles; // the original angles of bmodel
483 //hole.view_ofs = hole.origin - bmodel.origin; // relative origin
484 //hole.v_angle = hole.angles - bmodel.angles; // relative angles
485
486 //DP_QC_ASINACOSATANATAN2TAN
487 //idea: Urre
488 //darkplaces implementation: LordHavoc
489 //constant definitions:
490 float DEG2RAD = 0.0174532925199432957692369076848861271344287188854172545609719144;
491 float RAD2DEG = 57.2957795130823208767981548141051703324054724665643215491602438612;
492 float PI      = 3.1415926535897932384626433832795028841971693993751058209749445923;
493 //builtin definitions:
494 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
495 float(float c) acos = #472; // returns angle in radians for a given cos() value, the result is in the range 0 to PI
496 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
497 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)
498 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
499 //description:
500 //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).
501 //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)
502
503 //DP_QC_CHANGEPITCH
504 //idea: id Software
505 //darkplaces implementation: id Software
506 //field definitions:
507 .float idealpitch;
508 .float pitch_speed;
509 //builtin definitions:
510 void(entity ent) changepitch = #63;
511 //description:
512 //equivilant to changeyaw, ent is normally self. (this was a Q2 builtin)
513
514 //DP_QC_COPYENTITY
515 //idea: LordHavoc
516 //darkplaces implementation: LordHavoc
517 //builtin definitions:
518 void(entity from, entity to) copyentity = #400;
519 //description:
520 //copies all data in the entity to another entity.
521
522 //DP_QC_CVAR_DEFSTRING
523 //idea: id Software (Doom3), LordHavoc
524 //darkplaces implementation: LordHavoc
525 //builtin definitions:
526 string(string s) cvar_defstring = #482;
527 //description:
528 //returns the default value of a cvar, as a tempstring.
529
530 //DP_QC_CVAR_STRING
531 //idea: VorteX
532 //DarkPlaces implementation: VorteX, LordHavoc
533 //builtin definitions:
534 string(string s) cvar_string = #448;
535 //description:
536 //returns the value of a cvar, as a tempstring.
537
538 //DP_QC_ETOS
539 //idea: id Software
540 //darkplaces implementation: id Software
541 //builtin definitions:
542 string(entity ent) etos = #65;
543 //description:
544 //prints "entity 1" or similar into a string. (this was a Q2 builtin)
545
546 //DP_QC_FINDCHAIN
547 //idea: LordHavoc
548 //darkplaces implementation: LordHavoc
549 //builtin definitions:
550 entity(.string fld, string match) findchain = #402;
551 //description:
552 //similar to find() but returns a chain of entities like findradius.
553
554 //DP_QC_FINDCHAINFLAGS
555 //idea: Sajt
556 //darkplaces implementation: LordHavoc
557 //builtin definitions:
558 entity(.float fld, float match) findchainflags = #450;
559 //description:
560 //similar to findflags() but returns a chain of entities like findradius.
561
562 //DP_QC_FINDCHAINFLOAT
563 //idea: LordHavoc
564 //darkplaces implementation: LordHavoc
565 //builtin definitions:
566 entity(.entity fld, entity match) findchainentity = #403;
567 entity(.float fld, float match) findchainfloat = #403;
568 //description:
569 //similar to findentity()/findfloat() but returns a chain of entities like findradius.
570
571 //DP_QC_FINDFLAGS
572 //idea: Sajt
573 //darkplaces implementation: LordHavoc
574 //builtin definitions:
575 entity(entity start, .float fld, float match) findflags = #449;
576 //description:
577 //finds an entity with the specified flag set in the field, similar to find()
578
579 //DP_QC_FINDFLOAT
580 //idea: LordHavoc
581 //darkplaces implementation: LordHavoc
582 //builtin definitions:
583 entity(entity start, .entity fld, entity match) findentity = #98;
584 entity(entity start, .float fld, float match) findfloat = #98;
585 //description:
586 //finds an entity or float field value, similar to find(), but for entity and float fields.
587
588 //DP_QC_FS_SEARCH
589 //idea: Black
590 //darkplaces implementation: Black
591 //builtin definitions:
592 float(string pattern, float caseinsensitive, float quiet) search_begin = #444;
593 void(float handle) search_end = #445;
594 float(float handle) search_getsize = #446;
595 string(float handle, float num) search_getfilename = #447;
596 //description:
597 //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).
598 //search_end frees a search slot (also done at progs reload).
599 //search_getsize returns how many filenames were found.
600 //search_getfilename returns a filename from the search.
601
602 //DP_QC_GETLIGHT
603 //idea: LordHavoc
604 //darkplaces implementation: LordHavoc
605 //builtin definitions:
606 vector(vector org) getlight = #92;
607 //description:
608 //returns the lighting at the requested location (in color), 0-255 range (can exceed 255).
609
610 //DP_QC_GETSURFACE
611 //idea: LordHavoc
612 //darkplaces implementation: LordHavoc
613 //builtin definitions:
614 float(entity e, float s) getsurfacenumpoints = #434;
615 vector(entity e, float s, float n) getsurfacepoint = #435;
616 vector(entity e, float s) getsurfacenormal = #436;
617 string(entity e, float s) getsurfacetexture = #437;
618 float(entity e, vector p) getsurfacenearpoint = #438;
619 vector(entity e, float s, vector p) getsurfaceclippedpoint = #439;
620 //description:
621 //functions to query surface information.
622
623 //DP_QC_GETTAGINFO
624 //idea: VorteX, LordHavoc (somebody else?)
625 //DarkPlaces implementation: VorteX
626 //builtin definitions:
627 float(entity ent, string tagname) gettagindex = #451;
628 vector(entity ent, float tagindex) gettaginfo = #452;
629 //description:
630 //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).
631 //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.
632
633 //DP_QC_MINMAXBOUND
634 //idea: LordHavoc
635 //darkplaces implementation: LordHavoc
636 //builtin definitions:
637 float(float a, float b) min = #94;
638 float(float a, float b, float c) min3 = #94;
639 float(float a, float b, float c, float d) min4 = #94;
640 float(float a, float b, float c, float d, float e) min5 = #94;
641 float(float a, float b, float c, float d, float e, float f) min6 = #94;
642 float(float a, float b, float c, float d, float e, float f, float g) min7 = #94;
643 float(float a, float b, float c, float d, float e, float f, float g, float h) min8 = #94;
644 float(float a, float b) max = #95;
645 float(float a, float b, float c) max3 = #95;
646 float(float a, float b, float c, float d) max4 = #95;
647 float(float a, float b, float c, float d, float e) max5 = #95;
648 float(float a, float b, float c, float d, float e, float f) max6 = #95;
649 float(float a, float b, float c, float d, float e, float f, float g) max7 = #95;
650 float(float a, float b, float c, float d, float e, float f, float g, float h) max8 = #95;
651 float(float minimum, float val, float maximum) bound = #96;
652 //description:
653 //min returns the lowest of all the supplied numbers.
654 //max returns the highest of all the supplied numbers.
655 //bound clamps the value to the range and returns it.
656
657 //DP_QC_MULTIPLETEMPSTRINGS
658 //idea: LordHavoc
659 //darkplaces implementation: LordHavoc
660 //description:
661 //this extension makes all builtins returning tempstrings (ftos for example)
662 //cycle through a pool of multiple tempstrings (at least 16), allowing
663 //multiple ftos results to be gathered before putting them to use, normal
664 //quake only had 1 tempstring, causing many headaches.
665 //
666 //Note that for longer term storage (or compatibility on engines having
667 //FRIK_FILE but not this extension) the FRIK_FILE extension's
668 //strzone/strunzone builtins provide similar functionality (slower though).
669 //
670 //NOTE: this extension is superseded by DP_QC_UNLIMITEDTEMPSTRINGS
671
672 //DP_QC_RANDOMVEC
673 //idea: LordHavoc
674 //darkplaces implementation: LordHavoc
675 //builtin definitions:
676 vector() randomvec = #91;
677 //description:
678 //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)
679
680 //DP_QC_SINCOSSQRTPOW
681 //idea: id Software, LordHavoc
682 //darkplaces implementation: id Software, LordHavoc
683 //builtin definitions:
684 float(float val) sin = #60;
685 float(float val) cos = #61;
686 float(float val) sqrt = #62;
687 float(float a, float b) pow = #97;
688 //description:
689 //useful math functions, sine of val, cosine of val, square root of val, and raise a to power b, respectively.
690
691 //DP_QC_STRFTIME
692 //idea: LordHavoc
693 //darkplaces implementation: LordHavoc
694 //builtin definitions:
695 string(float uselocaltime, string format, ...) strftime = #478;
696 //description:
697 //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:
698 //example: "%Y-%m-%d %H:%M:%S"   (result looks like: 2007-02-08 01:03:15)
699 //note: "%F %T" gives the same result as "%Y-%m-%d %H:%M:%S" (ISO 8601 date format and 24-hour time)
700 //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.
701 //
702 //practical uses:
703 //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 = ftos(s);
704 //printing current date/time for competitive multiplayer games, such as the beginning/end of each round in real world time.
705 //activating eastereggs in singleplayer games on certain dates.
706 //
707 //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.
708 //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)".
709 //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!).
710 //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.
711
712 //DP_QC_STRINGCOLORFUNCTIONS
713 //idea: Dresk
714 //darkplaces implementation: Dresk
715 //builtin definitions:
716 float(string s) strlennocol = #476; // returns how many characters are in a string, minus color codes
717 string(string s) strdecolorize = #477; // returns a string minus the color codes of the string provided
718 //description:
719 //provides additional functionality to strings by supporting functions that isolate and identify strings with color codes
720
721 //DP_QC_STRING_CASE_FUNCTIONS
722 //idea: Dresk
723 //darkplaces implementation: LordHavoc / Dresk
724 //builtin definitions:
725 string(string s) strtolower = #480; // returns the passed in string in pure lowercase form
726 string(string s) strtoupper = #481; // returns the passed in string in pure uppercase form
727 //description:
728 //provides simple string uppercase and lowercase functions
729
730 //DP_QC_TOKENIZEBYSEPARATOR
731 //idea: Electro, SavageX, LordHavoc
732 //darkplaces implementation: LordHavoc
733 //builtin definitions:
734 float(string s, string separator1, ...) tokenizebyseparator = #479;
735 //description:
736 //this function returns tokens separated by any of the supplied separator strings, example:
737 //numnumbers = tokenizebyseparator("10.2.3.4", ".");
738 //returns 4 and the tokens are "10" "2" "3" "4"
739 //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")
740
741 //DP_QC_TRACEBOX
742 //idea: id Software
743 //darkplaces implementation: id Software
744 //builtin definitions:
745 void(vector v1, vector min, vector max, vector v2, float nomonsters, entity forent) tracebox = #90;
746 //description:
747 //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).
748
749 //DP_QC_TRACETOSS
750 //idea: id Software
751 //darkplaces implementation: id Software
752 //builtin definitions:
753 void(entity ent, entity ignore) tracetoss = #64;
754 //description:
755 //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.
756
757 //DP_QC_TRACE_MOVETYPE_HITMODEL
758 //idea: LordHavoc
759 //darkplaces implementation: LordHavoc
760 //constant definitions:
761 float MOVE_HITMODEL = 4;
762 //description:
763 //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)
764
765 //DP_QC_TRACE_MOVETYPE_WORLDONLY
766 //idea: LordHavoc
767 //darkplaces implementation: LordHavoc
768 //constant definitions:
769 float MOVE_WORLDONLY = 3;
770 //description:
771 //allows traces to hit only world (ignoring all entities, unlike MOVE_NOMONSTERS which hits all bmodels), use as the nomonsters parameter to trace functions
772
773 //DP_QC_UNLIMITEDTEMPSTRINGS
774 //idea: div0
775 //darkplaces implementation: LordHavoc
776 //description:
777 //this extension alters Quake behavior such that instead of reusing a single
778 //tempstring (or multiple) there are an unlimited number of tempstrings, which
779 //are removed only when a QC function invoked by the engine returns,
780 //eliminating almost all imaginable concerns with string handling in QuakeC.
781 //
782 //in short:
783 //you can now use and abuse tempstrings as much as you like, you still have to
784 //use strzone (FRIK_FILE) for permanent storage however.
785 //
786 //
787 //
788 //implementation notes for other engine coders:
789 //these tempstrings are expected to be stored in a contiguous buffer in memory
790 //which may be fixed size or controlled by a cvar, or automatically grown on
791 //demand (in the case of DarkPlaces).
792 //
793 //this concept is similar to quake's Zone system, however these are all freed
794 //when the QC interpreter returns.
795 //
796 //this is basically a poor man's garbage collection system for strings.
797
798 //DP_QC_VECTOANGLES_WITH_ROLL
799 //idea: LordHavoc
800 //darkplaces implementation: LordHavoc
801 //builtin definitions:
802 vector(vector forward, vector up) vectoangles2 = #51; // same number as vectoangles
803 //description:
804 //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)
805 //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
806
807 //DP_QC_VECTORVECTORS
808 //idea: LordHavoc
809 //darkplaces implementation: LordHavoc
810 //builtin definitions:
811 void(vector dir) vectorvectors = #432;
812 //description:
813 //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.
814
815 //DP_QUAKE2_MODEL
816 //idea: quake community
817 //darkplaces implementation: LordHavoc
818 //description:
819 //shows that the engine supports Quake2 .md2 files.
820
821 //DP_QUAKE2_SPRITE
822 //idea: LordHavoc
823 //darkplaces implementation: Elric
824 //description:
825 //shows that the engine supports Quake2 .sp2 files.
826
827 //DP_QUAKE3_MAP
828 //idea: quake community
829 //darkplaces implementation: LordHavoc
830 //description:
831 //shows that the engine supports Quake3 .bsp files.
832
833 //DP_QUAKE3_MODEL
834 //idea: quake community
835 //darkplaces implementation: LordHavoc
836 //description:
837 //shows that the engine supports Quake3 .md3 files.
838
839 //DP_REGISTERCVAR
840 //idea: LordHavoc
841 //darkplaces implementation: LordHavoc
842 //builtin definitions:
843 float(string name, string value) registercvar = #93;
844 //description:
845 //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.
846 //NOTE: DP_CON_SET is much better.
847
848 //DP_SND_DIRECTIONLESSATTNNONE
849 //idea: LordHavoc
850 //darkplaces implementation: LordHavoc
851 //description:
852 //make sounds with ATTN_NONE have no spatialization (enabling easy use as music sources).
853
854 //DP_SND_FAKETRACKS
855 //idea: requested
856 //darkplaces implementation: Elric
857 //description:
858 //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.
859 //Note: also plays .ogg with DP_SND_OGGVORBIS extension.
860
861 //DP_SND_OGGVORBIS
862 //idea: Transfusion
863 //darkplaces implementation: Elric
864 //description:
865 //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).
866
867 //DP_SND_STEREOWAV
868 //idea: LordHavoc
869 //darkplaces implementation: LordHavoc
870 //description:
871 //the engine supports stereo WAV files.  (useful with DP_SND_DIRECTIONLESSATTNNONE for music)
872
873 //DP_SOLIDCORPSE
874 //idea: LordHavoc
875 //darkplaces implementation: LordHavoc
876 //solid definitions:
877 float SOLID_CORPSE = 5;
878 //description:
879 //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.
880
881 //DP_SPRITE32
882 //idea: LordHavoc
883 //darkplaces implementation: LordHavoc
884 //description:
885 //the engine supports .spr32 sprites.
886
887 //DP_SV_BOTCLIENT
888 //idea: LordHavoc
889 //darkplaces implementation: LordHavoc
890 //constants:
891 float CLIENTTYPE_DISCONNECTED = 0;
892 float CLIENTTYPE_REAL = 1;
893 float CLIENTTYPE_BOT = 2;
894 float CLIENTTYPE_NOTACLIENT = 3;
895 //builtin definitions:
896 entity() spawnclient = #454; // like spawn but for client slots (also calls relevant connect/spawn functions), returns world if no clients available
897 float(entity clent) clienttype = #455; // returns one of the CLIENTTYPE_* constants
898 //description:
899 //spawns a client with no network connection, to allow bots to use client slots with no hacks.
900 //How to use:
901 /*
902         // to spawn a bot
903         local entity oldself;
904         oldself = self;
905         self = spawnclient();
906         if (!self)
907         {
908                 bprint("Can not add bot, server full.\n");
909                 self = oldself;
910                 return;
911         }
912         self.netname = "Yoyobot";
913         self.clientcolors = 12 * 16 + 4; // yellow (12) shirt and red (4) pants
914         ClientConnect();
915         PutClientInServer();
916         self = oldself;
917
918         // to remove all bots
919         local entity head;
920         head = find(world, classname, "player");
921         while (head)
922         {
923                 if (clienttype(head) == CLIENTTYPE_BOT)
924                         dropclient(head);
925                 head = find(head, classname, "player");
926         }
927
928         // to identify if a client is a bot (for example in PlayerPreThink)
929         if (clienttype(self) == CLIENTTYPE_BOT)
930                 botthink();
931 */
932 //see also DP_SV_CLIENTCOLORS DP_SV_CLIENTNAME DP_SV_DROPCLIENT
933 //How it works:
934 //creates a new client, calls SetNewParms and stores the parms, and returns the client.
935 //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
936 //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).
937 //parms work the same on bot clients as they do on real clients, and do carry from level to level
938
939 //DP_SV_CLIENTCOLORS
940 //idea: LordHavoc
941 //darkplaces implementation: LordHavoc
942 //field definitions:
943 .float clientcolors; // colors of the client (format: pants + shirt * 16)
944 //description:
945 //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
946
947 //DP_SV_CLIENTNAME
948 //idea: LordHavoc
949 //darkplaces implementation: LordHavoc
950 //description:
951 //allows qc to modify the client's .netname, and automatically sends out any appropriate network updates if changed
952
953 //DP_SV_CUSTOMIZEENTITYFORCLIENT
954 //idea: LordHavoc
955 //darkplaces implementation: [515] and LordHavoc
956 //field definitions:
957 .float() customizeentityforclient; // self = this entity, other = client entity
958 //description:
959 //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
960 //tips on writing customize functions:
961 //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.
962 //you are free to change anything in self, but please do not change any other entities (the results may be very inconsistent).
963 //example ideas for use of this extension:
964 //making icons over teammates' heads which are only visible to teammates.  for exasmple: float() playericon_customizeentityforclient = {return self.owner.team == other.team;};
965 //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;};
966 //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;};
967 //implementation notes:
968 //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).
969
970 //DP_SV_DRAWONLYTOCLIENT
971 //idea: LordHavoc
972 //darkplaces implementation: LordHavoc
973 //field definitions:
974 .entity drawonlytoclient;
975 //description:
976 //the entity is only visible to the specified client.
977
978 //DP_SV_DROPCLIENT
979 //idea: FrikaC
980 //darkplaces implementation: LordHavoc
981 //builtin definitions:
982 void(entity clent) dropclient = #453;
983 //description:
984 //causes the server to immediately drop the client, more reliable than stuffcmd(clent, "disconnect\n"); which could be intentionally ignored by the client engine
985
986 //DP_SV_EFFECT
987 //idea: LordHavoc
988 //darkplaces implementation: LordHavoc
989 //builtin definitions:
990 void(vector org, string modelname, float startframe, float endframe, float framerate) effect = #404;
991 //SVC definitions:
992 //float svc_effect = #52; // [vector] org [byte] modelindex [byte] startframe [byte] framecount [byte] framerate
993 //float svc_effect2 = #53; // [vector] org [short] modelindex [byte] startframe [byte] framecount [byte] framerate
994 //description:
995 //clientside playback of simple custom sprite effects (explosion sprites, etc).
996
997 //DP_SV_ENTITYCONTENTSTRANSITION
998 //idea: Dresk
999 //darkplaces implementation: Dresk
1000 //field definitions:
1001 .void(float nOriginalContents, float nNewContents) contentstransition;
1002 //description:
1003 //This field function, when provided, is triggered on an entity when the contents (ie. liquid / water / etc) is changed.
1004 //The first parameter provides the entities original contents, prior to the transition.  The second parameter provides the new contents.
1005 //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.
1006
1007 //DP_SV_POINTSOUND
1008 //idea: Dresk
1009 //darkplaces implementation: Dresk
1010 //builtin definitions:
1011 void(vector origin, string sample, float volume, float attenuation) pointsound = #483;
1012 //description:
1013 //Similar to the standard QC sound function, this function takes an origin instead of an entity and omits the channel parameter.
1014 // This allows sounds to be played at arbitrary origins without spawning entities.
1015
1016 //DP_SV_ONENTITYNOSPAWNFUNCTION
1017 //idea: Dresk
1018 //darkplaces implementation: Dresk
1019 //engine-called QC prototypes:
1020 //void() SV_OnEntityNoSpawnFunction;
1021 //description:
1022 // This function is called whenever an entity on the server has no spawn function, and therefore has no defined QC behavior.
1023 // You may as such dictate the behavior as to what happens to the entity.
1024 // To mimic the engine's default behavior, simply call remove(self).
1025
1026 //DP_SV_MODELFLAGS_AS_EFFECTS
1027 //idea: LordHavoc, Dresk
1028 //darkplaces implementation: LordHavoc
1029 //field definitions:
1030 .float modelflags;
1031 //constant definitions:
1032 float EF_NOMODELFLAGS = 8388608; // ignore any effects in a model file and substitute your own
1033 float MF_ROCKET  =   1; // leave a trail
1034 float MF_GRENADE =   2; // leave a trail
1035 float MF_GIB     =   4; // leave a trail
1036 float MF_ROTATE  =   8; // rotate (bonus items)
1037 float MF_TRACER  =  16; // green split trail
1038 float MF_ZOMGIB  =  32; // small blood trail
1039 float MF_TRACER2 =  64; // orange split trail
1040 float MF_TRACER3 = 128; // purple trail
1041 //description:
1042 //this extension allows model flags to be specified on entities so you can add a rocket trail and glow to any entity, etc.
1043 //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.
1044 //
1045 //silly example modification #1 to W_FireRocket in weapons.qc:
1046 //missile.effects = EF_NOMODELFLAGS; // rocket without a glow/fire trail
1047 //silly example modification #2 to W_FireRocket in weapons.qc:
1048 //missile.modelflags = MF_GIB; // leave a blood trail instead of glow/fire trail
1049 //
1050 //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.
1051 //
1052 //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.
1053
1054 //DP_SV_NETADDRESS
1055 //idea: Dresk
1056 //darkplaces implementation: Dresk
1057 //field definitions:
1058 .string netaddress;
1059 //description:
1060 // provides the netaddress of the associated entity (ie. 127.0.0.1) and "null/botclient" if the netconnection of the entity is invalid
1061
1062 //DP_SV_NODRAWTOCLIENT
1063 //idea: LordHavoc
1064 //darkplaces implementation: LordHavoc
1065 //field definitions:
1066 .entity nodrawtoclient;
1067 //description:
1068 //the entity is not visible to the specified client.
1069
1070 //DP_SV_PING
1071 //idea: LordHavoc
1072 //darkplaces implementation: LordHavoc
1073 //field definitions:
1074 .float ping;
1075 //description:
1076 //continuously updated field indicating client's ping (based on average of last 16 packet time differences).
1077
1078 //DP_SV_POINTPARTICLES
1079 //idea: Spike
1080 //darkplaces implementation: LordHavoc
1081 //function definitions:
1082 float(string effectname) particleeffectnum = #335; // same as in CSQC
1083 void(entity ent, float effectnum, vector start, vector end) trailparticles = #336; // same as in CSQC
1084 void(float effectnum, vector org, vector vel, float howmany) pointparticles = #337; // same as in CSQC
1085 //description:
1086 //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.
1087 //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.
1088 //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.
1089
1090 //DP_SV_PUNCHVECTOR
1091 //idea: LordHavoc
1092 //darkplaces implementation: LordHavoc
1093 //field definitions:
1094 .vector punchvector;
1095 //description:
1096 //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).
1097
1098 //DP_SV_PLAYERPHYSICS
1099 //idea: LordHavoc
1100 //darkplaces implementation: LordHavoc
1101 //field definitions:
1102 .vector movement;
1103 //cvar definitions:
1104 //"sv_playerphysicsqc" (0/1, default 1, allows user to disable qc player physics)
1105 //engine-called QC prototypes:
1106 //void() SV_PlayerPhysics;
1107 //description:
1108 //.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)
1109
1110 //DP_SV_PRINT
1111 //idea: id Software (QuakeWorld Server)
1112 //darkplaces implementation: Black, LordHavoc
1113 void(string s, ...) print = #339; // same number as in EXT_CSQC
1114 //description:
1115 //this is identical to dprint except that it always prints regardless of the developer cvar.
1116
1117 //DP_SV_PRECACHEANYTIME
1118 //idea: id Software (Quake2)
1119 //darkplaces implementation: LordHavoc
1120 //description:
1121 //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).
1122
1123 //DP_SV_ROTATINGBMODEL
1124 //idea: id Software
1125 //darkplaces implementation: LordHavoc
1126 //description:
1127 //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).
1128 //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)
1129
1130 //DP_SV_SETCOLOR
1131 //idea: LordHavoc
1132 //darkplaces implementation: LordHavoc
1133 //builtin definitions:
1134 void(entity ent, float colors) setcolor = #401;
1135 //engine called QC functions (optional):
1136 //void(float color) SV_ChangeTeam;
1137 //description:
1138 //setcolor sets the color on a client and updates internal color information accordingly (equivilant to stuffing a "color" command but immediate)
1139 //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.
1140 //the color format is pants + shirt * 16 (0-255 potentially)
1141
1142 //DP_SV_SLOWMO
1143 //idea: LordHavoc
1144 //darkplaces implementation: LordHavoc
1145 //cvars:
1146 //"slowmo" (0+, default 1)
1147 //description:
1148 //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.
1149 //range is 0 to infinite, recommended values to try are 0.1 (very slow, 10% speed), 1 (normal speed), 5 (500% speed).
1150
1151 //DP_SV_WRITEUNTERMINATEDSTRING
1152 //idea: FrikaC
1153 //darkplaces implementation: Sajt
1154 //builtin definitions:
1155 void(float to, string s) WriteUnterminatedString = #456;
1156 //description:
1157 //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.
1158 //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.
1159
1160 //DP_TE_BLOOD
1161 //idea: LordHavoc
1162 //darkplaces implementation: LordHavoc
1163 //builtin definitions:
1164 void(vector org, vector velocity, float howmany) te_blood = #405;
1165 //temp entity definitions:
1166 float TE_BLOOD = 50;
1167 //protocol:
1168 //vector origin
1169 //byte xvelocity (-128 to +127)
1170 //byte yvelocity (-128 to +127)
1171 //byte zvelocity (-128 to +127)
1172 //byte count (0 to 255, how much blood)
1173 //description:
1174 //creates a blood effect.
1175
1176 //DP_TE_BLOODSHOWER
1177 //idea: LordHavoc
1178 //darkplaces implementation: LordHavoc
1179 //builtin definitions:
1180 void(vector mincorner, vector maxcorner, float explosionspeed, float howmany) te_bloodshower = #406;
1181 //temp entity definitions:
1182 //float TE_BLOODSHOWER = 52;
1183 //protocol:
1184 //vector mins (minimum corner of the cube)
1185 //vector maxs (maximum corner of the cube)
1186 //coord explosionspeed (velocity of blood particles flying out of the center)
1187 //short count (number of blood particles)
1188 //description:
1189 //creates an exploding shower of blood, for making gibbings more convincing.
1190
1191 //DP_TE_CUSTOMFLASH
1192 //idea: LordHavoc
1193 //darkplaces implementation: LordHavoc
1194 //builtin definitions:
1195 void(vector org, float radius, float lifetime, vector color) te_customflash = #417;
1196 //temp entity definitions:
1197 //float TE_CUSTOMFLASH = 73;
1198 //protocol:
1199 //vector origin
1200 //byte radius ((MSG_ReadByte() + 1) * 8, meaning 8-2048 unit radius)
1201 //byte lifetime ((MSG_ReadByte() + 1) / 256.0, meaning approximately 0-1 second lifetime)
1202 //byte red (0.0 to 1.0 converted to 0-255)
1203 //byte green (0.0 to 1.0 converted to 0-255)
1204 //byte blue (0.0 to 1.0 converted to 0-255)
1205 //description:
1206 //creates a customized light flash.
1207
1208 //DP_TE_EXPLOSIONRGB
1209 //idea: LordHavoc
1210 //darkplaces implementation: LordHavoc
1211 //builtin definitions:
1212 void(vector org, vector color) te_explosionrgb = #407;
1213 //temp entity definitions:
1214 //float TE_EXPLOSIONRGB = 53;
1215 //protocol:
1216 //vector origin
1217 //byte red (0.0 to 1.0 converted to 0 to 255)
1218 //byte green (0.0 to 1.0 converted to 0 to 255)
1219 //byte blue (0.0 to 1.0 converted to 0 to 255)
1220 //description:
1221 //creates a colored explosion effect.
1222
1223 //DP_TE_FLAMEJET
1224 //idea: LordHavoc
1225 //darkplaces implementation: LordHavoc
1226 //builtin definitions:
1227 void(vector org, vector vel, float howmany) te_flamejet = #457;
1228 //temp entity definitions:
1229 //float TE_FLAMEJET = 74;
1230 //protocol:
1231 //vector origin
1232 //vector velocity
1233 //byte count (0 to 255, how many flame particles)
1234 //description:
1235 //creates a single puff of flame particles.  (not very useful really)
1236
1237 //DP_TE_PARTICLECUBE
1238 //idea: LordHavoc
1239 //darkplaces implementation: LordHavoc
1240 //builtin definitions:
1241 void(vector mincorner, vector maxcorner, vector vel, float howmany, float color, float gravityflag, float randomveljitter) te_particlecube = #408;
1242 //temp entity definitions:
1243 //float TE_PARTICLECUBE = 54;
1244 //protocol:
1245 //vector mins (minimum corner of the cube)
1246 //vector maxs (maximum corner of the cube)
1247 //vector velocity
1248 //short count
1249 //byte color (palette color)
1250 //byte gravity (TRUE or FALSE, FIXME should this be a scaler instead?)
1251 //coord randomvel (how much to jitter the velocity)
1252 //description:
1253 //creates a cloud of particles, useful for forcefields but quite customizable.
1254
1255 //DP_TE_PARTICLERAIN
1256 //idea: LordHavoc
1257 //darkplaces implementation: LordHavoc
1258 //builtin definitions:
1259 void(vector mincorner, vector maxcorner, vector vel, float howmany, float color) te_particlerain = #409;
1260 //temp entity definitions:
1261 //float TE_PARTICLERAIN = 55;
1262 //protocol:
1263 //vector mins (minimum corner of the cube)
1264 //vector maxs (maximum corner of the cube)
1265 //vector velocity (velocity of particles)
1266 //short count (number of particles)
1267 //byte color (8bit palette color)
1268 //description:
1269 //creates a shower of rain, the rain will appear either at the top (if falling down) or bottom (if falling up) of the cube.
1270
1271 //DP_TE_PARTICLESNOW
1272 //idea: LordHavoc
1273 //darkplaces implementation: LordHavoc
1274 //builtin definitions:
1275 void(vector mincorner, vector maxcorner, vector vel, float howmany, float color) te_particlesnow = #410;
1276 //temp entity definitions:
1277 //float TE_PARTICLERAIN = 56;
1278 //protocol:
1279 //vector mins (minimum corner of the cube)
1280 //vector maxs (maximum corner of the cube)
1281 //vector velocity (velocity of particles)
1282 //short count (number of particles)
1283 //byte color (8bit palette color)
1284 //description:
1285 //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.
1286
1287 //DP_TE_PLASMABURN
1288 //idea: LordHavoc
1289 //darkplaces implementation: LordHavoc
1290 //builtin definitions:
1291 void(vector org) te_plasmaburn = #433;
1292 //temp entity definitions:
1293 //float TE_PLASMABURN = 75;
1294 //protocol:
1295 //vector origin
1296 //description:
1297 //creates a small light flash (radius 200, time 0.2) and marks the walls.
1298
1299 //DP_TE_QUADEFFECTS1
1300 //idea: LordHavoc
1301 //darkplaces implementation: LordHavoc
1302 //builtin definitions:
1303 void(vector org) te_gunshotquad = #412;
1304 void(vector org) te_spikequad = #413;
1305 void(vector org) te_superspikequad = #414;
1306 void(vector org) te_explosionquad = #415;
1307 //temp entity definitions:
1308 //float   TE_GUNSHOTQUAD  = 57; // [vector] origin
1309 //float   TE_SPIKEQUAD    = 58; // [vector] origin
1310 //float   TE_SUPERSPIKEQUAD = 59; // [vector] origin
1311 //float   TE_EXPLOSIONQUAD = 70; // [vector] origin
1312 //protocol:
1313 //vector origin
1314 //description:
1315 //all of these just take a location, and are equivilant in function (but not appearance :) to the original TE_GUNSHOT, etc.
1316
1317 //DP_TE_SMALLFLASH
1318 //idea: LordHavoc
1319 //darkplaces implementation: LordHavoc
1320 //builtin definitions:
1321 void(vector org) te_smallflash = #416;
1322 //temp entity definitions:
1323 //float TE_SMALLFLASH = 72;
1324 //protocol:
1325 //vector origin
1326 //description:
1327 //creates a small light flash (radius 200, time 0.2).
1328
1329 //DP_TE_SPARK
1330 //idea: LordHavoc
1331 //darkplaces implementation: LordHavoc
1332 //builtin definitions:
1333 void(vector org, vector vel, float howmany) te_spark = #411;
1334 //temp entity definitions:
1335 //float TE_SPARK = 51;
1336 //protocol:
1337 //vector origin
1338 //byte xvelocity (-128 to 127)
1339 //byte yvelocity (-128 to 127)
1340 //byte zvelocity (-128 to 127)
1341 //byte count (number of sparks)
1342 //description:
1343 //creates a shower of sparks and a smoke puff.
1344
1345 //DP_TE_STANDARDEFFECTBUILTINS
1346 //idea: LordHavoc
1347 //darkplaces implementation: LordHavoc
1348 //builtin definitions:
1349 void(vector org) te_gunshot = #418;
1350 void(vector org) te_spike = #419;
1351 void(vector org) te_superspike = #420;
1352 void(vector org) te_explosion = #421;
1353 void(vector org) te_tarexplosion = #422;
1354 void(vector org) te_wizspike = #423;
1355 void(vector org) te_knightspike = #424;
1356 void(vector org) te_lavasplash = #425;
1357 void(vector org) te_teleport = #426;
1358 void(vector org, float color, float colorlength) te_explosion2 = #427;
1359 void(entity own, vector start, vector end) te_lightning1 = #428;
1360 void(entity own, vector start, vector end) te_lightning2 = #429;
1361 void(entity own, vector start, vector end) te_lightning3 = #430;
1362 void(entity own, vector start, vector end) te_beam = #431;
1363 //description:
1364 //to make life easier on mod coders.
1365
1366 //DP_TRACE_HITCONTENTSMASK_SURFACEINFO
1367 //idea: LordHavoc
1368 //darkplaces implementation: LordHavoc
1369 //globals:
1370 .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
1371 float trace_dpstartcontents; // DPCONTENTS_ value at start position of trace
1372 float trace_dphitcontents; // DPCONTENTS_ value of impacted surface (not contents at impact point, just contents of the surface that was hit)
1373 float trace_dphitq3surfaceflags; // Q3SURFACEFLAG_ value of impacted surface
1374 string trace_dphittexturename; // texture name of impacted surface
1375 //constants:
1376 float DPCONTENTS_SOLID = 1; // hit a bmodel, not a bounding box
1377 float DPCONTENTS_WATER = 2;
1378 float DPCONTENTS_SLIME = 4;
1379 float DPCONTENTS_LAVA = 8;
1380 float DPCONTENTS_SKY = 16;
1381 float DPCONTENTS_BODY = 32; // hit a bounding box, not a bmodel
1382 float DPCONTENTS_CORPSE = 64; // hit a SOLID_CORPSE entity
1383 float DPCONTENTS_NODROP = 128; // an area where backpacks should not spawn
1384 float DPCONTENTS_PLAYERCLIP = 256; // blocks player movement
1385 float DPCONTENTS_MONSTERCLIP = 512; // blocks monster movement
1386 float DPCONTENTS_DONOTENTER = 1024; // AI hint brush
1387 float DPCONTENTS_LIQUIDSMASK = 14; // WATER | SLIME | LAVA
1388 float Q3SURFACEFLAG_NODAMAGE = 1;
1389 float Q3SURFACEFLAG_SLICK = 2; // low friction surface
1390 float Q3SURFACEFLAG_SKY = 4; // sky surface (also has NOIMPACT and NOMARKS set)
1391 float Q3SURFACEFLAG_LADDER = 8; // climbable surface
1392 float Q3SURFACEFLAG_NOIMPACT = 16; // projectiles should remove themselves on impact (this is set on sky)
1393 float Q3SURFACEFLAG_NOMARKS = 32; // projectiles should not leave marks, such as decals (this is set on sky)
1394 float Q3SURFACEFLAG_FLESH = 64; // projectiles should do a fleshy effect (blood?) on impact
1395 //float Q3SURFACEFLAG_NODRAW = 128; // compiler hint (not important to qc)
1396 //float Q3SURFACEFLAG_HINT = 256; // compiler hint (not important to qc)
1397 //float Q3SURFACEFLAG_SKIP = 512; // compiler hint (not important to qc)
1398 //float Q3SURFACEFLAG_NOLIGHTMAP = 1024; // compiler hint (not important to qc)
1399 //float Q3SURFACEFLAG_POINTLIGHT = 2048; // compiler hint (not important to qc)
1400 float Q3SURFACEFLAG_METALSTEPS = 4096; // walking on this surface should make metal step sounds
1401 float Q3SURFACEFLAG_NOSTEPS = 8192; // walking on this surface should not make footstep sounds
1402 //float Q3SURFACEFLAG_NONSOLID = 16384; // compiler hint (not important to qc)
1403 //float Q3SURFACEFLAG_LIGHTFILTER = 32768; // compiler hint (not important to qc)
1404 //float Q3SURFACEFLAG_ALPHASHADOW = 65536; // compiler hint (not important to qc)
1405 //float Q3SURFACEFLAG_NODLIGHT = 131072; // compiler hint (not important to qc)
1406 //float Q3SURFACEFLAG_DUST = 262144; // translucent 'light beam' effect (not important to qc)
1407 //description:
1408 //adds additional information after a traceline/tracebox/tracetoss call.
1409 //also (very important) sets trace_* globals before calling .touch functions,
1410 //this allows them to inspect the nature of the collision (for example
1411 //determining if a projectile hit sky), clears trace_* variables for the other
1412 //object in a touch event (that is to say, a projectile moving will see the
1413 //trace results in its .touch function, but the player it hit will see very
1414 //little information in the trace_ variables as it was not moving at the time)
1415
1416 //DP_VIEWZOOM
1417 //idea: LordHavoc
1418 //darkplaces implementation: LordHavoc
1419 //field definitions:
1420 .float viewzoom;
1421 //description:
1422 //scales fov and sensitivity of player, valid range is 0 to 1 (intended for sniper rifle zooming, and such)
1423
1424 //EXT_BITSHIFT
1425 //idea: Spike
1426 //darkplaces implementation: [515]
1427 //builtin definitions:
1428 float(float number, float quantity) bitshift = #218;
1429 //description:
1430 //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).
1431 //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.
1432
1433 //FRIK_FILE
1434 //idea: FrikaC
1435 //darkplaces implementation: LordHavoc
1436 //builtin definitions:
1437 float(string s) stof = #81; // get numerical value from a string
1438 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
1439 void(float fhandle) fclose = #111; // closes a file
1440 string(float fhandle) fgets = #112; // reads a line of text from the file and returns as a tempstring
1441 void(float fhandle, string s, ...) fputs = #113; // writes a line of text to the end of the file
1442 float(string s) strlen = #114; // returns how many characters are in a string
1443 string(string s1, string s2, ...) strcat = #115; // concatenates two or more strings (for example "abc", "def" would return "abcdef") and returns as a tempstring
1444 string(string s, float start, float length) substring = #116; // returns a section of a string as a tempstring
1445 vector(string s) stov = #117; // returns vector value from a string
1446 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)
1447 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!!!)
1448 //constants:
1449 float FILE_READ = 0;
1450 float FILE_APPEND = 1;
1451 float FILE_WRITE = 2;
1452 //cvars:
1453 //pr_zone_min_strings : default 64 (64k), min 64 (64k), max 8192 (8mb)
1454 //description:
1455 //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.
1456 //
1457 //NOTE: strzone functionality is partially superseded by
1458 //DP_QC_UNLIMITEDTEMPSTRINGS when longterm storage is not needed
1459
1460 //KRIMZON_SV_PARSECLIENTCOMMAND
1461 //idea: KrimZon
1462 //darkplaces implementation: KrimZon, LordHavoc
1463 //engine-called QC prototypes:
1464 //void(string s) SV_ParseClientCommand;
1465 //builtin definitions:
1466 void(entity e, string s) clientcommand = #440;
1467 float(string s) tokenize = #441;
1468 string(float n) argv = #442;
1469 //description:
1470 //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
1471
1472 //NEH_CMD_PLAY2
1473 //idea: Nehahra
1474 //darkplaces implementation: LordHavoc
1475 //description:
1476 //shows that the engine supports the "play2" console command (plays a sound without spatialization).
1477
1478 //NEH_RESTOREGAME
1479 //idea: Nehahra
1480 //darkplaces implementation: LordHavoc
1481 //engine-called QC prototypes:
1482 //void() RestoreGame;
1483 //description:
1484 //when a savegame is loaded, this function is called
1485
1486 //NEXUIZ_PLAYERMODEL
1487 //idea: Nexuiz
1488 //darkplaces implementation: Black
1489 //console commands:
1490 //playermodel <name> - FIXME: EXAMPLE NEEDED
1491 //playerskin <name> - FIXME: EXAMPLE NEEDED
1492 //field definitions:
1493 .string playermodel; // name of player model sent by client
1494 .string playerskin; // name of player skin sent by client
1495 //description:
1496 //these client properties are used by Nexuiz.
1497
1498 //NXQ_GFX_LETTERBOX
1499 //idea: nxQuake
1500 //darkplaces implementation: LordHavoc
1501 //description:
1502 //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
1503
1504 //PRYDON_CLIENTCURSOR
1505 //idea: FrikaC
1506 //darkplaces implementation: LordHavoc
1507 //effects bit:
1508 float EF_SELECTABLE = 16384; // allows cursor to highlight entity (brighten)
1509 //field definitions:
1510 .float cursor_active; // true if cl_prydoncursor mode is on
1511 .vector cursor_screen; // screen position of cursor as -1 to +1 in _x and _y (_z unused)
1512 .vector cursor_trace_start; // position of camera
1513 .vector cursor_trace_endpos; // position of cursor in world (as traced from camera)
1514 .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)
1515 //cvar definitions:
1516 //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)
1517 //description:
1518 //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.
1519 //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.
1520 //the clientside trace skips transparent entities (except those marked EF_SELECTABLE).
1521 //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).
1522 //intended to be used by Prydon Gate.
1523
1524 //TENEBRAE_GFX_DLIGHTS
1525 //idea: Tenebrae
1526 //darkplaces implementation: LordHavoc
1527 //fields:
1528 .float light_lev; // radius (does not affect brightness), typical value 350
1529 .vector color; // color (does not affect radius), typical value '1 1 1' (bright white), can be up to '255 255 255' (nuclear blast)
1530 .float style; // light style (like normal light entities, flickering torches or switchable, etc)
1531 .float pflags; // flags (see PFLAGS_ constants)
1532 .vector angles; // orientation of the light
1533 .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
1534 //constants:
1535 float PFLAGS_NOSHADOW = 1; // light does not cast shadows
1536 float PFLAGS_CORONA = 2; // light has a corona flare
1537 float PFLAGS_FULLDYNAMIC = 128; // light enable (without this set no light is produced!)
1538 //description:
1539 //more powerful dynamic light settings
1540 //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)
1541 //changes compared to tenebrae (because they're too 'leet' for standards):
1542 //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)
1543 //EF_FULLDYNAMIC effects flag replaced by PFLAGS_FULLDYNAMIC flag (EF_FULLDYNAMIC conflicts with EF_NODRAW)
1544
1545 //TW_SV_STEPCONTROL
1546 //idea: Transfusion
1547 //darkplaces implementation: LordHavoc
1548 //cvars:
1549 //sv_jumpstep (0/1, default 1)
1550 //sv_stepheight (default 18)
1551 //description:
1552 //sv_jumpstep allows stepping up onto stairs while airborn, sv_stepheight controls how high a single step can be.
1553
1554 //FTE_STRINGS
1555 //idea: many
1556 //darkplaces implementation: KrimZon
1557 //description:
1558 //various string manipulation functions
1559 float(string str, string sub, float startpos) strstrofs = #221;
1560 float(string str, float ofs) str2chr = #222;
1561 string(float c, ...) chr2str = #223;
1562 string(float ccase, float calpha, float cnum, string s, ...) strconv = #224;
1563 string(float chars, string s, ...) strpad = #225;
1564 string(string info, string key, string value, ...) infoadd = #226;
1565 string(string info, string key) infoget = #227;
1566 float(string s1, string s2, float len) strncmp = #228;
1567 float(string s1, string s2) strcasecmp = #229;
1568 float(string s1, string s2, float len) strncasecmp = #230;
1569
1570 //DP_CON_BESTWEAPON
1571 //idea: many
1572 //darkplaces implementation: div0
1573 //description:
1574 //allows QC to register weapon properties for use by the bestweapon command, for mods that change required ammo count or type for the weapons
1575 //it is done using console commands sent via stuffcmd:
1576 //  register_bestweapon quake
1577 //  register_bestweapon clear
1578 //  register_bestweapon <shortname> <impulse> <itemcode> <activeweaponcode> <ammostat> <ammomin>
1579 //for example, this is what Quake uses:
1580 //  register_bestweapon 1 1 4096 4096 6 0 // STAT_SHELLS is 6
1581 //  register_bestweapon 2 2    1    1 6 1
1582 //  register_bestweapon 3 3    2    2 6 1
1583 //  register_bestweapon 4 4    4    4 7 1 // STAT_NAILS is 7
1584 //  register_bestweapon 5 5    8    8 7 1
1585 //  register_bestweapon 6 6   16   16 8 1 // STAT_ROCKETS is 8
1586 //  register_bestweapon 7 7   32   32 8 1
1587 //  register_bestweapon 8 8   64   64 9 1 // STAT_CELLS is 9
1588 //after each map client initialization, this is reset back to Quake settings. So you should send these data in ClientConnect.
1589 //also, this extension introduces a new "cycleweapon" command to the user.
1590
1591 //DP_QC_STRINGBUFFERS
1592 //idea: ??
1593 //darkplaces implementation: LordHavoc
1594 //functions to manage string buffer objects - that is, arbitrary length string arrays that are handled by the engine
1595 float() buf_create = #460;
1596 void(float bufhandle) buf_del = #461;
1597 float(float bufhandle) buf_getsize = #462;
1598 void(float bufhandle_from, float bufhandle_to) buf_copy = #463;
1599 void(float bufhandle, float sortpower, float backward) buf_sort = #464;
1600 string(float bufhandle, string glue) buf_implode = #465;
1601 string(float bufhandle, float string_index) bufstr_get = #466;
1602 void(float bufhandle, float string_index, string str) bufstr_set = #467;
1603 float(float bufhandle, string str, float order) bufstr_add = #468;
1604 void(float bufhandle, float string_index) bufstr_free = #469;
1605
1606 //DP_QC_STRREPLACE
1607 //idea: Sajt
1608 //darkplaces implementation: Sajt
1609 //builtin definitions:
1610 string(string search, string replace, string subject) strreplace = #484;
1611 string(string search, string replace, string subject) strireplace = #485;
1612 //description:
1613 //strreplace replaces all occurrences of 'search' with 'replace' in the string 'subject', and returns the result as a tempstring.
1614 //strireplace does the same but uses case-insensitive matching of the 'search' term
1615 //
1616 //DP_QC_CRC16
1617 //idea: div0
1618 //darkplaces implementation: div0
1619 //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.
1620 //When caseinsensitive is set, the CRC is calculated of the lower cased string.
1621 float(float caseinsensitive, string s, ...) crc16 = #494;
1622
1623 //DP_SV_SHUTDOWN
1624 //idea: div0
1625 //darkplaces implementation: div0
1626 //A function that gets called just before progs exit. To save persistent data from.
1627 //It is not called on a crash or error.
1628 //void SV_Shutdown();