bumps for morphed's teleporter model

[divverent/nexuiz.git] / TeamNexuiz / game / gamec / extensions.h

\r
//DarkPlaces supported extension list, draft version 1.04\r
\r
//checkextension function\r
//idea: expected by almost everyone\r
//darkplaces implementation: LordHavoc\r
float(string s) checkextension = #99;\r
//description:\r
//check if (cvar("pr_checkextension")) before calling this, this is the only\r
//guarenteed extension to be present in the extension system, it allows you\r
//to check if an extension is available, by name, to check for an extension\r
//use code like this:\r
//// (it is recommended this code be placed in worldspawn or a worldspawn called function somewhere)\r
//if (cvar("pr_checkextension"))\r
//if (checkextension("DP_SV_SETCOLOR"))\r
//      ext_setcolor = TRUE;\r
//from then on you can check ext_setcolor to know if that extension is available\r
\r
//DP_QC_CVAR_STRING\r
//idea: Paul Timofeyev\r
//DarkPlaces implementation: Paul Timofeyev, LordHavoc\r
//builtin definitions:\r
string(string s) cvar_string = #448;\r
//description:\r
//returns the value of a cvar, as a tempstring.\r
\r
//DP_QC_TRACE_MOVETYPES\r
//idea: LordHavoc\r
//darkplaces implementation: id Software\r
//constant definitions:\r
float MOVE_NORMAL = 0; // same as FALSE\r
float MOVE_NOMONSTERS = 1; // same as TRUE\r
float MOVE_MISSILE = 2; // save as movement with .movetype == MOVETYPE_FLYMISSILE\r
//description:\r
//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\r
\r
//DP_QC_TRACE_MOVETYPE_WORLDONLY\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//constant definitions:\r
float MOVE_WORLDONLY = 3;\r
//description:\r
//allows traces to hit only world (see DP_QC_TRACE_MOVETYPES for how to use this)\r
\r
//DP_QC_TRACE_MOVETYPE_HITMODEL\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//constant definitions:\r
float MOVE_HITMODEL = 4;\r
//description:\r
//allows traces to hit alias models (not sprites!) instead of entity boxes (see DP_QC_TRACE_MOVETYPES for how to use this)\r
\r
// LordHavoc: HIGHLY experimental, do not implement this in other engines\r
//DP_CGAME\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//SVC definitions:\r
float svc_cgame = 50; // [short] length [bytes] data\r
//description:\r
//contains network messages to client gamecode.\r
\r
//DP_CL_LOADSKY\r
//idea: Nehahra, LordHavoc\r
//darkplaces implementation: LordHavoc\r
//client console commands:\r
//"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)\r
//description:\r
//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).\r
\r
//DP_EF_ADDITIVE\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//effects bit:\r
float   EF_ADDITIVE     = 32;\r
//description:\r
//additive blending when this object is rendered\r
\r
//DP_EF_BLUE\r
//idea: id Software\r
//darkplaces implementation: LordHavoc\r
//effects bit:\r
float   EF_BLUE         = 64;\r
//description:\r
//entity emits blue light (used for quad)\r
\r
//DP_EF_FLAME\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//effects bit:\r
float   EF_FLAME        = 1024;\r
//description:\r
//entity is on fire\r
\r
//DP_EF_FULLBRIGHT\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//effects bit:\r
float   EF_FULLBRIGHT   = 512;\r
//description:\r
//entity is always brightly lit\r
\r
//DP_EF_NODRAW\r
//idea: id Software\r
//darkplaces implementation: LordHavoc\r
//effects bit:\r
float   EF_NODRAW       = 16;\r
//description:\r
//prevents server from sending entity to client (forced invisible, even if it would have been a light source or other such things)\r
\r
//DP_EF_RED\r
//idea: id Software\r
//darkplaces implementation: LordHavoc\r
//effects bit:\r
float   EF_RED          = 128;\r
//description:\r
//entity emits red light (used for invulnerability)\r
\r
//DP_EF_STARDUST\r
//idea: MythWorks Inc\r
//darkplaces implementation: LordHavoc\r
//effects bit:\r
float   EF_STARDUST     = 2048;\r
//description:\r
//entity emits bouncing sparkles in every direction\r
\r
//entity attributes used for rendering/networking:\r
//idea: Nehahra\r
//darkplaces implementation: LordHavoc\r
//DP_ENT_ALPHA\r
//field definition:\r
.float alpha;\r
//description:\r
//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).\r
\r
//DP_ENT_COLORMOD\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//field definition:\r
.vector colormod;\r
//description:\r
//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).\r
\r
//DP_ENT_CUSTOMCOLORMAP\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//description:\r
//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.\r
\r
/*\r
//NOTE: no longer supported by darkplaces because all entities are delta compressed now\r
//DP_ENT_DELTACOMPRESS // no longer supported\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//effects bit:\r
float EF_DELTA = 8388608;\r
//description:\r
//(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).\r
*/\r
\r
//DP_ENT_EXTERIORMODELTOCLIENT\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//fields:\r
.entity exteriormodeltoclient;\r
//description:\r
//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.\r
\r
//DP_ENT_GLOW\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//field definitions:\r
.float glow_color;\r
.float glow_size;\r
.float glow_trail;\r
//description:\r
//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.\r
\r
//DP_ENT_LOWPRECISION\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//effects bit:\r
float EF_LOWPRECISION = 4194304;\r
//description:\r
//uses low quality origin coordinates, reducing network traffic compared to the default high precision, intended for numerous objects (projectiles/gibs/bullet holes/etc).\r
\r
//DP_ENT_SCALE\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//field definitions:\r
.float scale;\r
//description:\r
//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.\r
\r
//DP_ENT_VIEWMODEL\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//field definitions:\r
.entity viewmodelforclient;\r
//description:\r
//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.\r
\r
//DP_GFX_FOG\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//worldspawn fields:\r
//"fog" (parameters: "density red green blue", example: "0.1 0.3 0.3 0.3")\r
//description:\r
//global fog for the map, can not be changed by QC\r
\r
//DP_GFX_SKYBOX\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//worldspawn fields:\r
//"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)\r
//description:\r
//global skybox for the map, can not be changed by QC\r
\r
//DP_GFX_EXTERNALTEXTURES\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//description:\r
//loads external textures found in various directories (tenebrae compatible)...\r
/*\r
in all examples .tga is merely the base texture, it can be any of these:\r
.tga (base texture)\r
_glow.tga (fullbrights or other glowing overlay stuff, NOTE: this is done using additive blend, not alpha)\r
_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)\r
_shirt.tga (same idea as pants, but for shirt color)\r
_diffuse.tga (this may be used instead of base texture for per pixel lighting)\r
_gloss.tga (specular texture for per pixel lighting, note this can be in color (tenebrae only supports greyscale))\r
_norm.tga (normalmap texture for per pixel lighting)\r
_bump.tga (bumpmap, converted to normalmap at load time, supported only for reasons of tenebrae compatibility)\r
_luma.tga (same as _glow but supported only for reasons of tenebrae compatibility)\r
\r
due to glquake's incomplete Targa(r) loader, this section describes\r
required Targa(r) features support:\r
types:\r
type 1 (uncompressed 8bit paletted with 24bit/32bit palette)\r
type 2 (uncompressed 24bit/32bit true color, glquake supported this)\r
type 3 (uncompressed 8bit greyscale)\r
type 9 (RLE compressed 8bit paletted with 24bit/32bit palette)\r
type 10 (RLE compressed 24bit/32bit true color, glquake supported this)\r
type 11 (RLE compressed 8bit greyscale)\r
attribute bit 0x20 (Origin At Top Left, top to bottom, left to right)\r
\r
image formats guarenteed to be supported: tga, pcx, lmp\r
image formats that are optional: png, jpg\r
\r
mdl/spr/spr32 examples:\r
skins are named _A (A being a number) and skingroups are named like _A_B\r
these act as suffixes on the model name...\r
example names for skin _2_1 of model "progs/armor.mdl":\r
game/override/progs/armor.mdl_2_1.tga\r
game/textures/progs/armor.mdl_2_1.tga\r
game/progs/armor.mdl_2_1.tga\r
example names for skin _0 of the model "progs/armor.mdl":\r
game/override/progs/armor.mdl_0.tga\r
game/textures/progs/armor.mdl_0.tga\r
game/progs/armor.mdl_0.tga\r
note that there can be more skins files (of the _0 naming) than the mdl\r
contains, this is only useful to save space in the .mdl file if classic quake\r
compatibility is not a concern.\r
\r
bsp/md2/md3 examples:\r
example names for the texture "quake" of model "maps/start.bsp":\r
game/override/quake.tga\r
game/textures/quake.tga\r
game/progs/quake.tga\r
\r
sbar/menu/console textures: for example the texture "conchars" (console font) in gfx.wad\r
game/override/gfx/conchars.tga\r
game/textures/gfx/conchars.tga\r
game/gfx/conchars.tga\r
*/\r
\r
//DP_GFX_QUAKE3MODELTAGS\r
//idea: id Software\r
//darkplaces implementation: LordHavoc\r
//field definitions:\r
.entity tag_entity; // entity this is attached to (call setattachment to set this)\r
.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)\r
//builtin definitions:\r
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)\r
//description:\r
//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).\r
//note 2: if the tag is not found, it defaults to "" (attach to origin/angles of entity)\r
//note 3: attaching to world turns off attachment\r
//note 4: the entity that this is attached to must be visible for this to work\r
\r
//DP_GFX_SKINFILES\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//description:\r
//alias models (mdl, md2, md3) can have .skin files to replace conventional texture naming, these have a naming format such as:\r
//progs/test.md3_0.skin\r
//progs/test.md3_1.skin\r
//...\r
//\r
//these files contain replace commands (replace meshname shadername), example:\r
//replace "helmet" "progs/test/helmet1.tga" // this is a mesh shader replacement\r
//replace "teamstripes" "progs/test/redstripes.tga"\r
//replace "visor" "common/nodraw" // this makes the visor mesh invisible\r
////it is not possible to rename tags using this format\r
//\r
//Or the Quake3 syntax (100% compatible with Quake3's .skin files):\r
//helmet,progs/test/helmet1.tga // this is a mesh shader replacement\r
//teamstripes,progs/test/redstripes.tga\r
//visor,common/nodraw // this makes the visor mesh invisible\r
//tag_camera, // this defines that the first tag in the model is called tag_camera\r
//tag_test, // this defines that the second tag in the model is called tag_test\r
//\r
//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.\r
//this feature is intended to allow multiple skin sets on md3 models (which otherwise only have one skin set).\r
//other commands might be added someday but it is not expected.\r
\r
//DP_HALFLIFE_MAP\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//description:\r
//simply indicates that the engine supports HalfLife maps (BSP version 30, NOT the QER RGBA ones which are also version 30).\r
\r
//DP_HALFLIFE_MAP_CVAR\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//cvars:\r
//halflifebsp 0/1\r
//description:\r
//engine sets this cvar when loading a map to indicate if it is halflife format or not.\r
\r
//DP_INPUTBUTTONS\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//field definitions:\r
.float button3;\r
.float button4;\r
.float button5;\r
.float button6;\r
.float button7;\r
.float button8;\r
//description:\r
//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).\r
\r
//DP_MONSTERWALK\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//description:\r
//MOVETYPE_WALK is permitted on non-clients, so bots can move smoothly, run off ledges, etc, just like a real player.\r
\r
//DP_MOVETYPEBOUNCEMISSILE\r
//idea: id Software\r
//darkplaces implementation: id Software\r
//movetype definitions:\r
float MOVETYPE_BOUNCEMISSILE = 11;\r
//description:\r
//MOVETYPE_BOUNCE but without gravity, and with full reflection (no speed loss like grenades have), in other words - bouncing laser bolts.\r
\r
//DP_MOVETYPEFOLLOW\r
//idea: id Software, LordHavoc (redesigned)\r
//darkplaces implementation: LordHavoc\r
//movetype definitions:\r
float MOVETYPE_FOLLOW = 12;\r
//description:\r
//MOVETYPE_FOLLOW implemented, this uses existing entity fields in unusual ways:\r
//aiment - the entity this is attached to.\r
//punchangle - the original angles when the follow began.\r
//view_ofs - the relative origin (note that this is un-rotated by punchangle, and that is actually the only purpose of punchangle).\r
//v_angle - the relative angles.\r
//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:\r
//hole.movetype = MOVETYPE_FOLLOW; // make the hole follow\r
//hole.solid = SOLID_NOT; // MOVETYPE_FOLLOW is always non-solid\r
//hole.aiment = bmodel; // make the hole follow bmodel\r
//hole.punchangle = bmodel.angles; // the original angles of bmodel\r
//hole.view_ofs = hole.origin - bmodel.origin; // relative origin\r
//hole.v_angle = hole.angles - bmodel.angles; // relative angles\r
\r
//DP_QC_CHANGEPITCH\r
//idea: id Software\r
//darkplaces implementation: id Software\r
//field definitions:\r
.float idealpitch;\r
.float pitch_speed;\r
//builtin definitions:\r
void(entity ent) changepitch = #63;\r
//description:\r
//equivilant to changeyaw, ent is normally self. (this was a Q2 builtin)\r
\r
//DP_QC_COPYENTITY\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//builtin definitions:\r
void(entity from, entity to) copyentity = #400;\r
//description:\r
//copies all data in the entity to another entity.\r
\r
//DP_QC_ETOS\r
//idea: id Software\r
//darkplaces implementation: id Software\r
//builtin definitions:\r
string(entity ent) etos = #65;\r
//description:\r
//lists all of the entity's fields into a string (similar to edict command in console). (this was a Q2 builtin)\r
\r
//DP_QC_FINDCHAIN\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//builtin definitions:\r
entity(.string fld, string match) findchain = #402;\r
//description:\r
//similar to find() but returns a chain of entities like findradius.\r
\r
//DP_QC_FINDCHAINFLOAT\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//builtin definitions:\r
entity(.entity fld, entity match) findchainentity = #403;\r
entity(.float fld, float match) findchainfloat = #403;\r
//description:\r
//similar to findentity()/findfloat() but returns a chain of entities like findradius.\r
\r
//DP_QC_FINDFLOAT\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//builtin definitions:\r
entity(entity start, .entity fld, entity match) findentity = #98;\r
entity(entity start, .float fld, float match) findfloat = #98;\r
//description:\r
//finds an entity or float field value, similar to find(), but for entity and float fields.\r
\r
//DP_QC_GETLIGHT\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//builtin definitions:\r
vector(vector org) getlight = #92;\r
//description:\r
//returns the lighting at the requested location (in color), 0-255 range (can exceed 255).\r
\r
//DP_QC_GETSURFACE\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//builtin definitions:\r
float(entity e, float s) getsurfacenumpoints = #434;\r
vector(entity e, float s, float n) getsurfacepoint = #435;\r
vector(entity e, float s) getsurfacenormal = #436;\r
string(entity e, float s) getsurfacetexture = #437;\r
float(entity e, vector p) getsurfacenearpoint = #438;\r
vector(entity e, float s, vector p) getsurfaceclippedpoint = #439;\r
//description:\r
//functions to query surface information.\r
\r
//DP_QC_MINMAXBOUND\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//builtin definitions:\r
float(float a, float b) min = #94;\r
float(float a, float b, float c) min3 = #94;\r
float(float a, float b, float c, float d) min4 = #94;\r
float(float a, float b, float c, float d, float e) min5 = #94;\r
float(float a, float b, float c, float d, float e, float f) min6 = #94;\r
float(float a, float b, float c, float d, float e, float f, float g) min7 = #94;\r
float(float a, float b, float c, float d, float e, float f, float g, float h) min8 = #94;\r
float(float a, float b) max = #95;\r
float(float a, float b, float c) max3 = #95;\r
float(float a, float b, float c, float d) max4 = #95;\r
float(float a, float b, float c, float d, float e) max5 = #95;\r
float(float a, float b, float c, float d, float e, float f) max6 = #95;\r
float(float a, float b, float c, float d, float e, float f, float g) max7 = #95;\r
float(float a, float b, float c, float d, float e, float f, float g, float h) max8 = #95;\r
float(float minimum, float val, float maximum) bound = #96;\r
//description:\r
//min returns the lowest of all the supplied numbers.\r
//max returns the highest of all the supplied numbers.\r
//bound clamps the value to the range and returns it.\r
\r
//DP_QC_RANDOMVEC\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//builtin definitions:\r
vector() randomvec = #91;\r
//description:\r
//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)\r
\r
//DP_QC_SINCOSSQRTPOW\r
//idea: id Software, LordHavoc\r
//darkplaces implementation: id Software, LordHavoc\r
//builtin definitions:\r
float(float val) sin = #60;\r
float(float val) cos = #61;\r
float(float val) sqrt = #62;\r
float(float a, float b) pow = #97;\r
//description:\r
//useful math functions, sine of val, cosine of val, square root of val, and raise a to power b, respectively.\r
\r
//DP_QC_TRACEBOX\r
//idea: id Software\r
//darkplaces implementation: id Software\r
//builtin definitions:\r
void(vector v1, vector min, vector max, vector v2, float nomonsters, entity forent) tracebox = #90;\r
//description:\r
//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).\r
\r
//DP_QC_TRACETOSS\r
//idea: id Software\r
//darkplaces implementation: id Software\r
//builtin definitions:\r
void(entity ent, entity ignore) tracetoss = #64;\r
//description:\r
//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.\r
\r
//DP_QC_VECTORVECTORS\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//builtin definitions:\r
void(vector dir) vectorvectors = #432;\r
//description:\r
//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.\r
\r
//DP_QUAKE2_MODEL\r
//idea: quake community\r
//darkplaces implementation: LordHavoc\r
//description:\r
//shows that the engine supports Quake2 .md2 files.\r
\r
//DP_QUAKE3_MODEL\r
//idea: quake community\r
//darkplaces implementation: LordHavoc\r
//description:\r
//shows that the engine supports Quake3 .md3 files.\r
\r
//DP_REGISTERCVAR\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//builtin definitions:\r
float(string name, string value) registercvar = #93;\r
//description:\r
//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.\r
\r
//DP_SOLIDCORPSE\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//solid definitions:\r
float SOLID_CORPSE = 5;\r
//description:\r
//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.\r
\r
//DP_SPRITE32\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//description:\r
//the engine supports .spr32 sprites.\r
\r
//DP_SV_BOTCLIENT\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//constants:\r
float CLIENTTYPE_DISCONNECTED = 0;\r
float CLIENTTYPE_REAL = 1;\r
float CLIENTTYPE_BOT = 2;\r
float CLIENTTYPE_NOTACLIENT = 3;\r
//builtin definitions:\r
entity() spawnclient = #454; // like spawn but for client slots (also calls relevant connect/spawn functions), returns world if no clients available\r
float(entity clent) clienttype = #455; // returns one of the CLIENTTYPE_* constants\r
void(entity clent) dropclient = #453;\r
//description:\r
//spawns a client with no network connection, to allow bots to use client slots with no hacks.\r
//How to use:\r
/*\r
        // to spawn a bot\r
        local entity oldself;\r
        oldself = self;\r
        self = spawnclient();\r
        if (!self)\r
        {\r
                bprint("Can not add bot, server full.\n");\r
                self = oldself;\r
                return;\r
        }\r
        self.netname = "Yoyobot";\r
        self.clientcolors = 12 * 16 + 4; // yellow (12) shirt and red (4) pants\r
        ClientConnect();\r
        PutClientInServer();\r
        self = oldself;\r
\r
        // to remove all bots\r
        local entity head;\r
        head = find(world, classname, "player");\r
        while (head)\r
        {\r
                if (clienttype(head) == CLIENTTYPE_BOT)\r
                        dropclient(head);\r
                head = find(head, classname, "player");\r
        }\r
\r
        // to identify if a client is a bot (for example in PlayerPreThink)\r
        if (clienttype(self) == CLIENTTYPE_BOT)\r
                botthink();\r
*/\r
//see also DP_SV_CLIENTCOLORS DP_SV_CLIENTNAME DP_SV_DROPCLIENT\r
//How it works:\r
//creates a new client, calls SetNewParms and stores the parms, and returns the client.\r
//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\r
//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).\r
//parms work the same on bot clients as they do on real clients, and do carry from level to level\r
\r
//DP_SV_CLIENTCOLORS\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
.float clientcolors; // colors of the client (format: pants + shirt * 16)\r
//description:\r
//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\r
\r
//DP_SV_CLIENTNAME\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//allows qc to modify the client's .netname, and automatically sends out any appropriate network updates if changed\r
\r
//DP_SV_DRAWONLYTOCLIENT\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//field definitions:\r
.entity drawonlytoclient;\r
//description:\r
//the entity is only visible to the specified client.\r
\r
//DP_SV_EFFECT\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//builtin definitions:\r
void(vector org, string modelname, float startframe, float endframe, float framerate) effect = #404;\r
//SVC definitions:\r
//float svc_effect = #52; // [vector] org [byte] modelindex [byte] startframe [byte] framecount [byte] framerate\r
//float svc_effect2 = #53; // [vector] org [short] modelindex [byte] startframe [byte] framecount [byte] framerate\r
//description:\r
//clientside playback of simple custom sprite effects (explosion sprites, etc).\r
\r
//DP_SV_NODRAWTOCLIENT\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//field definitions:\r
.entity nodrawtoclient;\r
//description:\r
//the entity is not visible to the specified client.\r
\r
//DP_SV_PLAYERPHYSICS\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//field definitions:\r
.vector movement;\r
//engine-called QC prototypes:\r
//void() SV_PlayerPhysics;\r
//description:\r
//.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)\r
\r
//DP_SV_SETCOLOR\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//builtin definitions:\r
void(entity ent, float colors) setcolor = #401;\r
//engine called QC functions (optional):\r
//void(float color) SV_ChangeTeam;\r
//description:\r
//setcolor sets the color on a client and updates internal color information accordingly (equivilant to stuffing a "color" command but immediate)\r
//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.\r
//the color format is pants + shirt * 16 (0-255 potentially)\r
\r
//DP_SV_SLOWMO\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//cvars:\r
//"slowmo" (0+, default 1)\r
//description:\r
//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.\r
//range is 0 to infinite, recommended values to try are 0.1 (very slow, 10% speed), 1 (normal speed), 5 (500% speed).\r
\r
//DP_TE_BLOOD\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//builtin definitions:\r
void(vector org, vector velocity, float howmany) te_blood = #405;\r
//temp entity definitions:\r
float TE_BLOOD = 50;\r
//protocol:\r
//vector origin\r
//byte xvelocity (-128 to +127)\r
//byte yvelocity (-128 to +127)\r
//byte zvelocity (-128 to +127)\r
//byte count (0 to 255, how much blood)\r
//description:\r
//creates a blood effect.\r
\r
//DP_TE_BLOODSHOWER\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//builtin definitions:\r
void(vector mincorner, vector maxcorner, float explosionspeed, float howmany) te_bloodshower = #406;\r
//temp entity definitions:\r
//float TE_BLOODSHOWER = 52;\r
//protocol:\r
//vector mins (minimum corner of the cube)\r
//vector maxs (maximum corner of the cube)\r
//coord explosionspeed (velocity of blood particles flying out of the center)\r
//short count (number of blood particles)\r
//description:\r
//creates an exploding shower of blood, for making gibbings more convincing.\r
\r
//DP_TE_CUSTOMFLASH\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//builtin definitions:\r
void(vector org, float radius, float lifetime, vector color) te_customflash = #417;\r
//temp entity definitions:\r
//float TE_CUSTOMFLASH = 73;\r
//protocol:\r
//vector origin\r
//byte radius ((MSG_ReadByte() + 1) * 8, meaning 8-2048 unit radius)\r
//byte lifetime ((MSG_ReadByte() + 1) / 256.0, meaning approximately 0-1 second lifetime)\r
//byte red (0.0 to 1.0 converted to 0-255)\r
//byte green (0.0 to 1.0 converted to 0-255)\r
//byte blue (0.0 to 1.0 converted to 0-255)\r
//description:\r
//creates a customized light flash.\r
\r
//DP_TE_EXPLOSIONRGB\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//builtin definitions:\r
void(vector org, vector color) te_explosionrgb = #407;\r
//temp entity definitions:\r
//float TE_EXPLOSIONRGB = 53;\r
//protocol:\r
//vector origin\r
//byte red (0.0 to 1.0 converted to 0 to 255)\r
//byte green (0.0 to 1.0 converted to 0 to 255)\r
//byte blue (0.0 to 1.0 converted to 0 to 255)\r
//description:\r
//creates a colored explosion effect.\r
\r
//DP_TE_FLAMEJET\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//temp entity definitions:\r
float TE_FLAMEJET = 74;\r
//protocol:\r
//vector origin\r
//vector velocity\r
//byte count (0 to 255, how many flame particles)\r
//description:\r
//creates a single puff of flame particles.  (not very useful really)\r
\r
//DP_TE_PARTICLECUBE\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//builtin definitions:\r
void(vector mincorner, vector maxcorner, vector vel, float howmany, float color, float gravityflag, float randomveljitter) te_particlecube = #408;\r
//temp entity definitions:\r
//float TE_PARTICLECUBE = 54;\r
//protocol:\r
//vector mins (minimum corner of the cube)\r
//vector maxs (maximum corner of the cube)\r
//vector velocity\r
//short count\r
//byte color (palette color)\r
//byte gravity (TRUE or FALSE, FIXME should this be a scaler instead?)\r
//coord randomvel (how much to jitter the velocity)\r
//description:\r
//creates a cloud of particles, useful for forcefields but quite customizable.\r
\r
//DP_TE_PARTICLERAIN\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//builtin definitions:\r
void(vector mincorner, vector maxcorner, vector vel, float howmany, float color) te_particlerain = #409;\r
//temp entity definitions:\r
//float TE_PARTICLERAIN = 55;\r
//protocol:\r
//vector mins (minimum corner of the cube)\r
//vector maxs (maximum corner of the cube)\r
//vector velocity (velocity of particles)\r
//short count (number of particles)\r
//byte color (8bit palette color)\r
//description:\r
//creates a shower of rain, the rain will appear either at the top (if falling down) or bottom (if falling up) of the cube.\r
\r
//DP_TE_PARTICLESNOW\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//builtin definitions:\r
void(vector mincorner, vector maxcorner, vector vel, float howmany, float color) te_particlesnow = #410;\r
//temp entity definitions:\r
//float TE_PARTICLERAIN = 56;\r
//protocol:\r
//vector mins (minimum corner of the cube)\r
//vector maxs (maximum corner of the cube)\r
//vector velocity (velocity of particles)\r
//short count (number of particles)\r
//byte color (8bit palette color)\r
//description:\r
//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.\r
\r
//DP_TE_QUADEFFECTS1\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//builtin definitions:\r
void(vector org) te_gunshotquad = #412;\r
void(vector org) te_spikequad = #413;\r
void(vector org) te_superspikequad = #414;\r
void(vector org) te_explosionquad = #415;\r
//temp entity definitions:\r
//float   TE_GUNSHOTQUAD  = 57; // [vector] origin\r
//float   TE_SPIKEQUAD    = 58; // [vector] origin\r
//float   TE_SUPERSPIKEQUAD = 59; // [vector] origin\r
//float   TE_EXPLOSIONQUAD = 70; // [vector] origin\r
//protocol:\r
//vector origin\r
//description:\r
//all of these just take a location, and are equivilant in function (but not appearance :) to the original TE_GUNSHOT, etc.\r
\r
//DP_TE_SMALLFLASH\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//builtin definitions:\r
void(vector org) te_smallflash = #416;\r
//temp entity definitions:\r
//float TE_SMALLFLASH = 72;\r
//protocol:\r
//vector origin\r
//description:\r
//creates a small light flash (radius 200, time 0.2).\r
\r
//DP_TE_SPARK\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//builtin definitions:\r
void(vector org, vector vel, float howmany) te_spark = #411;\r
//temp entity definitions:\r
//float TE_SPARK = 51;\r
//protocol:\r
//vector origin\r
//byte xvelocity (-128 to 127)\r
//byte yvelocity (-128 to 127)\r
//byte zvelocity (-128 to 127)\r
//byte count (number of sparks)\r
//description:\r
//creates a shower of sparks and a smoke puff.\r
\r
//DP_TE_STANDARDEFFECTBUILTINS\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//builtin definitions:\r
void(vector org) te_gunshot = #418;\r
void(vector org) te_spike = #419;\r
void(vector org) te_superspike = #420;\r
void(vector org) te_explosion = #421;\r
void(vector org) te_tarexplosion = #422;\r
void(vector org) te_wizspike = #423;\r
void(vector org) te_knightspike = #424;\r
void(vector org) te_lavasplash = #425;\r
void(vector org) te_teleport = #426;\r
void(vector org, float color) te_explosion2 = #427;\r
void(entity own, vector start, vector end) te_lightning1 = #428;\r
void(entity own, vector start, vector end) te_lightning2 = #429;\r
void(entity own, vector start, vector end) te_lightning3 = #430;\r
void(entity own, vector start, vector end) te_beam = #431;\r
//description:\r
//to make life easier on mod coders.\r
\r
//DP_TE_PLASMABURN\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//builtin definitions:\r
void(vector org) te_plasmaburn = #433;\r
//temp entity definitions:\r
//float TE_PLASMABURN = 75;\r
//protocol:\r
//vector origin\r
//description:\r
//creates a small light flash (radius 200, time 0.2) and marks the walls.\r
\r
//DP_VIEWZOOM\r
//idea: LordHavoc\r
//darkplaces implementation: LordHavoc\r
//field definitions:\r
.float viewzoom;\r
//description:\r
//scales fov and sensitivity of player, valid range is 0 to 1 (intended for sniper rifle zooming, and such)\r
\r
//FRIK_FILE\r
//idea: FrikaC\r
//darkplaces implementation: LordHavoc\r
//builtin definitions:\r
float(string s) stof = #81; // get numerical value from a string\r
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\r
void(float fhandle) fclose = #111; // closes a file\r
string(float fhandle) fgets = #112; // reads a line of text from the file and returns as a tempstring\r
void(float fhandle, string s) fputs = #113; // writes a line of text to the end of the file\r
float(string s) strlen = #114; // returns how many characters are in a string\r
string(string s1, ...) strcat = #115; // concatenates two strings (for example "abc", "def" would return "abcdef") and returns as a tempstring\r
string(string s, float start, float length) substring = #116; // returns a section of a string as a tempstring\r
vector(string s) stov = #117; // returns vector value from a string\r
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)\r
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!!!)\r
//constants:\r
float FILE_READ = 0;\r
float FILE_APPEND = 1;\r
float FILE_WRITE = 2;\r
//cvars:\r
//pr_zone_min_strings : default 64 (64k), min 64 (64k), max 8192 (8mb)\r
//description:\r
//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.\r
\r
//KRIMZON_SV_PARSECLIENTCOMMAND\r
//idea: KrimZon\r
//darkplaces implementation: KrimZon, LordHavoc\r
//engine-called QC prototypes:\r
//void(string s) SV_ParseClientCommand;\r
//builtin definitions:\r
void(entity e, string s) clientcommand = #440;\r
float(string s) tokenize = #441;\r
string(float n) argv = #442;\r
//description:\r
//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\r
\r
//NEH_RESTOREGAME\r
//idea: Nehahra\r
//darkplaces implementation: LordHavoc\r
//engine-called QC prototypes:\r
//void() RestoreGame;\r
//description:\r
//when a savegame is loaded, this function is called\r
\r
//NEH_CMD_PLAY2\r
//idea: Nehahra\r
//darkplaces implementation: LordHavoc\r
//description:\r
//shows that the engine supports the "play2" console command (plays a sound without spatialization).\r
\r
//PRYDON_CLIENTCURSOR\r
//idea: FrikaC\r
//darkplaces implementation: LordHavoc\r
//effects bit:\r
float EF_SELECTABLE = 16384; // allows cursor to highlight entity (brighten)\r
//field definitions:\r
.float cursor_active; // true if cl_prydoncursor mode is on\r
.vector cursor_screen; // screen position of cursor as -1 to +1 in _x and _y (_z unused)\r
.vector cursor_trace_start; // position of camera\r
.vector cursor_trace_endpos; // position of cursor in world (as traced from camera)\r
.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)\r
//cvar definitions:\r
//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)\r
//description:\r
//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.\r
//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.\r
//the clientside trace skips transparent entities (except those marked EF_SELECTABLE).\r
//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).\r
//intended to be used by Prydon Gate.\r
\r
//TW_SV_STEPCONTROL\r
//idea: Transfusion\r
//darkplaces implementation: LordHavoc\r
//cvars:\r
//sv_jumpstep (0/1, default 1)\r
//sv_stepheight (default 18)\r
//description:\r
//sv_jumpstep allows stepping up onto stairs while airborn, sv_stepheight controls how high a single step can be.\r
\r
// NEXUIZ_PLAYERMODEL\r
// NEXUIZ_PLAYERSKIN\r
//idea:\r
//darkplaces implementation: Black\r
.string playermodel; // contains the name of the model set by a client with playermodel\r
.string playerskin; // contains the name of the skin set by a client with playerskin\r
\r
//unassigned stuff:  (need to write up specs but haven't yet)\r
.vector punchvector; // DP_SV_PUNCHVECTOR\r
.float  ping; // DP_SV_PING\r
\r
\r