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