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