]> icculus.org git repositories - divverent/nexuiz.git/blob - qcsrc/gamec/extensions.h
rewrote maplist handling to use g_maplist cvar (note: no support for multiple instanc...
[divverent/nexuiz.git] / qcsrc / gamec / extensions.h
1
2 //DarkPlaces supported extension list, draft version 1.04
3
4 //checkextension function
5 //idea: expected by almost everyone
6 //darkplaces implementation: LordHavoc
7 float(string s) checkextension = #99;
8 //description:
9 //check if (cvar("pr_checkextension")) before calling this, this is the only
10 //guarenteed extension to be present in the extension system, it allows you
11 //to check if an extension is available, by name, to check for an extension
12 //use code like this:
13 //// (it is recommended this code be placed in worldspawn or a worldspawn called function somewhere)
14 //if (cvar("pr_checkextension"))
15 //if (checkextension("DP_SV_SETCOLOR"))
16 //      ext_setcolor = TRUE;
17 //from then on you can check ext_setcolor to know if that extension is available
18
19 //DP_QC_CVAR_STRING
20 //idea: Paul Timofeyev
21 //DarkPlaces implementation: Paul Timofeyev, LordHavoc
22 //builtin definitions:
23 string(string s) cvar_string = #448;
24 //description:
25 //returns the value of a cvar, as a tempstring.
26
27 //DP_QC_TRACE_MOVETYPES
28 //idea: LordHavoc
29 //darkplaces implementation: id Software
30 //constant definitions:
31 float MOVE_NORMAL = 0; // same as FALSE
32 float MOVE_NOMONSTERS = 1; // same as TRUE
33 float MOVE_MISSILE = 2; // save as movement with .movetype == MOVETYPE_FLYMISSILE
34 //description:
35 //this extension does nothing (do not check for it), it only documents existing MOVE_ values that were never defined in defs.qc, these are passed as the 'nomonsters' parameter to traceline/tracebox
36
37 //DP_QC_TRACE_MOVETYPE_WORLDONLY
38 //idea: LordHavoc
39 //darkplaces implementation: LordHavoc
40 //constant definitions:
41 float MOVE_WORLDONLY = 3;
42 //description:
43 //allows traces to hit only world (see DP_QC_TRACE_MOVETYPES for how to use this)
44
45 //DP_QC_TRACE_MOVETYPE_HITMODEL
46 //idea: LordHavoc
47 //darkplaces implementation: LordHavoc
48 //constant definitions:
49 float MOVE_HITMODEL = 4;
50 //description:
51 //allows traces to hit alias models (not sprites!) instead of entity boxes (see DP_QC_TRACE_MOVETYPES for how to use this)
52
53 // LordHavoc: HIGHLY experimental, do not implement this in other engines
54 //DP_CGAME
55 //idea: LordHavoc
56 //darkplaces implementation: LordHavoc
57 //SVC definitions:
58 float svc_cgame = 50; // [short] length [bytes] data
59 //description:
60 //contains network messages to client gamecode.
61
62 //DP_CL_LOADSKY
63 //idea: Nehahra, LordHavoc
64 //darkplaces implementation: LordHavoc
65 //client console commands:
66 //"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)
67 //description:
68 //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).
69
70 //DP_EF_ADDITIVE
71 //idea: LordHavoc
72 //darkplaces implementation: LordHavoc
73 //effects bit:
74 float   EF_ADDITIVE     = 32;
75 //description:
76 //additive blending when this object is rendered
77
78 //DP_EF_BLUE
79 //idea: id Software
80 //darkplaces implementation: LordHavoc
81 //effects bit:
82 float   EF_BLUE         = 64;
83 //description:
84 //entity emits blue light (used for quad)
85
86 //DP_EF_FLAME
87 //idea: LordHavoc
88 //darkplaces implementation: LordHavoc
89 //effects bit:
90 float   EF_FLAME        = 1024;
91 //description:
92 //entity is on fire
93
94 //DP_EF_FULLBRIGHT
95 //idea: LordHavoc
96 //darkplaces implementation: LordHavoc
97 //effects bit:
98 float   EF_FULLBRIGHT   = 512;
99 //description:
100 //entity is always brightly lit
101
102 //DP_EF_NODRAW
103 //idea: id Software
104 //darkplaces implementation: LordHavoc
105 //effects bit:
106 float   EF_NODRAW       = 16;
107 //description:
108 //prevents server from sending entity to client (forced invisible, even if it would have been a light source or other such things)
109
110 //DP_EF_RED
111 //idea: id Software
112 //darkplaces implementation: LordHavoc
113 //effects bit:
114 float   EF_RED          = 128;
115 //description:
116 //entity emits red light (used for invulnerability)
117
118 //DP_EF_STARDUST
119 //idea: MythWorks Inc
120 //darkplaces implementation: LordHavoc
121 //effects bit:
122 float   EF_STARDUST     = 2048;
123 //description:
124 //entity emits bouncing sparkles in every direction
125
126 //entity attributes used for rendering/networking:
127 //idea: Nehahra
128 //darkplaces implementation: LordHavoc
129 //DP_ENT_ALPHA
130 //field definition:
131 .float alpha;
132 //description:
133 //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).
134
135 //DP_ENT_COLORMOD
136 //idea: LordHavoc
137 //darkplaces implementation: LordHavoc
138 //field definition:
139 .vector colormod;
140 //description:
141 //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).
142
143 //DP_ENT_CUSTOMCOLORMAP
144 //idea: LordHavoc
145 //darkplaces implementation: LordHavoc
146 //description:
147 //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.
148
149 /*
150 //NOTE: no longer supported by darkplaces because all entities are delta compressed now
151 //DP_ENT_DELTACOMPRESS // no longer supported
152 //idea: LordHavoc
153 //darkplaces implementation: LordHavoc
154 //effects bit:
155 float EF_DELTA = 8388608;
156 //description:
157 //(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).
158 */
159
160 //DP_ENT_EXTERIORMODELTOCLIENT
161 //idea: LordHavoc
162 //darkplaces implementation: LordHavoc
163 //fields:
164 .entity exteriormodeltoclient;
165 //description:
166 //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.
167
168 //DP_ENT_GLOW
169 //idea: LordHavoc
170 //darkplaces implementation: LordHavoc
171 //field definitions:
172 .float glow_color;
173 .float glow_size;
174 .float glow_trail;
175 //description:
176 //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.
177
178 //DP_ENT_LOWPRECISION
179 //idea: LordHavoc
180 //darkplaces implementation: LordHavoc
181 //effects bit:
182 float EF_LOWPRECISION = 4194304;
183 //description:
184 //uses low quality origin coordinates, reducing network traffic compared to the default high precision, intended for numerous objects (projectiles/gibs/bullet holes/etc).
185
186 //DP_ENT_SCALE
187 //idea: LordHavoc
188 //darkplaces implementation: LordHavoc
189 //field definitions:
190 .float scale;
191 //description:
192 //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.
193
194 //DP_ENT_VIEWMODEL
195 //idea: LordHavoc
196 //darkplaces implementation: LordHavoc
197 //field definitions:
198 .entity viewmodelforclient;
199 //description:
200 //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.
201
202 //DP_GFX_FOG
203 //idea: LordHavoc
204 //darkplaces implementation: LordHavoc
205 //worldspawn fields:
206 //"fog" (parameters: "density red green blue", example: "0.1 0.3 0.3 0.3")
207 //description:
208 //global fog for the map, can not be changed by QC
209
210 //DP_GFX_SKYBOX
211 //idea: LordHavoc
212 //darkplaces implementation: LordHavoc
213 //worldspawn fields:
214 //"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)
215 //description:
216 //global skybox for the map, can not be changed by QC
217
218 //DP_GFX_EXTERNALTEXTURES
219 //idea: LordHavoc
220 //darkplaces implementation: LordHavoc
221 //description:
222 //loads external textures found in various directories (tenebrae compatible)...
223 /*
224 in all examples .tga is merely the base texture, it can be any of these:
225 .tga (base texture)
226 _glow.tga (fullbrights or other glowing overlay stuff, NOTE: this is done using additive blend, not alpha)
227 _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)
228 _shirt.tga (same idea as pants, but for shirt color)
229 _diffuse.tga (this may be used instead of base texture for per pixel lighting)
230 _gloss.tga (specular texture for per pixel lighting, note this can be in color (tenebrae only supports greyscale))
231 _norm.tga (normalmap texture for per pixel lighting)
232 _bump.tga (bumpmap, converted to normalmap at load time, supported only for reasons of tenebrae compatibility)
233 _luma.tga (same as _glow but supported only for reasons of tenebrae compatibility)
234
235 due to glquake's incomplete Targa(r) loader, this section describes
236 required Targa(r) features support:
237 types:
238 type 1 (uncompressed 8bit paletted with 24bit/32bit palette)
239 type 2 (uncompressed 24bit/32bit true color, glquake supported this)
240 type 3 (uncompressed 8bit greyscale)
241 type 9 (RLE compressed 8bit paletted with 24bit/32bit palette)
242 type 10 (RLE compressed 24bit/32bit true color, glquake supported this)
243 type 11 (RLE compressed 8bit greyscale)
244 attribute bit 0x20 (Origin At Top Left, top to bottom, left to right)
245
246 image formats guarenteed to be supported: tga, pcx, lmp
247 image formats that are optional: png, jpg
248
249 mdl/spr/spr32 examples:
250 skins are named _A (A being a number) and skingroups are named like _A_B
251 these act as suffixes on the model name...
252 example names for skin _2_1 of model "progs/armor.mdl":
253 game/override/progs/armor.mdl_2_1.tga
254 game/textures/progs/armor.mdl_2_1.tga
255 game/progs/armor.mdl_2_1.tga
256 example names for skin _0 of the model "progs/armor.mdl":
257 game/override/progs/armor.mdl_0.tga
258 game/textures/progs/armor.mdl_0.tga
259 game/progs/armor.mdl_0.tga
260 note that there can be more skins files (of the _0 naming) than the mdl
261 contains, this is only useful to save space in the .mdl file if classic quake
262 compatibility is not a concern.
263
264 bsp/md2/md3 examples:
265 example names for the texture "quake" of model "maps/start.bsp":
266 game/override/quake.tga
267 game/textures/quake.tga
268 game/progs/quake.tga
269
270 sbar/menu/console textures: for example the texture "conchars" (console font) in gfx.wad
271 game/override/gfx/conchars.tga
272 game/textures/gfx/conchars.tga
273 game/gfx/conchars.tga
274 */
275
276 //DP_GFX_QUAKE3MODELTAGS
277 //idea: id Software
278 //darkplaces implementation: LordHavoc
279 //field definitions:
280 .entity tag_entity; // entity this is attached to (call setattachment to set this)
281 .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)
282 //builtin definitions:
283 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)
284 //description:
285 //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).
286 //note 2: if the tag is not found, it defaults to "" (attach to origin/angles of entity)
287 //note 3: attaching to world turns off attachment
288 //note 4: the entity that this is attached to must be visible for this to work
289
290 //DP_GFX_SKINFILES
291 //idea: LordHavoc
292 //darkplaces implementation: LordHavoc
293 //description:
294 //alias models (mdl, md2, md3) can have .skin files to replace conventional texture naming, these have a naming format such as:
295 //progs/test.md3_0.skin
296 //progs/test.md3_1.skin
297 //...
298 //
299 //these files contain replace commands (replace meshname shadername), example:
300 //replace "helmet" "progs/test/helmet1.tga" // this is a mesh shader replacement
301 //replace "teamstripes" "progs/test/redstripes.tga"
302 //replace "visor" "common/nodraw" // this makes the visor mesh invisible
303 ////it is not possible to rename tags using this format
304 //
305 //Or the Quake3 syntax (100% compatible with Quake3's .skin files):
306 //helmet,progs/test/helmet1.tga // this is a mesh shader replacement
307 //teamstripes,progs/test/redstripes.tga
308 //visor,common/nodraw // this makes the visor mesh invisible
309 //tag_camera, // this defines that the first tag in the model is called tag_camera
310 //tag_test, // this defines that the second tag in the model is called tag_test
311 //
312 //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.
313 //this feature is intended to allow multiple skin sets on md3 models (which otherwise only have one skin set).
314 //other commands might be added someday but it is not expected.
315
316 //DP_HALFLIFE_MAP
317 //idea: LordHavoc
318 //darkplaces implementation: LordHavoc
319 //description:
320 //simply indicates that the engine supports HalfLife maps (BSP version 30, NOT the QER RGBA ones which are also version 30).
321
322 //DP_HALFLIFE_MAP_CVAR
323 //idea: LordHavoc
324 //darkplaces implementation: LordHavoc
325 //cvars:
326 //halflifebsp 0/1
327 //description:
328 //engine sets this cvar when loading a map to indicate if it is halflife format or not.
329
330 //DP_INPUTBUTTONS
331 //idea: LordHavoc
332 //darkplaces implementation: LordHavoc
333 //field definitions:
334 .float button3;
335 .float button4;
336 .float button5;
337 .float button6;
338 .float button7;
339 .float button8;
340 //description:
341 //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).
342
343 //DP_MONSTERWALK
344 //idea: LordHavoc
345 //darkplaces implementation: LordHavoc
346 //description:
347 //MOVETYPE_WALK is permitted on non-clients, so bots can move smoothly, run off ledges, etc, just like a real player.
348
349 //DP_MOVETYPEBOUNCEMISSILE
350 //idea: id Software
351 //darkplaces implementation: id Software
352 //movetype definitions:
353 float MOVETYPE_BOUNCEMISSILE = 11;
354 //description:
355 //MOVETYPE_BOUNCE but without gravity, and with full reflection (no speed loss like grenades have), in other words - bouncing laser bolts.
356
357 //DP_MOVETYPEFOLLOW
358 //idea: id Software, LordHavoc (redesigned)
359 //darkplaces implementation: LordHavoc
360 //movetype definitions:
361 float MOVETYPE_FOLLOW = 12;
362 //description:
363 //MOVETYPE_FOLLOW implemented, this uses existing entity fields in unusual ways:
364 //aiment - the entity this is attached to.
365 //punchangle - the original angles when the follow began.
366 //view_ofs - the relative origin (note that this is un-rotated by punchangle, and that is actually the only purpose of punchangle).
367 //v_angle - the relative angles.
368 //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:
369 //hole.movetype = MOVETYPE_FOLLOW; // make the hole follow
370 //hole.solid = SOLID_NOT; // MOVETYPE_FOLLOW is always non-solid
371 //hole.aiment = bmodel; // make the hole follow bmodel
372 //hole.punchangle = bmodel.angles; // the original angles of bmodel
373 //hole.view_ofs = hole.origin - bmodel.origin; // relative origin
374 //hole.v_angle = hole.angles - bmodel.angles; // relative angles
375
376 //DP_QC_CHANGEPITCH
377 //idea: id Software
378 //darkplaces implementation: id Software
379 //field definitions:
380 .float idealpitch;
381 .float pitch_speed;
382 //builtin definitions:
383 void(entity ent) changepitch = #63;
384 //description:
385 //equivilant to changeyaw, ent is normally self. (this was a Q2 builtin)
386
387 //DP_QC_COPYENTITY
388 //idea: LordHavoc
389 //darkplaces implementation: LordHavoc
390 //builtin definitions:
391 void(entity from, entity to) copyentity = #400;
392 //description:
393 //copies all data in the entity to another entity.
394
395 //DP_QC_ETOS
396 //idea: id Software
397 //darkplaces implementation: id Software
398 //builtin definitions:
399 string(entity ent) etos = #65;
400 //description:
401 //lists all of the entity's fields into a string (similar to edict command in console). (this was a Q2 builtin)
402
403 //DP_QC_FINDCHAIN
404 //idea: LordHavoc
405 //darkplaces implementation: LordHavoc
406 //builtin definitions:
407 entity(.string fld, string match) findchain = #402;
408 //description:
409 //similar to find() but returns a chain of entities like findradius.
410
411 //DP_QC_FINDCHAINFLOAT
412 //idea: LordHavoc
413 //darkplaces implementation: LordHavoc
414 //builtin definitions:
415 entity(.entity fld, entity match) findchainentity = #403;
416 entity(.float fld, float match) findchainfloat = #403;
417 //description:
418 //similar to findentity()/findfloat() but returns a chain of entities like findradius.
419
420 //DP_QC_FINDFLOAT
421 //idea: LordHavoc
422 //darkplaces implementation: LordHavoc
423 //builtin definitions:
424 entity(entity start, .entity fld, entity match) findentity = #98;
425 entity(entity start, .float fld, float match) findfloat = #98;
426 //description:
427 //finds an entity or float field value, similar to find(), but for entity and float fields.
428
429 //DP_QC_GETLIGHT
430 //idea: LordHavoc
431 //darkplaces implementation: LordHavoc
432 //builtin definitions:
433 vector(vector org) getlight = #92;
434 //description:
435 //returns the lighting at the requested location (in color), 0-255 range (can exceed 255).
436
437 //DP_QC_GETSURFACE
438 //idea: LordHavoc
439 //darkplaces implementation: LordHavoc
440 //builtin definitions:
441 float(entity e, float s) getsurfacenumpoints = #434;
442 vector(entity e, float s, float n) getsurfacepoint = #435;
443 vector(entity e, float s) getsurfacenormal = #436;
444 string(entity e, float s) getsurfacetexture = #437;
445 float(entity e, vector p) getsurfacenearpoint = #438;
446 vector(entity e, float s, vector p) getsurfaceclippedpoint = #439;
447 //description:
448 //functions to query surface information.
449
450 //DP_QC_MINMAXBOUND
451 //idea: LordHavoc
452 //darkplaces implementation: LordHavoc
453 //builtin definitions:
454 float(float a, float b) min = #94;
455 float(float a, float b, float c) min3 = #94;
456 float(float a, float b, float c, float d) min4 = #94;
457 float(float a, float b, float c, float d, float e) min5 = #94;
458 float(float a, float b, float c, float d, float e, float f) min6 = #94;
459 float(float a, float b, float c, float d, float e, float f, float g) min7 = #94;
460 float(float a, float b, float c, float d, float e, float f, float g, float h) min8 = #94;
461 float(float a, float b) max = #95;
462 float(float a, float b, float c) max3 = #95;
463 float(float a, float b, float c, float d) max4 = #95;
464 float(float a, float b, float c, float d, float e) max5 = #95;
465 float(float a, float b, float c, float d, float e, float f) max6 = #95;
466 float(float a, float b, float c, float d, float e, float f, float g) max7 = #95;
467 float(float a, float b, float c, float d, float e, float f, float g, float h) max8 = #95;
468 float(float minimum, float val, float maximum) bound = #96;
469 //description:
470 //min returns the lowest of all the supplied numbers.
471 //max returns the highest of all the supplied numbers.
472 //bound clamps the value to the range and returns it.
473
474 //DP_QC_RANDOMVEC
475 //idea: LordHavoc
476 //darkplaces implementation: LordHavoc
477 //builtin definitions:
478 vector() randomvec = #91;
479 //description:
480 //returns a vector of length < 1, much quicker version of this QC: do {v_x = random();v_y = random();v_z = random();} while(vlen(v) > 1)
481
482 //DP_QC_SINCOSSQRTPOW
483 //idea: id Software, LordHavoc
484 //darkplaces implementation: id Software, LordHavoc
485 //builtin definitions:
486 float(float val) sin = #60;
487 float(float val) cos = #61;
488 float(float val) sqrt = #62;
489 float(float a, float b) pow = #97;
490 //description:
491 //useful math functions, sine of val, cosine of val, square root of val, and raise a to power b, respectively.
492
493 //DP_QC_TRACEBOX
494 //idea: id Software
495 //darkplaces implementation: id Software
496 //builtin definitions:
497 void(vector v1, vector min, vector max, vector v2, float nomonsters, entity forent) tracebox = #90;
498 //description:
499 //similar to traceline but much more useful, traces a box of the size specified (technical note: currently the hull size can only be one of the sizes used in the map for bmodel collisions, entity collisions will pay attention to the exact size specified however, this is a collision code limitation in quake itself, and will be fixed eventually).
500
501 //DP_QC_TRACETOSS
502 //idea: id Software
503 //darkplaces implementation: id Software
504 //builtin definitions:
505 void(entity ent, entity ignore) tracetoss = #64;
506 //description:
507 //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.
508
509 //DP_QC_VECTORVECTORS
510 //idea: LordHavoc
511 //darkplaces implementation: LordHavoc
512 //builtin definitions:
513 void(vector dir) vectorvectors = #432;
514 //description:
515 //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.
516
517 //DP_QUAKE2_MODEL
518 //idea: quake community
519 //darkplaces implementation: LordHavoc
520 //description:
521 //shows that the engine supports Quake2 .md2 files.
522
523 //DP_QUAKE3_MODEL
524 //idea: quake community
525 //darkplaces implementation: LordHavoc
526 //description:
527 //shows that the engine supports Quake3 .md3 files.
528
529 //DP_REGISTERCVAR
530 //idea: LordHavoc
531 //darkplaces implementation: LordHavoc
532 //builtin definitions:
533 float(string name, string value) registercvar = #93;
534 //description:
535 //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.
536
537 //DP_SOLIDCORPSE
538 //idea: LordHavoc
539 //darkplaces implementation: LordHavoc
540 //solid definitions:
541 float SOLID_CORPSE = 5;
542 //description:
543 //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.
544
545 //DP_SPRITE32
546 //idea: LordHavoc
547 //darkplaces implementation: LordHavoc
548 //description:
549 //the engine supports .spr32 sprites.
550
551 //DP_SV_CLIENTCOLORS
552 //idea: LordHavoc
553 //darkplaces implementation: LordHavoc
554 .float clientcolors; // colors of the client (format: pants + shirt * 16)
555 //description:
556 //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
557
558 //DP_SV_CLIENTNAME
559 //idea: LordHavoc
560 //darkplaces implementation: LordHavoc
561 //allows qc to modify the client's .netname, and automatically sends out any appropriate network updates if changed
562
563 //DP_SV_DRAWONLYTOCLIENT
564 //idea: LordHavoc
565 //darkplaces implementation: LordHavoc
566 //field definitions:
567 .entity drawonlytoclient;
568 //description:
569 //the entity is only visible to the specified client.
570
571 //DP_SV_EFFECT
572 //idea: LordHavoc
573 //darkplaces implementation: LordHavoc
574 //builtin definitions:
575 void(vector org, string modelname, float startframe, float endframe, float framerate) effect = #404;
576 //SVC definitions:
577 //float svc_effect = #52; // [vector] org [byte] modelindex [byte] startframe [byte] framecount [byte] framerate
578 //float svc_effect2 = #53; // [vector] org [short] modelindex [byte] startframe [byte] framecount [byte] framerate
579 //description:
580 //clientside playback of simple custom sprite effects (explosion sprites, etc).
581
582 //DP_SV_NODRAWTOCLIENT
583 //idea: LordHavoc
584 //darkplaces implementation: LordHavoc
585 //field definitions:
586 .entity nodrawtoclient;
587 //description:
588 //the entity is not visible to the specified client.
589
590 //DP_SV_PLAYERPHYSICS
591 //idea: LordHavoc
592 //darkplaces implementation: LordHavoc
593 //field definitions:
594 .vector movement;
595 //engine-called QC prototypes:
596 //void() SV_PlayerPhysics;
597 //description:
598 //.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)
599
600 //DP_SV_SETCOLOR
601 //idea: LordHavoc
602 //darkplaces implementation: LordHavoc
603 //builtin definitions:
604 void(entity ent, float colors) setcolor = #401;
605 //engine called QC functions (optional):
606 //void(float color) SV_ChangeTeam;
607 //description:
608 //setcolor sets the color on a client and updates internal color information accordingly (equivilant to stuffing a "color" command but immediate)
609 //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.
610 //the color format is pants + shirt * 16 (0-255 potentially)
611
612 //DP_SV_SLOWMO
613 //idea: LordHavoc
614 //darkplaces implementation: LordHavoc
615 //cvars:
616 //"slowmo" (0+, default 1)
617 //description:
618 //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.
619 //range is 0 to infinite, recommended values to try are 0.1 (very slow, 10% speed), 1 (normal speed), 5 (500% speed).
620
621 //DP_TE_BLOOD
622 //idea: LordHavoc
623 //darkplaces implementation: LordHavoc
624 //builtin definitions:
625 void(vector org, vector velocity, float howmany) te_blood = #405;
626 //temp entity definitions:
627 float TE_BLOOD = 50;
628 //protocol:
629 //vector origin
630 //byte xvelocity (-128 to +127)
631 //byte yvelocity (-128 to +127)
632 //byte zvelocity (-128 to +127)
633 //byte count (0 to 255, how much blood)
634 //description:
635 //creates a blood effect.
636
637 //DP_TE_BLOODSHOWER
638 //idea: LordHavoc
639 //darkplaces implementation: LordHavoc
640 //builtin definitions:
641 void(vector mincorner, vector maxcorner, float explosionspeed, float howmany) te_bloodshower = #406;
642 //temp entity definitions:
643 //float TE_BLOODSHOWER = 52;
644 //protocol:
645 //vector mins (minimum corner of the cube)
646 //vector maxs (maximum corner of the cube)
647 //coord explosionspeed (velocity of blood particles flying out of the center)
648 //short count (number of blood particles)
649 //description:
650 //creates an exploding shower of blood, for making gibbings more convincing.
651
652 //DP_TE_CUSTOMFLASH
653 //idea: LordHavoc
654 //darkplaces implementation: LordHavoc
655 //builtin definitions:
656 void(vector org, float radius, float lifetime, vector color) te_customflash = #417;
657 //temp entity definitions:
658 //float TE_CUSTOMFLASH = 73;
659 //protocol:
660 //vector origin
661 //byte radius ((MSG_ReadByte() + 1) * 8, meaning 8-2048 unit radius)
662 //byte lifetime ((MSG_ReadByte() + 1) / 256.0, meaning approximately 0-1 second lifetime)
663 //byte red (0.0 to 1.0 converted to 0-255)
664 //byte green (0.0 to 1.0 converted to 0-255)
665 //byte blue (0.0 to 1.0 converted to 0-255)
666 //description:
667 //creates a customized light flash.
668
669 //DP_TE_EXPLOSIONRGB
670 //idea: LordHavoc
671 //darkplaces implementation: LordHavoc
672 //builtin definitions:
673 void(vector org, vector color) te_explosionrgb = #407;
674 //temp entity definitions:
675 //float TE_EXPLOSIONRGB = 53;
676 //protocol:
677 //vector origin
678 //byte red (0.0 to 1.0 converted to 0 to 255)
679 //byte green (0.0 to 1.0 converted to 0 to 255)
680 //byte blue (0.0 to 1.0 converted to 0 to 255)
681 //description:
682 //creates a colored explosion effect.
683
684 //DP_TE_FLAMEJET
685 //idea: LordHavoc
686 //darkplaces implementation: LordHavoc
687 //temp entity definitions:
688 float TE_FLAMEJET = 74;
689 //protocol:
690 //vector origin
691 //vector velocity
692 //byte count (0 to 255, how many flame particles)
693 //description:
694 //creates a single puff of flame particles.  (not very useful really)
695
696 //DP_TE_PARTICLECUBE
697 //idea: LordHavoc
698 //darkplaces implementation: LordHavoc
699 //builtin definitions:
700 void(vector mincorner, vector maxcorner, vector vel, float howmany, float color, float gravityflag, float randomveljitter) te_particlecube = #408;
701 //temp entity definitions:
702 //float TE_PARTICLECUBE = 54;
703 //protocol:
704 //vector mins (minimum corner of the cube)
705 //vector maxs (maximum corner of the cube)
706 //vector velocity
707 //short count
708 //byte color (palette color)
709 //byte gravity (TRUE or FALSE, FIXME should this be a scaler instead?)
710 //coord randomvel (how much to jitter the velocity)
711 //description:
712 //creates a cloud of particles, useful for forcefields but quite customizable.
713
714 //DP_TE_PARTICLERAIN
715 //idea: LordHavoc
716 //darkplaces implementation: LordHavoc
717 //builtin definitions:
718 void(vector mincorner, vector maxcorner, vector vel, float howmany, float color) te_particlerain = #409;
719 //temp entity definitions:
720 //float TE_PARTICLERAIN = 55;
721 //protocol:
722 //vector mins (minimum corner of the cube)
723 //vector maxs (maximum corner of the cube)
724 //vector velocity (velocity of particles)
725 //short count (number of particles)
726 //byte color (8bit palette color)
727 //description:
728 //creates a shower of rain, the rain will appear either at the top (if falling down) or bottom (if falling up) of the cube.
729
730 //DP_TE_PARTICLESNOW
731 //idea: LordHavoc
732 //darkplaces implementation: LordHavoc
733 //builtin definitions:
734 void(vector mincorner, vector maxcorner, vector vel, float howmany, float color) te_particlesnow = #410;
735 //temp entity definitions:
736 //float TE_PARTICLERAIN = 56;
737 //protocol:
738 //vector mins (minimum corner of the cube)
739 //vector maxs (maximum corner of the cube)
740 //vector velocity (velocity of particles)
741 //short count (number of particles)
742 //byte color (8bit palette color)
743 //description:
744 //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.
745
746 //DP_TE_QUADEFFECTS1
747 //idea: LordHavoc
748 //darkplaces implementation: LordHavoc
749 //builtin definitions:
750 void(vector org) te_gunshotquad = #412;
751 void(vector org) te_spikequad = #413;
752 void(vector org) te_superspikequad = #414;
753 void(vector org) te_explosionquad = #415;
754 //temp entity definitions:
755 //float   TE_GUNSHOTQUAD  = 57; // [vector] origin
756 //float   TE_SPIKEQUAD    = 58; // [vector] origin
757 //float   TE_SUPERSPIKEQUAD = 59; // [vector] origin
758 //float   TE_EXPLOSIONQUAD = 70; // [vector] origin
759 //protocol:
760 //vector origin
761 //description:
762 //all of these just take a location, and are equivilant in function (but not appearance :) to the original TE_GUNSHOT, etc.
763
764 //DP_TE_SMALLFLASH
765 //idea: LordHavoc
766 //darkplaces implementation: LordHavoc
767 //builtin definitions:
768 void(vector org) te_smallflash = #416;
769 //temp entity definitions:
770 //float TE_SMALLFLASH = 72;
771 //protocol:
772 //vector origin
773 //description:
774 //creates a small light flash (radius 200, time 0.2).
775
776 //DP_TE_SPARK
777 //idea: LordHavoc
778 //darkplaces implementation: LordHavoc
779 //builtin definitions:
780 void(vector org, vector vel, float howmany) te_spark = #411;
781 //temp entity definitions:
782 //float TE_SPARK = 51;
783 //protocol:
784 //vector origin
785 //byte xvelocity (-128 to 127)
786 //byte yvelocity (-128 to 127)
787 //byte zvelocity (-128 to 127)
788 //byte count (number of sparks)
789 //description:
790 //creates a shower of sparks and a smoke puff.
791
792 //DP_TE_STANDARDEFFECTBUILTINS
793 //idea: LordHavoc
794 //darkplaces implementation: LordHavoc
795 //builtin definitions:
796 void(vector org) te_gunshot = #418;
797 void(vector org) te_spike = #419;
798 void(vector org) te_superspike = #420;
799 void(vector org) te_explosion = #421;
800 void(vector org) te_tarexplosion = #422;
801 void(vector org) te_wizspike = #423;
802 void(vector org) te_knightspike = #424;
803 void(vector org) te_lavasplash = #425;
804 void(vector org) te_teleport = #426;
805 void(vector org, float color) te_explosion2 = #427;
806 void(entity own, vector start, vector end) te_lightning1 = #428;
807 void(entity own, vector start, vector end) te_lightning2 = #429;
808 void(entity own, vector start, vector end) te_lightning3 = #430;
809 void(entity own, vector start, vector end) te_beam = #431;
810 //description:
811 //to make life easier on mod coders.
812
813 //DP_TE_PLASMABURN
814 //idea: LordHavoc
815 //darkplaces implementation: LordHavoc
816 //builtin definitions:
817 void(vector org) te_plasmaburn = #433;
818 //temp entity definitions:
819 //float TE_PLASMABURN = 75;
820 //protocol:
821 //vector origin
822 //description:
823 //creates a small light flash (radius 200, time 0.2) and marks the walls.
824
825 //DP_VIEWZOOM
826 //idea: LordHavoc
827 //darkplaces implementation: LordHavoc
828 //field definitions:
829 .float viewzoom;
830 //description:
831 //scales fov and sensitivity of player, valid range is 0 to 1 (intended for sniper rifle zooming, and such)
832
833 //FRIK_FILE
834 //idea: FrikaC
835 //darkplaces implementation: LordHavoc
836 //builtin definitions:
837 float(string s) stof = #81; // get numerical value from a string
838 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
839 void(float fhandle) fclose = #111; // closes a file
840 string(float fhandle) fgets = #112; // reads a line of text from the file and returns as a tempstring
841 void(float fhandle, string s) fputs = #113; // writes a line of text to the end of the file
842 float(string s) strlen = #114; // returns how many characters are in a string
843 string(string s1, ...) strcat = #115; // concatenates two strings (for example "abc", "def" would return "abcdef") and returns as a tempstring
844 string(string s, float start, float length) substring = #116; // returns a section of a string as a tempstring
845 vector(string s) stov = #117; // returns vector value from a string
846 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)
847 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!!!)
848 //constants:
849 float FILE_READ = 0;
850 float FILE_APPEND = 1;
851 float FILE_WRITE = 2;
852 //cvars:
853 //pr_zone_min_strings : default 64 (64k), min 64 (64k), max 8192 (8mb)
854 //description:
855 //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.
856
857 //KRIMZON_SV_PARSECLIENTCOMMAND
858 //idea: KrimZon
859 //darkplaces implementation: KrimZon, LordHavoc
860 //engine-called QC prototypes:
861 //void(string s) SV_ParseClientCommand;
862 //builtin definitions:
863 void(entity e, string s) clientcommand = #440;
864 float(string s) tokenize = #441;
865 string(float n) argv = #442;
866 //description:
867 //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
868
869 //NEH_RESTOREGAME
870 //idea: Nehahra
871 //darkplaces implementation: LordHavoc
872 //engine-called QC prototypes:
873 //void() RestoreGame;
874 //description:
875 //when a savegame is loaded, this function is called
876
877 //NEH_CMD_PLAY2
878 //idea: Nehahra
879 //darkplaces implementation: LordHavoc
880 //description:
881 //shows that the engine supports the "play2" console command (plays a sound without spatialization).
882
883 //TW_SV_STEPCONTROL
884 //idea: Transfusion
885 //darkplaces implementation: LordHavoc
886 //cvars:
887 //sv_jumpstep (0/1, default 1)
888 //sv_stepheight (default 18)
889 //description:
890 //sv_jumpstep allows stepping up onto stairs while airborn, sv_stepheight controls how high a single step can be.
891
892 // NEXUIZ_PLAYERMODEL
893 // NEXUIZ_PLAYERSKIN
894 //idea:
895 //darkplaces implementation: Black
896 .string playermodel; // contains the name of the model set by a client with playermodel
897 .string playerskin; // contains the name of the skin set by a client with playerskin
898
899 // UNFINISHED section
900 //DP_QC_BOTCLIENT
901 //idea: LordHavoc
902 //darkplaces implementation: LordHavoc
903 //builtin definitions:
904 // FIXME: these need numbers assigned, and they need to be added to the engine!
905 //entity() spawnclient = #; // like spawn but for client slots (also calls relevant connect/spawn functions), returns world if no clients available
906 //void(entity e) removeclient = #; // like remove but for client slots (also calls relevant disconnect functions)
907 //description:
908 //functions to allow bots to use client slots with no hacks, some notes:
909 .string netname; //controls name on scoreboard (so be sure to set it for a bot)
910 .float frags; //controls score on scoreboard (this is expected)
911 .float clientcolors; //controls coloring on scoreboard (this determines player colors exactly like the "color" command, except for using a single number that contains pants and shirt colors (pants + shirt * 16, 0-255 potentially), so be sure to set it for a bot)
912 //note also that these fields can be set on a real client to change the relevant settings.
913 //see also DP_SV_SETCOLOR extension for another way to manipulate clientcolors (made obsolete by this extension).
914
915 //unassigned stuff:  (need to write up specs but haven't yet)
916 .vector punchvector; // DP_SV_PUNCHVECTOR
917 .float  ping; // DP_SV_PING
918
919