fteqw/quakec/csaddon/src/csplat.qc

2015 lines
136 KiB
Plaintext

/*
This file was automatically generated by FTE QuakeWorld v1.05
This file can be regenerated by issuing the following command:
pr_dumpplatform -FFTE -Fdefines -TCS -O csplat -Faccessors
Available options:
-Ffte - target only FTE (optimations and additional extensions)
-Tnq - dump specifically NQ fields
-Tqw - dump specifically QW fields
-Tcs - dump specifically CSQC fields
-Tmenu - dump specifically menuqc fields
-Fdefines - generate #defines instead of constants
-Faccessors - use accessors instead of basic types via defines
-O - write to a different qc file
*/
#pragma noref 1
//#pragma flag enable logicops
#pragma warning error Q101 /*too many parms*/
#pragma warning error Q105 /*too few parms*/
#pragma warning error Q106 /*assignment to constant/lvalue*/
#pragma warning error Q208 /*system crc unknown*/
#pragma warning enable F301 /*non-utf-8 strings*/
#pragma warning enable F302 /*uninitialised locals*/
#pragma target FTE
#ifndef CSQC
#define CSQC
#endif
#define FTE_PEXT_SETVIEW /* NQ's svc_setview works correctly even in quakeworld */
#define DP_ENT_SCALE
#define FTE_PEXT_LIGHTSTYLECOL
#define DP_ENT_ALPHA
#define FTE_PEXT_VIEW2
#define FTE_PEXT_ACURATETIMINGS
#define FTE_PEXT_SOUNDDBL
#define FTE_PEXT_FATNESS
#define DP_HALFLIFE_MAP
#define FTE_PEXT_TE_BULLET
#define FTE_PEXT_HULLSIZE
#define FTE_PEXT_MODELDBL
#define FTE_PEXT_ENTITYDBL
#define FTE_PEXT_ENTITYDBL2
#define FTE_PEXT_FLOATCOORDS
#define FTE_PEXT_VWEAP
#define FTE_PEXT_Q2BSP
#define FTE_PEXT_Q3BSP
#define DP_ENT_COLORMOD
#define FTE_HEXEN2
#define FTE_PEXT_SPAWNSTATIC
#define FTE_PEXT_CUSTOMTENTS
#define FTE_PEXT_256PACKETENTITIES
#define TEI_SHOWLMP2
#define DP_GFX_QUAKE3MODELTAGS
#define FTE_PK3DOWNLOADS
#define PEXT_CHUNKEDDOWNLOADS
#define EXT_CSQC_SHARED
#define PEXT_DPFLAGS
#define EXT_CSQC
#define BX_COLOREDTEXT
#define DP_CON_SET /* The 'set' console command exists, and can be used to create/set cvars. */
#define DP_CON_SETA /* The 'seta' console command exists, like the 'set' command, but also marks the cvar for archiving, allowing it to be written into the user's config. Use this command in your default.cfg file. */
#define DP_EF_ADDITIVE
#define DP_EF_BLUE
#define DP_EF_FULLBRIGHT
#define DP_EF_NODEPTHTEST
#define DP_EF_NODRAW
#define DP_EF_NOGUNBOB
#define DP_EF_NOSHADOW
#define DP_EF_RED
#define DP_ENT_CUSTOMCOLORMAP
#define DP_ENT_EXTERIORMODELTOCLIENT
#define DP_ENT_TRAILEFFECTNUM /* self.traileffectnum=particleeffectnum("myeffectname"); can be used to attach a particle trail to the given server entity. This is equivelent to calling trailparticles each frame. */
#define DP_ENT_VIEWMODEL
#define DP_GECKO_SUPPORT
#define DP_GFX_SKINFILES
#define DP_GFX_SKYBOX
#define DP_HALFLIFE_MAP_CVAR
#define DP_INPUTBUTTONS
#define DP_LIGHTSTYLE_STATICVALUE
#define DP_LITSUPPORT
#define DP_MD3_TAGSINFO
#define DP_MONSTERWALK /* MOVETYPE_WALK is valid on non-player entities. Note that only players receive acceleration etc in line with none/bounce/fly/noclip movetypes on the player, thus you will have to provide your own accelerations (incluing gravity) yourself. */
#define DP_MOVETYPEBOUNCEMISSILE
#define DP_MOVETYPEFOLLOW
#define DP_QC_ASINACOSATANATAN2TAN
#define DP_QC_CHANGEPITCH
#define DP_QC_COPYENTITY
#define DP_QC_CRC16
#define DP_QC_CVAR_DEFSTRING
#define DP_QC_CVAR_STRING
#define DP_QC_CVAR_TYPE
#define DP_QC_EDICT_NUM
#define DP_QC_ENTITYDATA
#define DP_QC_ETOS
#define DP_QC_FINDCHAIN
#define DP_QC_FINDCHAINFLOAT
#define DP_QC_FINDFLAGS
#define DP_QC_FINDCHAINFLAGS
#define DP_QC_FINDFLOAT
#define DP_QC_FS_SEARCH
#define DP_QC_GETSURFACE
#define DP_QC_GETSURFACEPOINTATTRIBUTE
#define DP_QC_MINMAXBOUND
#define DP_QC_MULTIPLETEMPSTRINGS /* Superseded by DP_QC_UNLIMITEDTEMPSTRINGS. Functions that return a temporary string will not overwrite/destroy previous temporary strings until at least 16 strings are returned (or control returns to the engine). */
#define DP_QC_RANDOMVEC
#define DP_QC_RENDER_SCENE /* clearscene+addentity+setviewprop+renderscene+setmodel are available to menuqc. WARNING: DP advertises this extension without actually supporting it, FTE does actually support it. */
#define DP_QC_SINCOSSQRTPOW
#define DP_QC_STRFTIME
#define DP_QC_STRING_CASE_FUNCTIONS
#define DP_QC_STRINGBUFFERS
#define DP_QC_STRINGCOLORFUNCTIONS
#define DP_QC_STRREPLACE
#define DP_QC_TOKENIZEBYSEPARATOR
#define DP_QC_TRACEBOX
#define DP_QC_TRACETOSS
#define DP_QC_TRACE_MOVETYPE_HITMODEL
#define DP_QC_TRACE_MOVETYPE_WORLDONLY
#define DP_QC_TRACE_MOVETYPES
#define DP_QC_UNLIMITEDTEMPSTRINGS /* Supersedes DP_QC_MULTIPLETEMPSTRINGS, superseded by FTE_QC_PERSISTENTTEMPSTRINGS. Specifies that all temp strings will be valid at least until the QCVM returns. */
#define DP_QC_URI_ESCAPE
#define DP_QC_URI_GET
#define DP_QC_URI_POST
#define DP_QC_VECTOANGLES_WITH_ROLL
#define DP_QC_VECTORVECTORS
#define DP_QC_WHICHPACK
#define DP_QUAKE2_MODEL
#define DP_QUAKE2_SPRITE
#define DP_QUAKE3_MODEL
#define DP_REGISTERCVAR
#define DP_SND_STEREOWAV
#define DP_SND_OGGVORBIS
#define DP_SOLIDCORPSE
#define DP_SPRITE32
#define DP_SV_BOTCLIENT
#define DP_SV_CLIENTCOLORS /* Provided only for compatibility with DP. */
#define DP_SV_CLIENTNAME /* Provided only for compatibility with DP. */
#define DP_SV_DRAWONLYTOCLIENT
#define DP_SV_DROPCLIENT /* Equivelent to quakeworld's stuffcmd(self,"disconnect\n"); hack */
#define DP_SV_EFFECT
#define DP_SV_EXTERIORMODELFORCLIENT
#define DP_SV_NODRAWTOCLIENT
#define DP_SV_PLAYERPHYSICS /* Allows reworking parts of NQ player physics. USE AT OWN RISK - this necessitates NQ physics and is thus guarenteed to break prediction. */
#define DP_SV_POINTSOUND
#define DP_SV_PRECACHEANYTIME /* Specifies that the various precache builtins can be called at any time. WARNING: precaches are sent reliably while sound events, modelindexes, and particle events are not. This can mean sounds and particles might not work the first time around, or models may take a while to appear (after the reliables are received and the model is loaded from disk). Always attempt to precache a little in advance in order to reduce these issues (preferably at the start of the map...) */
#define DP_SV_SETCOLOR
#define DP_SV_SPAWNFUNC_PREFIX
#define DP_SV_WRITEPICTURE
#define DP_SV_WRITEUNTERMINATEDSTRING
#define DP_TE_BLOOD
#define DP_TE_CUSTOMFLASH
#define DP_TE_EXPLOSIONRGB
#define DP_TE_PARTICLECUBE
#define DP_TE_SMALLFLASH
#define DP_TE_SPARK
#define DP_TE_STANDARDEFFECTBUILTINS
#define DP_VIEWZOOM
#define EXT_BITSHIFT
#define EXT_DIMENSION_VISIBILITY
#define EXT_DIMENSION_PHYSICS
#define EXT_DIMENSION_GHOST
#define FRIK_FILE
#define FTE_CALLTIMEOFDAY /* Replication of mvdsv functionality (call calltimeofday to cause 'timeofday' to be called, with arguments that can be saved off to a global). Generally strftime is simpler to use. */
#define FTE_CSQC_ALTCONSOLES /* The engine tracks multiple consoles. These may or may not be directly visible to the user. */
#define FTE_CSQC_BASEFRAME /* Specifies that .basebone, .baseframe2, .baselerpfrac, baseframe1time, etc exist in csqc. These fields affect all bones in the entity's model with a lower index than the .basebone field, allowing you to give separate control to the legs of a skeletal model, without affecting the torso animations. */
#define FTE_QC_BASEFRAME /* Specifies that .basebone and .baseframe exist in ssqc. These fields affect all bones in the entity's model with a lower index than the .basebone field, allowing you to give separate control to the legs of a skeletal model, without affecting the torso animations, from ssqc. */
#define FTE_CSQC_SERVERBROWSER
#define FTE_CSQC_SKELETONOBJECTS /* Provides container objects for skeletal bone data, which can be modified on a per bone basis if needed. This allows you to dynamically generate animations (or just blend them with greater customisation) instead of being limited to a single animation or two. */
#define FTE_CSQC_RENDERTARGETS /* VF_RT_DESTCOLOUR exists and can be used to redirect any rendering to a texture instead of the screen. */
#define FTE_ENT_SKIN_CONTENTS /* self.skin = CONTENTS_WATER; makes a brush entity into water. use -16 for a ladder. */
#define FTE_ENT_UNIQUESPAWNID
#define FTE_EXTENDEDTEXTCODES
#define FTE_FORCESHADER /* Allows csqc to override shaders on models with an explicitly named replacement. Also allows you to define shaders with a fallback if it does not exist on disk. */
#define FTE_FORCEINFOKEY /* Provides an easy way to change a user's userinfo from the server. */
#define FTE_GFX_QUAKE3SHADERS /* specifies that the engine has full support for vanilla quake3 shaders */
#define FTE_GFX_REMAPSHADER /* With the raw power of stuffcmds, the r_remapshader console command is exposed! This mystical command can be used to remap any shader to another. Remapped shaders that specify $diffuse etc in some form will inherit the textures implied by the surface. */
#define FTE_ISBACKBUFFERED /* Allows you to check if a client has too many reliable messages pending. */
#define FTE_MEMALLOC /* Allows dynamically allocating memory. Use pointers to access this memory. Memory will not be saved into saved games. */
#define FTE_MEDIA_AVI /* playfilm command supports avi files. */
#define FTE_MEDIA_CIN /* playfilm command supports q2 cin files. */
#define FTE_MEDIA_ROQ /* playfilm command supports q3 roq files. */
#define FTE_MULTIPROGS /* Multiple progs.dat files can be loaded inside the same qcvm. Insert new ones with addprogs inside the 'init' function, and use externvalue+externset to rewrite globals (and hook functions) to link them together. Note that the result is generally not very clean unless you carefully design for it beforehand. */
#define FTE_MULTITHREADED /* Faux multithreading, allowing multiple contexts to run in sequence. */
#define FTE_MVD_PLAYERSTATS /* In csqc, getplayerstat can be used to query any player's stats when playing back MVDs. isdemo will return 2 in this case. */
#define FTE_NPCCHAT
#define FTE_PART_SCRIPT /* Specifies that the r_particledesc cvar can be used to select a list of particle effects to load from particles/*.cfg, the format of which is documented elsewhere. */
#define FTE_PART_NAMESPACES /* Specifies that the engine can use foo.bar to load effect foo from particle description bar. When used via ssqc, this should cause the client to download whatever effects as needed. */
#define FTE_PART_NAMESPACE_EFFECTINFO /* Specifies that effectinfo.bar can load effects from effectinfo.txt for DP compatibility. */
#define FTE_QC_CHECKCOMMAND /* Provides a way to test if a console command exists, and whether its a command/alias/cvar. Does not say anything about the expected meanings of any arguments or values. */
#define FTE_QC_CHECKPVS
#define FTE_QC_HARDWARECURSORS /* setcursormode exists in both csqc+menuqc, and accepts additional arguments to specify a cursor image to use when this module has focus. If the image exceeds hardware limits, it will be emulated using regular draws - this at least still avoids conflicting cursors. */
#define FTE_QC_HASHTABLES /* Provides efficient string-based lookups. */
#define FTE_QC_INTCONV /* Provides string<>int conversions, including hex representations. */
#define FTE_QC_MATCHCLIENTNAME
#define FTE_QC_PAUSED
#define FTE_QC_PERSISTENTTEMPSTRINGS /* Supersedes DP_QC_MULTIPLETEMPSTRINGS. Temp strings are garbage collected automatically, and do not expire while they're still in use. This makes strzone redundant. */
#define FTE_QC_RAGDOLL_WIP
#define FTE_QC_SENDPACKET /* Allows the use of out-of-band udp packets to/from other hosts. Includes the SV_ParseConnectionlessPacket event. */
#define FTE_QC_TRACETRIGGER
#define FTE_QUAKE2_CLIENT /* This engine is able to act as a quake2 client */
#define FTE_QUAKE2_SERVER /* This engine is able to act as a quake2 server */
#define FTE_QUAKE3_CLIENT /* This engine is able to act as a quake3 client */
#define FTE_QUAKE3_SERVER /* This engine is able to act as a quake3 server */
#define FTE_SOLID_LADDER /* Allows a simple trigger to remove effects of gravity (solid 20). obsolete. will prolly be removed at some point as it is not networked properly. Use FTE_ENT_SKIN_CONTENTS */
#define FTE_SQL /* Provides sql* builtins which can be used for sql database access */
#define FTE_SQL_SQLITE /* SQL functionality is able to utilise sqlite databases */
#define FTE_STRINGS /* Extra builtins (and additional behaviour) to make string manipulation easier */
#define FTE_SV_POINTPARTICLES /* Specifies that particleeffectnum, pointparticles, and trailparticles exist in ssqc as well as csqc. particleeffectnum acts as a precache, allowing ssqc values to be networked up with csqc for use. Use in combination with FTE_PART_SCRIPT+FTE_PART_NAMESPACES to use custom effects. This extension is functionally identical to the DP version, but avoids any misplaced assumptions about the format of the client's particle descriptions. */
#define FTE_SV_REENTER
#define FTE_TE_STANDARDEFFECTBUILTINS /* Provides builtins to replace writebytes, with a QW compatible twist. */
#define FTE_TERRAIN_MAP /* This engine supports .hmp files, as well as terrain embedded within bsp files. */
#define FTE_RAW_MAP /* This engine supports directly loading .map files, as well as realtime editing of the various brushes. */
#define KRIMZON_SV_PARSECLIENTCOMMAND /* SSQC's SV_ParseClientCommand function is able to handle client 'cmd' commands. The tokenizing parts also work in csqc. */
#define NEH_CMD_PLAY2
#define NEH_RESTOREGAME
#define QSG_CVARSTRING
#define QW_ENGINE
#define QWE_MVD_RECORD /* You can use the easyrecord command to record MVD demos serverside. */
#define TEI_MD3_MODEL
#define TENEBRAE_GFX_DLIGHTS /* Allows ssqc to attach rtlights to entities with various special properties. */
#define ZQ_MOVETYPE_FLY /* MOVETYPE_FLY works on players. */
#define ZQ_MOVETYPE_NOCLIP /* MOVETYPE_NOCLIP works on players. */
#define ZQ_MOVETYPE_NONE /* MOVETYPE_NONE works on players. */
#define ZQ_VWEP
#define ZQ_QC_STRINGS /* The strings-only subset of FRIK_FILE is supported. */
#define _ACCESSORS;
#ifdef _ACCESSORS
accessor strbuf : float;
accessor searchhandle : float;
accessor hashtable : float;
accessor infostring : string;
accessor filestream : float;
accessor filestream : float;
#else
#define strbuf float
#define searchhandle float
#define hashtable float
#define infostring string
#define filestream float
#endif
entity self; /* The magic me */
entity other; /* Valid in touch functions, this is the entity that we touched. */
entity world; /* The null entity. Hurrah. Readonly after map spawn time. */
float time; /* The current game time. Stops when paused. */
float cltime; /* A local timer that ticks relative to local time regardless of latency, packetloss, or pause. */
float frametime; /* The time since the last physics/render/input frame. */
float player_localentnum; /* This is entity number the player is seeing from/spectating, or the player themself, can change mid-map. */
float player_localnum; /* The 0-based player index, valid for getplayerkeyvalue calls. */
float maxclients; /* Maximum number of player slots on the server. */
float clientcommandframe; /* This is the input-frame sequence. frames < clientcommandframe have been sent to the server. frame==clientcommandframe is still being generated and can still change. */
float servercommandframe; /* This is the input-frame that was last acknowledged by the server. Input frames greater than this should be applied to the player's entity. */
string mapname; /* The short name of the map. */
float intermission;
vector v_forward, v_up, v_right;
vector view_angles; /* +x=DOWN */
float trace_allsolid, trace_startsolid, trace_fraction;
vector trace_endpos, trace_plane_normal;
float trace_plane_dist;
entity trace_ent;
float trace_inopen;
float trace_inwater;
float input_timelength;
vector input_angles; /* +x=DOWN */
vector input_movevalues;
float input_buttons;
float input_impulse;
void end_sys_globals;
.float modelindex; /* This is the model precache index for the model that was set on the entity, instead of having to look up the model according to the .model field. Use setmodel to change it. */
.vector absmin; /* Set by the engine when the entity is relinked (by setorigin, setsize, or setmodel). This is in world coordinates. */
.vector absmax; /* Set by the engine when the entity is relinked (by setorigin, setsize, or setmodel). This is in world coordinates. */
.float entnum; /* The entity number as its known on the server. */
.float drawmask; /* Acts as a filter in the addentities call. */
.float() predraw; /* Called by addentities after the filter and before the entity is actually drawn. Do your interpolation and animation in here. Should return one of the PREDRAW_* constants. */
.float movetype; /* Describes how the entity moves. One of the MOVETYPE_ constants. */
.float solid; /* Describes whether the entity is solid or not, and any special properties infered by that. Must be one of the SOLID_ constants */
.vector origin; /* The current location of the entity in world space. Inline bsp entities (ie: ones placed by a mapper) will typically have a value of '0 0 0' in their neutral pose, as the geometry is offset from that. It is the reference point of the entity rather than the center of its geometry, for non-bsp models, this is often not a significant distinction. */
.vector oldorigin; /* This is often used on players to reset the player back to where they were last frame if they somehow got stuck inside something due to fpu precision. Never change a player's oldorigin field to inside a solid, because that might cause them to become pemanently stuck. */
.vector velocity; /* The direction and speed that the entity is moving in world space. */
.vector angles; /* The eular angles the entity is facing in, in pitch, yaw, roll order. Due to a legacy bug, mdl/iqm/etc formats use +x=UP, bsp/spr/etc formats use +x=DOWN. */
.vector avelocity; /* The amount the entity's angles change by each frame. Note that this is direct eular angles, and thus the angular change is non-linear and often just looks buggy. */
.float pmove_flags;
.string classname; /* Identifies the class/type of the entity. Useful for debugging, also used for loading, but its value is not otherwise significant to the engine, this leaves the mod free to set it to whatever it wants and randomly test strings for values in whatever inefficient way it chooses fit. */
.float renderflags;
.string model; /* The model name that was set via setmodel, in theory. Often, this is cleared to null to prevent the engine from being seen by clients while not changing modelindex. This behaviour allows inline models to remain solid yet be invisible. */
.float frame; /* The current frame the entity is meant to be displayed in. In CSQC, note the lerpfrac and frame2 fields as well. if it specifies a framegroup, the framegroup will autoanimate in ssqc, but not in csqc. */
.float frame1time; /* The absolute time into the animation/framegroup specified by .frame. */
.float frame2; /* The alternative frame. Visible only when lerpfrac is set to 1. */
.float frame2time; /* The absolute time into the animation/framegroup specified by .frame2. */
.float lerpfrac; /* If 0, use frame1 only. If 1, use frame2 only. Mix them together for values between. */
.float skin; /* The skin index to use. on a bsp entity, setting this to 1 will switch to the 'activated' texture instead. A negative value will be understood as a replacement contents value, so setting it to CONTENTS_WATER will make a movable pool of water. */
.float effects; /* Lots of random flags that change random effects. See EF_* constants. */
.vector mins; /* The minimum extent of the model (ie: the bottom-left coordinate relative to the entity's origin). Change via setsize. May also be changed by setmodel. */
.vector maxs; /* like mins, but in the other direction. */
.vector size; /* maxs-mins. Updated when the entity is relinked (by setorigin, setsize, setmodel) */
.void() touch;
.void() think;
.void() blocked;
.float nextthink; /* The time at which the entity is next scheduled to fire its think event. For MOVETYPE_PUSH entities, this is relative to that entity's ltime field, for all other entities it is relative to the time gloal. */
.entity chain;
.entity enemy;
.float flags;
.float colormap;
.entity owner;
void end_sys_fields;
vector input_cursor_screen;
vector input_cursor_trace_start;
vector input_cursor_trace_endpos;
float input_cursor_trace_entnum;
int trace_endcontents;
int trace_surfaceflags;
int trace_brush_id;
int trace_brush_faceid;
int trace_surface_id; /* 1-based. 0 if not known. */
int trace_bone_id; /* 1-based. 0 if not known. typically needs MOVE_HITMODEL. */
int trace_triangle_id; /* 1-based. 0 if not known. */
vector global_gravitydir = '0 0 -1'; /* The direction gravity should act in if not otherwise specified per entity. */
int serverid; /* The unique id of this server within the server cluster. */
.vector punchangle;
.float gravity;
.float hull; /* Overrides the hull used by the entity for walkmove/movetogoal and not traceline/tracebox. */
.entity movechain; /* This is a linked list of entities which will be moved whenever this entity moves, logically they are attached to this entity. */
.void() chainmoved; /* Called when the entity is moved as a result of being part of another entity's .movechain */
.void(float old, float new) contentstransition; /* This function is called when the entity moves between water and air. If specified, default splash sounds will be disabled allowing you to provide your own. */
.float dimension_solid; /* This is the bitmask of dimensions which the entity is solid within. */
.float dimension_hit; /* This is the bitmask of dimensions which the entity will be blocked by. If other.dimension_solid & self.dimension_hit, our traces will impact and not proceed. If its false, the traces will NOT impact, allowing self to pass straight through. */
.int hitcontentsmaski; /* Traces performed for this entity will impact against surfaces that match this contents mask. */
.float scale; /* Multiplier that resizes the entity. 1 is normal sized, 2 is double sized. scale 0 is remapped to 1. In SSQC, this is limited to 1/16th precision, with a maximum just shy of 16. */
.float fatness; /* How many QuakeUnits to push the entity's verticies along their normals by. */
.float alpha; /* The transparency of the entity. 1 means opaque, 0.0001 means virtually invisible. 0 is remapped to 1, for compatibility. */
.float modelflags; /* Used to override the flags set in the entity's model. Should be set according to the MF_ constants. Use effects|=EF_NOMODELFLAGS to ignore the model's flags completely. The traileffectnum field is more versatile. */
.float basebone; /* The base* frame animations are equivelent to their non-base versions, except that they only affect bone numbers below the 'basebone' value. This means that the base* animation can affect the legs of a skeletal model independantly of the normal animation fields affecting the torso area. For more complex animation than this, use skeletal objects. */
.float baseframe; /* See basebone */
.void() customphysics; /* Called once each physics frame, overriding the entity's .movetype field and associated logic. You'll probably want to use tracebox to move it through the world. Be sure to call .think as appropriate. */
.entity tag_entity;
.float tag_index;
.float skeletonindex; /* This object serves as a container for the skeletal bone states used to override the animation data. */
.vector colormod; /* Provides a colour tint for the entity. */
.vector glowmod;
.vector gravitydir; /* Specifies the direction in which gravity acts. Must be normalised. '0 0 0' also means down. Use '0 0 1' if you want the player to be able to run on ceilings. */
.vector(vector org, vector ang) camera_transform; /* Provides portal transform information for portal surfaces attached to this entity. Also used to open up pvs in ssqc. */
.float geomtype;
.float friction;
.float erp;
.float jointtype;
.float mass;
.float bouncefactor;
.float bouncestop;
.float idealpitch;
.float pitch_speed;
.vector color; /* This affects the colour of realtime lights that were enabled via the pflags field. */
.float light_lev; /* This is the radius of an entity's light. This is not normally used by the engine, but is used for realtime lights (ones that are enabled with the pflags field). */
.float style; /* Used by the light util to decide how an entity's light should animate. On an entity with pflags set, this also affects realtime lights. */
.float pflags; /* Realtime lighting flags */
.float frame3; /* Some people just don't understand how to use framegroups... */
.float frame4;
.float lerpfrac3;
.float lerpfrac4;
.float forceshader; /* Contains a shader handle used to replace all surfaces upon the entity. */
.float baseframe2; /* See basebone */
.float baseframe1time; /* See basebone */
.float baseframe2time; /* See basebone */
.float baselerpfrac; /* See basebone */
void(float reqid, float responsecode, string resourcebody) URI_Get_Callback; /* Called as an eventual result of the uri_get builtin. */
void(float apilevel, string enginename, float engineversion) CSQC_Init; /* Called at startup. enginename and engineversion are arbitary hints and can take any form. enginename should be consistant between revisions, but this cannot truely be relied upon. */
void() CSQC_WorldLoaded; /* Called after model+sound precaches have been executed. Gives a chance for the qc to read the entity lump from the bsp. */
void() CSQC_Shutdown; /* Specifies that the csqc is going down. Save your persistant settings here. */
void(float vwidth, float vheight, float notmenu) CSQC_UpdateView; /* Called every single video frame. The CSQC is responsible for rendering the entire screen. */
void(float vwidth, float vheight, float notmenu) CSQC_UpdateViewLoading; /* Alternative to CSQC_UpdateView, called when the engine thinks there should be a loading screen. If present, will inhibit the engine's normal loading screen, deferring to qc to draw it. */
void(string msg) CSQC_Parse_StuffCmd; /* Gives the CSQC a chance to intercept stuffcmds. Use the tokenize builtin to parse the message. Unrecognised commands would normally be localcmded, but its probably better to drop unrecognised stuffcmds completely. */
float(string msg) CSQC_Parse_CenterPrint; /* Gives the CSQC a chance to intercept centerprints. Return true if you wish the engine to otherwise ignore the centerprint. */
float(float save, float take, vector inflictororg) CSQC_Parse_Damage; /* Called as a result of player.dmg_save or player.dmg_take being set on the server.
Return true to completely inhibit the engine's colour shift and damage rolls, allowing you to do your own thing.
You can use punch_roll += (normalize(inflictororg-player.origin)*v_right)*(take+save)*autocvar_v_kickroll; as a modifier for the roll angle should the player be hit from the side, and slowly fade it away over time. */
void(string printmsg, float printlvl) CSQC_Parse_Print; /* Gives the CSQC a chance to intercept sprint/bprint builtin calls. CSQC should filter by the client's current msg setting and then pass the message on to the print command, or handle them itself. */
void() CSQC_Parse_Event; /* Called when the client receives an SVC_CGAMEPACKET. The csqc should read the data or call the error builtin if it does not recognise the message. */
float(float evtype, float scanx, float chary, float devid) CSQC_InputEvent; /* Called whenever a key is pressed, the mouse is moved, etc. evtype will be one of the IE_* constants. The other arguments vary depending on the evtype. Key presses are not guarenteed to have both scan and unichar values set at the same time. */
__used void() CSQC_Input_Frame; /* Called just before each time clientcommandframe is updated. You can edit the input_* globals in order to apply your own player inputs within csqc, which may allow you a convienient way to pass certain info to ssqc. */
void(string rendererdescription) CSQC_RendererRestarted; /* Called by the engine after the video was restarted. This serves to notify the CSQC that any render targets that it may have cached were purged, and will need to be regenerated. */
float(string cmd) CSQC_ConsoleCommand; /* Called if the user uses any console command registed via registercommand. */
float(string text, string info) CSQC_ConsoleLink; /* Called if the user clicks a ^[text\infokey\infovalue^] link. Use infoget to read/check each supported key. Return true if you wish the engine to not attempt to handle the link itself. */
void(float isnew) CSQC_Ent_Update;
void() CSQC_Ent_Remove;
float(float entnum, float channel, string soundname, float vol, float attenuation, vector pos, float pitchmod, float flags) CSQC_Event_Sound;
float(string resname, string restype) CSQC_LoadResource; /* Called each time some resource is being loaded. CSQC can invoke various draw calls to provide a loading screen, until WorldLoaded is called. */
float() CSQC_Parse_TempEntity; /* Please don't use this. Use CSQC_Parse_Event and multicasts instead. */
void(string cmdtext) GameCommand;
void(float prevprogs) init; /* Part of FTE_MULTIPROGS. Called as soon as a progs is loaded, called at a time when entities are not valid. This is the only time when it is safe to call addprogs without field assignment. As it is also called as part of addprogs, this also gives you a chance to hook functions in modules that are already loaded (via externget+externget). */
void() initents; /* Part of FTE_MULTIPROGS. Called after fields have been finalized. This is the first point at which it is safe to call spawn(), and is called before any entity fields have been parsed. You can use this entrypoint to send notifications to other modules. */
__used var float physics_mode = 2; /* 0: original csqc - physics are not run
1: DP-compat. Thinks occur, but not true movetypes.
2: movetypes occur just as they do in ssqc. */
float gamespeed; /* Set by the engine, this is the value of the sv_gamespeed cvar */
float numclientseats; /* This is the number of splitscreen clients currently running on this client. */
var vector drawfontscale = '1 1 0'; /* Specifies a scaler for all text rendering. There are other ways to implement this. */
float drawfont; /* Allows you to choose exactly which font is to be used to draw text. Fonts can be registered/allocated with the loadfont builtin. */
#define FONT_DEFAULT 0
#define TRUE 1
#define FALSE 0 /* File not found... */
#define M_PI 3.14159
#define MOVETYPE_NONE 0
#define MOVETYPE_WALK 3
#define MOVETYPE_STEP 4
#define MOVETYPE_FLY 5
#define MOVETYPE_TOSS 6
#define MOVETYPE_PUSH 7
#define MOVETYPE_NOCLIP 8
#define MOVETYPE_FLYMISSILE 9
#define MOVETYPE_BOUNCE 10
#define MOVETYPE_BOUNCEMISSILE 11
#define MOVETYPE_FOLLOW 12
#define MOVETYPE_6DOF 30 /* A glorified MOVETYPE_FLY. Players using this movetype will get some flightsim-like physics, with fully independant rotations (order-dependant transforms). */
#define MOVETYPE_WALLWALK 31 /* Players using this movetype will be able to orient themselves to walls, and then run up them. */
#define MOVETYPE_PHYSICS 32 /* Enable the use of ODE physics upon this entity. */
#define SOLID_NOT 0
#define SOLID_TRIGGER 1
#define SOLID_BBOX 2
#define SOLID_SLIDEBOX 3
#define SOLID_BSP 4 /* Does not collide against other SOLID_BSP entities. Normally paired with MOVETYPE_PUSH. */
#define SOLID_CORPSE 5 /* Non-solid to SOLID_SLIDEBOX or other SOLID_CORPSE entities. For hitscan weapons to hit corpses, change the player's .solid value to SOLID_BBOX or so, perform the traceline, then revert the player's .solid value. */
#define SOLID_LADDER 20 /* Obsolete and may be removed at some point. Use skin=CONTENT_LADDER and solid_bsp or solid_trigger instead. */
#define SOLID_PORTAL 21 /* CSG subtraction volume combined with entity transformations on impact. */
#define SOLID_PHYSICS_BOX 32
#define SOLID_PHYSICS_SPHERE 33
#define SOLID_PHYSICS_CAPSULE 34
#define SOLID_PHYSICS_TRIMESH 35
#define SOLID_PHYSICS_CYLINDER 36
#define GEOMTYPE_NONE -1
#define GEOMTYPE_SOLID 0
#define GEOMTYPE_BOX 1
#define GEOMTYPE_SPHERE 2
#define GEOMTYPE_CAPSULE 3
#define GEOMTYPE_TRIMESH 4
#define GEOMTYPE_CYLINDER 5
#define GEOMTYPE_CAPSULE_X 6
#define GEOMTYPE_CAPSULE_Y 7
#define GEOMTYPE_CAPSULE_Z 8
#define GEOMTYPE_CYLINDER_X 9
#define GEOMTYPE_CYLINDER_Y 10
#define GEOMTYPE_CYLINDER_Z 11
#define JOINTTYPE_FIXED -1
#define JOINTTYPE_POINT 1
#define JOINTTYPE_HINGE 2
#define JOINTTYPE_SLIDER 3
#define JOINTTYPE_UNIVERSAL 4
#define JOINTTYPE_HINGE2 5
#define GE_MAXENTS -1 /* Valid for getentity, ignores the entity argument. Returns the maximum number of entities which may be valid, to avoid having to poll 65k when only 100 are used. */
#define GE_ACTIVE 0 /* Valid for getentity. Returns whether this entity is known to the client or not. */
#define GE_ORIGIN 1 /* Valid for getentity. Returns the interpolated .origin. */
#define GE_FORWARD 2 /* Valid for getentity. Returns the interpolated forward vector. */
#define GE_RIGHT 3 /* Valid for getentity. Returns the entity's right vector. */
#define GE_UP 4 /* Valid for getentity. Returns the entity's up vector. */
#define GE_SCALE 5 /* Valid for getentity. Returns the entity .scale. */
#define GE_ORIGINANDVECTORS 6 /* Valid for getentity. Returns interpolated .origin, but also sets v_forward, v_right, and v_up accordingly. Use vectoangles(v_forward,v_up) to determine the angles. */
#define GE_ALPHA 7 /* Valid for getentity. Returns the entity alpha. */
#define GE_COLORMOD 8 /* Valid for getentity. Returns the colormod vector. */
#define GE_PANTSCOLOR 9 /* Valid for getentity. Returns the entity's lower color (from .colormap), as a palette range value. */
#define GE_SHIRTCOLOR 10 /* Valid for getentity. Returns the entity's lower color (from .colormap), as a palette range value. */
#define GE_SKIN 11 /* Valid for getentity. Returns the entity's .skin index. */
#define GE_MINS 12 /* Valid for getentity. Guesses the entity's .min vector. */
#define GE_MAXS 13 /* Valid for getentity. Guesses the entity's .max vector. */
#define GE_ABSMIN 14 /* Valid for getentity. Guesses the entity's .absmin vector. */
#define GE_ABSMAX 15 /* Valid for getentity. Guesses the entity's .absmax vector. */
#define GE_MODELINDEX 200 /* Valid for getentity. Guesses the entity's .modelindex float. */
#define GE_MODELINDEX2 201 /* Valid for getentity. Guesses the entity's .vw_index float. */
#define GE_EFFECTS 202 /* Valid for getentity. Guesses the entity's .effects float. */
#define GE_FRAME 203 /* Valid for getentity. Guesses the entity's .frame float. */
#define GE_ANGLES 204 /* Valid for getentity. Guesses the entity's .angles vector. */
#define GE_FATNESS 205 /* Valid for getentity. Guesses the entity's .fatness float. */
#define GE_DRAWFLAGS 206 /* Valid for getentity. Guesses the entity's .drawflags float. */
#define GE_ABSLIGHT 207 /* Valid for getentity. Guesses the entity's .abslight float. */
#define GE_GLOWMOD 208 /* Valid for getentity. Guesses the entity's .glowmod vector. */
#define GE_GLOWSIZE 209 /* Valid for getentity. Guesses the entity's .glowsize float. */
#define GE_GLOWCOLOUR 210 /* Valid for getentity. Guesses the entity's .glowcolor float. */
#define GE_RTSTYLE 211 /* Valid for getentity. Guesses the entity's .style float. */
#define GE_RTPFLAGS 212 /* Valid for getentity. Guesses the entity's .pflags float. */
#define GE_RTCOLOUR 213 /* Valid for getentity. Guesses the entity's .color vector. */
#define GE_RTRADIUS 214 /* Valid for getentity. Guesses the entity's .light_lev float. */
#define GE_TAGENTITY 215 /* Valid for getentity. Guesses the entity's .tag_entity float. */
#define GE_TAGINDEX 216 /* Valid for getentity. Guesses the entity's .tag_index float. */
#define GE_GRAVITYDIR 217 /* Valid for getentity. Guesses the entity's .gravitydir vector. */
#define GE_TRAILEFFECTNUM 218 /* Valid for getentity. Guesses the entity's .traileffectnum float. */
#define CONTENT_EMPTY -1
#define CONTENT_SOLID -2
#define CONTENT_WATER -3
#define CONTENT_SLIME -4
#define CONTENT_LAVA -5
#define CONTENT_SKY -6
#define CONTENT_LADDER -16 /* If this value is assigned to a solid_bsp's .skin field, the entity will become a ladder volume. */
const int CONTENTBIT_NONE = 0x00000000;
const int CONTENTBIT_SOLID = 0x00000001;
const int CONTENTBIT_LAVA = 0x00000008;
const int CONTENTBIT_SLIME = 0x00000010;
const int CONTENTBIT_WATER = 0x00000020;
const int CONTENTBIT_FTELADDER = 0x00004000;
const int CONTENTBIT_PLAYERCLIP = 0x00010000;
const int CONTENTBIT_MONSTERCLIP = 0x00020000;
const int CONTENTBIT_BODY = 0x02000000;
const int CONTENTBIT_CORPSE = 0x04000000;
const int CONTENTBIT_Q2LADDER = 0x20000000; /* Content bit specific to q2bsp */
const int CONTENTBIT_SKY = 0x80000000i;
const int CONTENTBITS_POINTSOLID = CONTENTBIT_SOLID|0x00000002|CONTENTBIT_BODY; /* Bits that traceline would normally consider solid */
const int CONTENTBITS_BOXSOLID = CONTENTBIT_SOLID|0x00000002|CONTENTBIT_BODY|CONTENTBIT_PLAYERCLIP; /* Bits that tracebox would normally consider solid */
const int CONTENTBITS_FLUID = CONTENTBIT_WATER|CONTENTBIT_SLIME|CONTENTBIT_LAVA|CONTENTBIT_SKY;
#define CHAN_AUTO 0 /* The automatic channel, play as many sounds on this channel as you want, and they'll all play, however the other channels will replace each other. */
#define CHAN_WEAPON 1
#define CHAN_VOICE 2
#define CHAN_ITEM 3
#define CHAN_BODY 4
#define SOUNDFLAG_ABSVOLUME 16 /* The sample's volume is not scaled by the volume cvar. Use with caution */
#define SOUNDFLAG_FORCELOOP 2 /* The sound will restart once it reaches the end of the sample. */
#define SOUNDFLAG_NOSPACIALISE 4 /* The different audio channels are played at the same volume regardless of which way the player is facing, without needing to use 0 attenuation. */
#define SOUNDFLAG_NOREVERB 32 /* Disables the use of underwater/reverb effects on this sound effect. */
#define SOUNDFLAG_FOLLOW 64 /* The sound's origin will updated to follow the emitting entity. */
#define ATTN_NONE 0 /* Sounds with this attenuation can be heard throughout the map */
#define ATTN_NORM 1 /* Standard attenuation */
#define ATTN_IDLE 2 /* Extra attenuation so that sounds don't travel too far. */
#define ATTN_STATIC 3 /* Even more attenuation to avoid torches drowing out everything else throughout the map. */
#define INFOKEY_P_PING "ping" /* The player's ping time, in milliseconds. */
#define INFOKEY_P_NAME "name" /* The player's name. */
#define INFOKEY_P_SPECTATOR "*spectator" /* Whether the player is a spectator or not. */
#define INFOKEY_P_TOPCOLOR "topcolor" /* The player's upper/shirt colour (palette index). */
#define INFOKEY_P_BOTTOMCOLOR "bottomcolor" /* The player's lower/pants/trouser colour (palette index). */
#define INFOKEY_P_TOPCOLOR_RGB "topcolor_rgb" /* The player's upper/shirt colour as an rgb value in a format usable with stov. */
#define INFOKEY_P_BOTTOMCOLOR_RGB "bottomcolor_rgb" /* The player's lower/pants/trouser colour as an rgb value in a format usable with stov. */
#define INFOKEY_P_MUTED "ignored" /* 0: we can see the result of the player's say/say_team commands. 1: we see no say/say_team messages from this player. Use the ignore command to toggle this value. */
#define INFOKEY_P_VOIP_MUTED "vignored" /* 0: we can hear this player when they speak (assuming voip is generally enabled). 1: we ignore everything this player says. Use cl_voip_mute to change the values. */
#define INFOKEY_P_ENTERTIME "entertime" /* Reads the timestamp at which the player entered the game, in terms of csqc's time global. */
#define INFOKEY_P_FRAGS "frags" /* Reads a player's frag count. */
#define INFOKEY_P_PACKETLOSS "pl" /* Reads a player's packetloss, as a percentage. */
#define INFOKEY_P_VOIPSPEAKING "voipspeaking" /* Boolean value that says whether the given player is currently sending voice information. */
#define INFOKEY_P_VOIPLOUDNESS "voiploudness" /* Only valid for the local player. Gives a value between 0 and 1 to indicate to the user how loud their mic is. */
#define SERVERKEY_IP "ip" /* The address of the server we connected to. */
#define SERVERKEY_SERVERNAME "servername" /* The hostname that was last passed to the connect command. */
#define SERVERKEY_CONSTATE "constate" /* The current connection state. Will be set to one of: disconnected (menu-only mode), active (gamestate received and loaded), connecting(connecting, downloading, or precaching content, aka: loading screen). */
#define SERVERKEY_TRANSFERRING "transferring" /* Set to the hostname of the server that we are attempting to connect or transfer to. */
#define SERVERKEY_LOADSTATE "loadstate" /* loadstage, loading image name, current step, max steps
Stages are: 1=connecting, 2=serverside, 3=clientside
Key will be empty if we are not loading. */
#define SERVERKEY_PAUSESTATE "pausestate" /* 1 if the server claimed to be paused. 0 otherwise */
#define SERVERKEY_DLSTATE "dlstate" /* The progress of any current downloads. Empty string if no download is active, otherwise a tokenizable string containing this info:
files-remaining, total-size, unknown-sizes-flag, file-localname, file-remotename, file-percent, file-rate, file-received-bytes, file-total-bytes
If the current file info is omitted, then we are waiting for a download to start. */
#define SERVERKEY_PROTOCOL "protocol" /* The protocol we are connected to the server with. */
#define SERVERKEY_MAXPLAYERS "maxplayers" /* The protocol we are connected to the server with. */
#define FL_FLY 1
#define FL_SWIM 2
#define FL_CLIENT 8
#define FL_INWATER 16
#define FL_MONSTER 32
#define FL_ITEM 256
#define FL_ONGROUND 512
#define FL_PARTIALGROUND 1024
#define FL_WATERJUMP 2048
#define FL_JUMPRELEASED 4096
#define FL_FINDABLE_NONSOLID 16384 /* Allows this entity to be found with findradius */
#define MOVE_NORMAL 0
#define MOVE_NOMONSTERS 1 /* The trace will ignore all non-solid_bsp entities. */
#define MOVE_MISSILE 2 /* The trace will use a bbox size of +/- 15 against entities with FL_MONSTER set. */
#define MOVE_HITMODEL 4 /* Traces will impact the actual mesh of the model instead of merely their bounding box. Should generally only be used for tracelines. Note that this flag is unreliable as an object can animate through projectiles. The bounding box MUST be set to completely encompass the entity or those extra areas will be non-solid (leaving a hole for things to go through). */
#define MOVE_TRIGGERS 16 /* This trace type will impact only triggers. It will ignore non-solid entities. */
#define MOVE_EVERYTHING 32 /* This type of trace will hit solids and triggers alike. Even non-solid entities. */
#define MOVE_ENTCHAIN 128 /* Returns a list of entities impacted via the trace_ent.chain field */
#define MOVE_OTHERONLY 256 /* Traces that use this trace type will collide against *only* the entity specified via the 'other' global, and will ignore all owner/solid_not/dimension etc rules, they will still adhere to contents and bsp/bbox rules though. */
#define RESTYPE_MODEL 0 /* RESTYPE_* constants are used as arguments with the resourcestatus builtin. */
#define RESTYPE_SOUND 1 /* precache_sound */
#define RESTYPE_PARTICLE 2 /* particleeffectnum */
#define RESTYPE_PIC 3 /* precache_pic. Status results are an amalgomation of the textures used by the named shader. */
#define RESTYPE_SKIN 4 /* setcustomskin */
#define RESTYPE_TEXTURE 5 /* Individual textures within shaders. These are not directly usable, but may be named as part of a skin file, or a shader. */
#define RESSTATE_NOTKNOWN 0 /* RESSTATE_* constants are return values from the resourcestatus builtin. The engine doesn't know about the resource if it is in this state. This means you will need to precache it. Attempting to use it anyway may result in warnings, errors, or silently succeed, depending on engine version and resource type. */
#define RESSTATE_NOTLOADED 1 /* The resource was precached, but has been flushed and there has not been an attempt to reload it. If you use the resource normally, chances are it'll be loaded but at the cost of a stall. */
#define RESSTATE_LOADING 2 /* Resources in this this state are queued for loading, and will be loaded at the engine's convienience. If you attempt to query the resource now, the engine will stall until the result is available. sounds in this state may be delayed, while models/pics/shaders may be invisible. */
#define RESSTATE_FAILED 3 /* Resources in this state are unusable/could not be loaded. You will get placeholders or dummy results. Queries will not stall the engine. The engine may display placeholder content. */
#define RESSTATE_LOADED 4 /* Resources in this state are finally usable, everything will work okay. Hurrah. Queries will not stall the engine. */
#define EF_BRIGHTFIELD 1
#define EF_MUZZLEFLASH 2
#define EF_BRIGHTLIGHT 4
#define EF_DIMLIGHT 8
#define EF_NODRAW 16
#define EF_ADDITIVE 32 /* The entity will be drawn with an additive blend. */
#define EF_BLUE 64 /* A blue glow */
#define EF_RED 128 /* A red glow */
#define EF_GREEN 262144 /* A green glow */
#define EF_FULLBRIGHT 512 /* This entity will ignore lighting */
#define EF_NOSHADOW 4096 /* This entity will not cast shadows */
#define EF_NODEPTHTEST 8192 /* This entity will be drawn over the top of other things that are closer. */
#define MF_ROCKET 1
#define MF_GRENADE 2
#define MF_GIB 4 /* Regular blood trail */
#define MF_ROTATE 8
#define MF_TRACER 16 /* AKA: green scrag trail */
#define MF_ZOMGIB 32 /* Dark blood trail */
#define MF_TRACER2 64 /* AKA: hellknight projectile trail */
#define MF_TRACER3 128 /* AKA: purple vore trail */
#define PFLAGS_NOSHADOW 1 /* Associated RT lights attached will not cast shadows, making them significantly faster to draw. */
#define PFLAGS_CORONA 2 /* Enables support of coronas on the associated rtlights. */
#define EV_STRING 1
#define EV_FLOAT 2
#define EV_VECTOR 3
#define EV_ENTITY 4
#define EV_FIELD 5
#define EV_FUNCTION 6
#define EV_POINTER 7
#define EV_INTEGER 8
#define EV_VARIANT 9
hashtable gamestate; /* Special hash table index for hash_add and hash_get. Entries in this table will persist over map changes (and doesn't need to be created/deleted). */
#define HASH_REPLACE 256 /* Used with hash_add. Attempts to remove the old value instead of adding two values for a single key. */
#define HASH_ADD 512 /* Used with hash_add. The new entry will be inserted in addition to the existing entry. */
#define STAT_HEALTH 0 /* Player's health. */
#define STAT_WEAPONMODELI 2 /* This is the modelindex of the current viewmodel (renamed from the original name 'STAT_WEAPON' due to confusions). */
#define STAT_AMMO 3 /* player.currentammo */
#define STAT_ARMOR 4
#define STAT_WEAPONFRAME 5
#define STAT_SHELLS 6
#define STAT_NAILS 7
#define STAT_ROCKETS 8
#define STAT_CELLS 9
#define STAT_ACTIVEWEAPON 10 /* player.weapon */
#define STAT_TOTALSECRETS 11
#define STAT_TOTALMONSTERS 12
#define STAT_FOUNDSECRETS 13
#define STAT_KILLEDMONSTERS 14
#define STAT_ITEMS 15 /* self.items | (self.items2<<23). In order to decode this stat properly, you need to use getstatbits(STAT_ITEMS,0,23) to read self.items, and getstatbits(STAT_ITEMS,23,11) to read self.items2 or getstatbits(STAT_ITEMS,28,4) to read the visible part of serverflags, whichever is applicable. */
#define STAT_VIEWHEIGHT 16 /* player.view_ofs_z */
#define STAT_VIEW2 20 /* This stat contains the number of the entity in the server's .view2 field. */
#define STAT_VIEWZOOM 21 /* Scales fov and sensitiity. Part of DP_VIEWZOOM. */
#define STAT_USER 32 /* Custom user stats start here (lower values are reserved for engine use). */
#define VF_MIN 1 /* The top-left of the 3d viewport in screenspace. The VF_ values are used via the setviewprop/getviewprop builtins. */
#define VF_MIN_X 2
#define VF_MIN_Y 3
#define VF_SIZE 4 /* The width+height of the 3d viewport in screenspace. */
#define VF_SIZE_X 5
#define VF_SIZE_Y 6
#define VF_VIEWPORT 7 /* vector+vector. Two argument shortcut for VF_MIN and VF_SIZE */
#define VF_FOV 8 /* sets both fovx and fovy. consider using afov instead. */
#define VF_FOVX 9 /* horizontal field of view. does not consider aspect at all. */
#define VF_FOVY 10 /* vertical field of view. does not consider aspect at all. */
#define VF_ORIGIN 11 /* The origin of the view. Not of the player. */
#define VF_ORIGIN_X 12
#define VF_ORIGIN_Y 13
#define VF_ORIGIN_Z 14
#define VF_ANGLES 15 /* The angles the view will be drawn at. Not the angle the client reports to the server. */
#define VF_ANGLES_X 16
#define VF_ANGLES_Y 17
#define VF_ANGLES_Z 18
#define VF_DRAWWORLD 19 /* boolean. If set to 1, the engine will draw the world and static/persistant rtlights. If 0, the world will be skipped and everything will be fullbright. */
#define VF_DRAWENGINESBAR 20 /* boolean. If set to 1, the sbar will be drawn, and viewsize will be honoured automatically. */
#define VF_DRAWCROSSHAIR 21 /* boolean. If set to 1, the engine will draw its default crosshair. */
#define VF_MINDIST 23 /* The distance of the near clip plane from the view position. Should generally not be <=0, as this would introduce NANs. */
#define VF_MAXDIST 24 /* The distance of the far clip plane from the view position. If 0, will be considered infinite. */
#define VF_CL_VIEWANGLES 33
#define VF_CL_VIEWANGLES_X 34
#define VF_CL_VIEWANGLES_Y 35
#define VF_CL_VIEWANGLES_Z 36
#define VF_PERSPECTIVE 200 /* 1: regular rendering. Fov specifies the angle. 0: isometric-style. Fov specifies the number of Quake Units each side of the viewport, and mindist restrictions are removed, pvs culling should be disabled. */
#define VF_LPLAYER VF_ACTIVESEAT
const float VF_ACTIVESEAT = 202; /* The 'seat' number, used when running splitscreen. */
#define VF_AFOV 203 /* Aproximate fov. Matches the 'fov' cvar. The engine handles the aspect ratio for you. */
#define VF_SCREENVSIZE 204 /* Provides a reliable way to retrieve the current virtual screen size (even if the screen is automatically scaled to retain aspect). */
#define VF_SCREENPSIZE 205 /* Provides a reliable way to retrieve the current physical screen size (cvars need vid_restart for them to take effect). */
#define VF_VIEWENTITY 206 /* Changes the RF_EXTERNALMODEL flag on entities to match the new selection, and removes entities flaged with RF_VIEWENTITY. Requires cunning use of .entnum and typically requires calling addentities(MASK_VIEWMODEL) too. */
#define VF_RT_DESTCOLOUR 212 /* The texture name to write colour info into, this includes both 3d and 2d drawing.
Additional arguments are: format (rgba8=1,rgba16f=2,rgba32f=3), sizexy.
Written to by both 3d and 2d rendering.
Note that any rendertarget textures may be destroyed on video mode changes or so. Shaders can name render targets by prefixing texture names with '$rt:', or $sourcecolour. */
#define VF_RT_SOURCECOLOUR 209 /* The texture name to use with shaders that specify a $sourcecolour map. */
#define VF_RT_DEPTH 210 /* The texture name to use as a depth buffer. Also used for shaders that specify $sourcedepth. 1-based. Additional arguments are: format (16bit=4,24bit=5,32bit=6), sizexy. */
#define VF_RT_RIPPLE 211 /* The texture name to use as a ripplemap (target for shaders with 'sort ripple'). Also used for shaders that specify $ripplemap. 1-based. Additional arguments are: format, sizexy. */
#define VF_ENVMAP 220 /* The cubemap name to use as a fallback for $reflectcube, if a shader was unable to load one. Note that this doesn't automatically change shader permutations or anything. */
#define RF_VIEWMODEL 1 /* Specifies that the entity is a view model, and that its origin is relative to the current view position. These entities are also subject to viewweapon bob. */
#define RF_EXTERNALMODEL 2 /* Specifies that this entity should be displayed in mirrors (and may still cast shadows), but will not otherwise be visible. */
#define RF_DEPTHHACK 4 /* Hacks the depth values such that the entity uses depth values as if it were closer to the screen. This is useful when combined with viewmodels to avoid weapons poking in to walls. */
#define RF_ADDITIVE 8 /* Shaders from this entity will temporarily be hacked to use an additive blend mode instead of their normal blend mode. */
#define RF_USEAXIS 16 /* The entity will be oriented according to the current v_forward+v_right+v_up vector values instead of the entity's .angles field. */
#define RF_NOSHADOW 32 /* This entity will not cast shadows. Often useful on view models. */
#define RF_FRAMETIMESARESTARTTIMES 64 /* Specifies that the frame1time, frame2time field are timestamps (denoting the start of the animation) rather than time into the animation. */
#define IE_KEYDOWN 0 /* Specifies that a key was pressed. Second argument is the scan code. Third argument is the unicode (printable) char value. Fourth argument denotes which keyboard(or mouse, if its a mouse 'scan' key) the event came from. Note that some systems may completely separate scan codes and unicode values, with a 0 value for the unspecified argument. */
#define IE_KEYUP 1 /* Specifies that a key was released. Arguments are the same as IE_KEYDOWN. On some systems, this may be fired instantly after IE_KEYDOWN was fired. */
#define IE_MOUSEDELTA 2 /* Specifies that a mouse was moved (touch screens and tablets typically give IE_MOUSEABS events instead, use _windowed_mouse 0 to test code to cope with either). Second argument is the X displacement, third argument is the Y displacement. Fourth argument is which mouse or touch event triggered the event. */
#define IE_MOUSEABS 3 /* Specifies that a mouse cursor or touch event was moved to a specific location relative to the virtual screen space. Second argument is the new X position, third argument is the new Y position. Fourth argument is which mouse or touch event triggered the event. */
#define IE_ACCELEROMETER 4
#define IE_FOCUS 5 /* Specifies that input focus was given. parama says mouse focus, paramb says keyboard focus. If either are -1, then it is unchanged. */
#define IE_JOYAXIS 6 /* Specifies that what value a joystick/controller axis currently specifies. x=axis, y=value. Will be called multiple times, once for each axis of each active controller. */
#define IE_GYROSCOPE 7
#define FILE_READ 0 /* The file may be read via fgets to read a single line at a time. */
#define FILE_APPEND 1 /* Like FILE_WRITE, but writing starts at the end of the file. */
#define FILE_WRITE 2 /* fputs will be used to write to the file. */
#define FILE_READNL 4 /* Like FILE_READ, except newlines are not special. fgets reads the entire file into a tempstring. */
#define FILE_MMAP_READ 5 /* The file will be loaded into memory. fgets returns a pointer to the first byte (and will always return the same value for this file). Cast this to your datatype. */
#define FILE_MMAP_RW 6 /* Like FILE_MMAP_READ, except any changes to the data will be written back to disk once the file is closed. */
#define MASK_ENGINE 1 /* Valid as an argument for addentities. If specified, all non-csqc entities will be added to the scene. */
#define MASK_VIEWMODEL 2 /* Valid as an argument for addentities. If specified, the regular engine viewmodel will be added to the scene. */
#define PREDRAW_AUTOADD 0 /* Valid as a return value from the predraw function. Returning this will cause the engine to automatically invoke addentity(self) for you. */
#define PREDRAW_NEXT 1 /* Valid as a return value from the predraw function. Returning this will simply move on to the next entity without the autoadd behaviour, so can be used for particle/invisible/special entites, or entities that were explicitly drawn with addentity. */
#define LFIELD_ORIGIN 0
#define LFIELD_COLOUR 1
#define LFIELD_RADIUS 2
#define LFIELD_FLAGS 3
#define LFIELD_STYLE 4
#define LFIELD_ANGLES 5
#define LFIELD_FOV 6
#define LFIELD_CORONA 7
#define LFIELD_CORONASCALE 8
#define LFIELD_CUBEMAPNAME 9
#define LFIELD_AMBIENTSCALE 10
#define LFIELD_DIFFUSESCALE 11
#define LFIELD_SPECULARSCALE 12
#define LFIELD_ROTATION 13
#define LFIELD_DIETIME 14
#define LFIELD_RGBDECAY 15
#define LFIELD_RADIUSDECAY 16
#define LFLAG_NORMALMODE 1
#define LFLAG_REALTIMEMODE 2
#define LFLAG_LIGHTMAP 4
#define LFLAG_FLASHBLEND 8
#define LFLAG_NOSHADOWS 256
#define LFLAG_SHADOWMAP 512
#define LFLAG_CREPUSCULAR 1024
#define TEREDIT_RELOAD 0
#define TEREDIT_SAVE 1
#define TEREDIT_SETHOLE 2
#define TEREDIT_HEIGHT_SET 3
#define TEREDIT_HEIGHT_SMOOTH 4
#define TEREDIT_HEIGHT_SPREAD 5
#define TEREDIT_HEIGHT_RAISE 6
#define TEREDIT_HEIGHT_FLATTEN 18
#define TEREDIT_HEIGHT_LOWER 7
#define TEREDIT_TEX_KILL 8
#define TEREDIT_TEX_GET 9
#define TEREDIT_TEX_BLEND 10
#define TEREDIT_TEX_UNIFY 11
#define TEREDIT_TEX_NOISE 12
#define TEREDIT_TEX_BLUR 13
#define TEREDIT_TEX_REPLACE 19
#define TEREDIT_TEX_SETMASK 25
#define TEREDIT_WATER_SET 14
#define TEREDIT_MESH_ADD 15
#define TEREDIT_MESH_KILL 16
#define TEREDIT_TINT 17
#define TEREDIT_RESET_SECT 20
#define TEREDIT_RELOAD_SECT 21
#define TEREDIT_ENTS_WIPE 22
#define TEREDIT_ENTS_CONCAT 23
#define TEREDIT_ENTS_GET 24
#define SLIST_HOSTCACHEVIEWCOUNT 0
#define SLIST_HOSTCACHETOTALCOUNT 1
#define SLIST_MASTERQUERYCOUNT 2
#define SLIST_MASTERREPLYCOUNT 3
#define SLIST_SERVERQUERYCOUNT 4
#define SLIST_SERVERREPLYCOUNT 5
#define SLIST_SORTFIELD 6
#define SLIST_SORTDESCENDING 7
#define SLIST_TEST_CONTAINS 0
#define SLIST_TEST_NOTCONTAIN 1
#define SLIST_TEST_LESSEQUAL 2
#define SLIST_TEST_LESS 3
#define SLIST_TEST_EQUAL 4
#define SLIST_TEST_GREATER 5
#define SLIST_TEST_GREATEREQUAL 6
#define SLIST_TEST_NOTEQUAL 7
#define SLIST_TEST_STARTSWITH 8
#define SLIST_TEST_NOTSTARTSWITH 9
void(vector vang) makevectors = #1; /*
Takes an angle vector (pitch,yaw,roll) (+x=DOWN). Writes its results into v_forward, v_right, v_up vectors. */
void(entity e, vector o) setorigin = #2; /*
Changes e's origin to be equal to o. Also relinks collision state (as well as setting absmin+absmax), which is required after changing .solid */
void(entity e, string m) setmodel = #3; /*
Looks up m in the model precache list, and sets both e.model and e.modelindex to match. BSP models will set e.mins and e.maxs accordingly, other models depend upon the value of sv_gameplayfix_setmodelrealbox - for compatibility you should always call setsize after all pickups or non-bsp models. Also relinks collision state. */
void(entity e, vector min, vector max) setsize = #4; /*
Sets the e's mins and maxs fields. Also relinks collision state, which sets absmin and absmax too. */
float() random = #7; /*
Returns a random value between 0 and 1. Be warned, this builtin can return 1 in most engines, which can break arrays. */
void(entity e, float chan, string samp, float vol, float atten, optional float speedpct, optional float flags, optional float timeofs) sound = #8; /*
Starts a sound centered upon the given entity.
chan is the entity sound channel to use, channel 0 will allow you to mix many samples at once, others will replace the old sample
'samp' must have been precached first
if specified, 'speedpct' should normally be around 100 (or =0), 200 for double speed or 50 for half speed.
If flags is specified, the reliable flag in the channels argument is used for additional channels. Flags should be made from SOUNDFLAG_* constants
timeofs should be negative in order to provide a delay before the sound actually starts. */
vector(vector v) normalize = #9; /*
Shorten or lengthen a direction vector such that it is only one quake unit long. */
void(string e) error = #10; /*
Ends the game with an easily readable error message. */
void(string e) objerror = #11; /*
Displays a non-fatal easily readable error message concerning the self entity, including a field dump. self will be removed! */
float(vector v) vlen = #12; /*
Returns the square root of the dotproduct of a vector with itself. Or in other words the length of a distance vector, in quake units. */
float(vector v, optional entity reference) vectoyaw = #13; /*
Given a direction vector, returns the yaw angle in which that direction vector points. If an entity is passed, the yaw angle will be relative to that entity's gravity direction. */
entity() spawn = #14; /*
Adds a brand new entity into the world! Hurrah, you're now a parent! */
void(entity e) remove = #15; /*
Destroys the given entity and clears some limited fields (including model, modelindex, solid, classname). Any references to the entity following the call are an error. After two seconds, the entity will be reused, in the interim you can unfortunatly still read its fields to see if the reference is no longer valid. */
void(vector v1, vector v2, float flags, entity ent) traceline = #16; /*
Traces an infinitely thin line through the world from v1 towards v2.
Will not collide with ent, ent.owner, or any entity who's owner field refers to ent.
The passed entity will also be used to determine whether to use a capsule trace, the contents that the trace should impact, and a couple of other extra fields that define the trace.
There are no side effects beyond the trace_* globals being written.
flags&MOVE_NOMONSTERS will not impact on non-bsp entities.
flags&MOVE_MISSILE will impact with increased size.
flags&MOVE_HITMODEL will impact upon model meshes, instead of their bounding boxes.
flags&MOVE_TRIGGERS will also stop on triggers
flags&MOVE_EVERYTHING will stop if it hits anything, even non-solid entities.
flags&MOVE_LAGGED will backdate entity positions for the purposes of this builtin according to the indicated player ent's latency, to provide lag compensation. */
entity(entity start, .string fld, string match) find = #18; /*
Scan for the next entity with a given field set to the given 'match' value. start should be either world, or the previous entity that was found. Returns world on failure/if there are no more. */
string(string s) precache_sound = #19; /*
Precaches a sound, making it known to clients and loading it from disk. This builtin (strongly) should be called during spawn functions. This builtin must be called for the sound before the sound builtin is called, or it might not even be heard. */
string(string s) precache_model = #20; /*
Precaches a model, making it known to clients and loading it from disk if it has a .bsp extension. This builtin (strongly) should be called during spawn functions. This must be called for each model name before setmodel may use that model name.
Modelindicies precached in SSQC will always be positive. CSQC precaches will be negative if they are not also on the server. */
entity(vector org, float rad) findradius = #22; /*
Finds all entities within a distance of the 'org' specified. One entity is returned directly, while other entities are returned via that entity's .chain field. */
void(string s, ...) dprint = #25; /*
NQ: Prints the given message on the server's console, but only if the developer cvar is set. Arguments will be concatenated into a single message. */
void(string s, ...) dprint = #25; /*
QW: Unconditionally prints the given message on the server's console. Arguments will be concatenated into a single message. */
string(float val) ftos = #26; /*
Returns a tempstring containing a representation of the given float. Precision depends upon engine. */
string(vector val) vtos = #27; /*
Returns a tempstring containing a representation of the given vector. Precision depends upon engine. */
void() coredump = #28; /*
Writes out a coredump. This contains stack, globals, and field info for all ents. This can be handy for debugging. */
void() traceon = #29; /*
Enables tracing. This may be spammy, slow, and stuff. Set debugger 1 in order to use fte's qc debugger. */
void() traceoff = #30; /*
Disables tracing again. */
void(entity e) eprint = #31; /*
Debugging builtin that prints all fields of the given entity to the console. */
float(float yaw, float dist, optional float settraceglobals) walkmove = #32; /*
Attempt to walk the entity at a given angle for a given distance.
if settraceglobals is set, the trace_* globals will be set, showing the results of the movement.
This function will trigger touch events. */
float() droptofloor = #34; /*
Instantly moves the entity downwards until it hits the ground. If the entity is in solid or would need to drop more than 'pr_droptofloorunits' quake units, its position will be considered invalid and the builtin will abort, returning FALSE, otherwise TRUE. */
void(float lightstyle, string stylestring, optional vector rgb) lightstyle = #35; /*
Specifies an auto-animating string that specifies the light intensity for entities using that lightstyle.
a is off, z is fully lit. Should be lower case only.
rgb will recolour all lights using that lightstyle. */
float(float) rint = #36; /*
Rounds the given float up or down to the closest integeral value. X.5 rounds away from 0 */
float(float) floor = #37; /*
Rounds the given float downwards, even when negative. */
float(float) ceil = #38; /*
Rounds the given float upwards, even when negative. */
float(entity ent) checkbottom = #40; /*
Expensive checks to ensure that the entity is actually sitting on something solid, returns true if it is. */
float(vector pos) pointcontents = #41; /*
Checks the given point to see what is there. Returns one of the SOLID_* constants. Just because a spot is empty does not mean that the player can stand there due to the size of the player - use tracebox for such tests. */
float(float) fabs = #43; /*
Removes the sign of the float, making it positive if it is negative. */
float(string) cvar = #45; /*
Returns the numeric value of the named cvar */
void(string, ...) localcmd = #46; /*
Adds the string to the console command queue. Commands will not be executed immediately, but rather at the start of the following frame. */
entity(entity) nextent = #47; /*
Returns the following entity. Skips over removed entities. Returns world when passed the last valid entity. */
void(vector pos, vector dir, float colour, float count) particle = #48; /*
Spawn 'count' particles around 'pos' moving in the direction 'dir', with a palette colour index between 'colour' and 'colour+8'. */
#define ChangeYaw changeyaw
void() changeyaw = #49; /*
Changes the self.angles_y field towards self.ideal_yaw by up to self.yaw_speed. */
vector(vector fwd, optional vector up) vectoangles = #51; /*
Returns the angles (+x=UP) required to orient an entity to look in the given direction. The 'up' argument is required if you wish to set a roll angle, otherwise it will be limited to just monster-style turning. */
float(float angle) sin = #60; /* Part of DP_QC_SINCOSSQRTPOW
Forgive me father, for I have trigonometry homework. */
float(float angle) cos = #61; /* Part of DP_QC_SINCOSSQRTPOW*/
float(float value) sqrt = #62; /* Part of DP_QC_SINCOSSQRTPOW*/
void(entity ent) changepitch = #63; /* Part of DP_QC_CHANGEPITCH*/
void(entity ent, entity ignore) tracetoss = #64;
string(entity ent) etos = #65; /* Part of DP_QC_ETOS*/
void(float step) movetogoal = #67; /*
Runs lots and lots of fancy logic in order to try to step the entity the specified distance towards its goalentity. */
string(string s) precache_file = #68; /*
This builtin does nothing. It was used only as a hint for pak generation. */
void(entity e) makestatic = #69; /*
Sends a copy of the entity's renderable fields to all clients, and REMOVES the entity, preventing further changes. This means it will be unmutable and non-solid. */
void(string cvarname, string valuetoset) cvar_set = #72; /*
Instantly sets a cvar to the given string value. */
void (vector pos, string samp, float vol, float atten) ambientsound = #74;
string(string str) precache_model2 = #75;
string(string str) precache_sound2 = #76;
string(string str) precache_file2 = #77;
float(string) stof = #81; /* Part of FRIK_FILE, FTE_STRINGS, QW_ENGINE, ZQ_QC_STRINGS*/
void(vector start, vector mins, vector maxs, vector end, float nomonsters, entity ent) tracebox = #90; /* Part of DP_QC_TRACEBOX
Exactly like traceline, but a box instead of a uselessly thin point. Acceptable sizes are limited by bsp format, q1bsp has strict acceptable size values. */
vector() randomvec = #91; /* Part of DP_QC_RANDOMVEC
Returns a vector with random values. Each axis is independantly a value between -1 and 1 inclusive. */
vector(vector org) getlight = #92;
float(string cvarname, string defaultvalue) registercvar = #93; /* Part of DP_REGISTERCVAR
Creates a new cvar on the fly. If it does not already exist, it will be given the specified value. If it does exist, this is a no-op.
This builtin has the limitation that it does not apply to configs or commandlines. Such configs will need to use the set or seta command causing this builtin to be a noop.
In engines that support it, you will generally find the autocvar feature easier and more efficient to use. */
float(float a, float b, ...) min = #94; /* Part of DP_QC_MINMAXBOUND
Returns the lowest value of its arguments. */
float(float a, float b, ...) max = #95; /* Part of DP_QC_MINMAXBOUND
Returns the highest value of its arguments. */
float(float minimum, float val, float maximum) bound = #96; /* Part of DP_QC_MINMAXBOUND
Returns val, unless minimum is higher, or maximum is less. */
float(float value, float exp) pow = #97; /* Part of DP_QC_SINCOSSQRTPOW*/
float(float v, optional float base) logarithm = #0:logarithm; /*
Determines the logarithm of the input value according to the specified base. This can be used to calculate how much something was shifted by. */
#define findentity findfloat
entity(entity start, .__variant fld, __variant match) findfloat = #98; /* Part of DP_QC_FINDFLOAT
Equivelent to the find builtin, but instead of comparing strings contents, this builtin compares the raw values. This builtin requires multiple calls in order to scan all entities - set start to the previous call's return value.
world is returned when there are no more entities. */
float(string extname) checkextension = #99; /*
Checks for an extension by its name (eg: checkextension("FRIK_FILE") says that its okay to go ahead and use strcat).
Use cvar("pr_checkextension") to see if this builtin exists. */
float(__variant funcref) checkbuiltin = #0:checkbuiltin; /*
Checks to see if the specified builtin is supported/mapped. This is intended as a way to check for #0 functions, allowing for simple single-builtin functions. */
float(float value) anglemod = #102;
filestream(string filename, float mode, optional float mmapminsize) fopen = #110; /* Part of FRIK_FILE
Opens a file, typically prefixed with "data/", for either read or write access. */
void(filestream fhandle) fclose = #111; /* Part of FRIK_FILE*/
string(filestream fhandle) fgets = #112; /* Part of FRIK_FILE
Reads a single line out of the file. The new line character is not returned as part of the string. Returns the null string on EOF (use if not(string) to easily test for this, which distinguishes it from the empty string which is returned if the line being read is blank */
void(filestream fhandle, string s, optional string s2, optional string s3, optional string s4, optional string s5, optional string s6, optional string s7) fputs = #113; /* Part of FRIK_FILE
Writes the given string(s) into the file. For compatibility with fgets, you should ensure that the string is terminated with a \n - this will not otherwise be done for you. It is up to the engine whether dos or unix line endings are actually written. */
int(filestream fhandle, void *ptr, int size) fread = #0:fread; /*
Reads binary data out of the file. Returns truncated lengths if the read exceeds the length of the file. */
int(filestream fhandle, void *ptr, int size) fwrite = #0:fwrite; /*
Writes binary data out of the file. */
#define ftell fseek //c compat
int(filestream fhandle, optional int newoffset) fseek = #0:fseek; /*
Changes the current position of the file, if specified. Returns prior position, in bytes. */
int(filestream fhandle, optional int newsize) fsize = #0:fsize; /*
Reports the total size of the file, in bytes. Can also be used to truncate/extend the file */
float(string s) strlen = #114; /* Part of FRIK_FILE, FTE_STRINGS, ZQ_QC_STRINGS*/
string(string s1, optional string s2, optional string s3, optional string s4, optional string s5, optional string s6, optional string s7, optional string s8) strcat = #115; /* Part of FRIK_FILE, FTE_STRINGS, ZQ_QC_STRINGS*/
string(string s, float start, float length) substring = #116; /* Part of FRIK_FILE, FTE_STRINGS, ZQ_QC_STRINGS*/
vector(string s) stov = #117; /* Part of FRIK_FILE, FTE_STRINGS, ZQ_QC_STRINGS*/
string(string s, ...) strzone = #118; /* Part of FRIK_FILE, FTE_STRINGS, ZQ_QC_STRINGS
Create a semi-permanent copy of a string that only becomes invalid once strunzone is called on the string (instead of when the engine assumes your string has left scope). This builtin has become redundant in FTEQW due to the FTE_QC_PERSISTENTTEMPSTRINGS extension and is now functionally identical to strcat for compatibility with old engines+mods. */
void(string s) strunzone = #119; /* Part of FRIK_FILE, FTE_STRINGS, ZQ_QC_STRINGS
Destroys a string that was allocated by strunzone. Further references to the string MAY crash the game. In FTE, this function became redundant and now does nothing. */
void(string soundname, optional float channel, optional float volume) localsound = #177; /*
Plays a sound... locally... probably best not to call this from ssqc. Also disables reverb. */
float(string modelname, optional float queryonly) getmodelindex = #200; /*
Acts as an alternative to precache_model(foo);setmodel(bar, foo); return bar.modelindex;
If queryonly is set and the model was not previously precached, the builtin will return 0 without needlessly precaching the model. */
__variant(float prnum, string funcname, ...) externcall = #201; /* Part of FTE_MULTIPROGS
Directly call a function in a different/same progs by its name.
prnum=0 is the 'default' or 'main' progs.
prnum=-1 means current progs.
prnum=-2 will scan through the active progs and will use the first it finds. */
float(string progsname) addprogs = #202; /* Part of FTE_MULTIPROGS
Loads an additional .dat file into the current qcvm. The returned handle can be used with any of the externcall/externset/externvalue builtins.
There are cvars that allow progs to be loaded automatically. */
__variant(float prnum, string varname) externvalue = #203; /* Part of FTE_MULTIPROGS
Reads a global in the named progs by the name of that global.
prnum=0 is the 'default' or 'main' progs.
prnum=-1 means current progs.
prnum=-2 will scan through the active progs and will use the first it finds. */
void(float prnum, __variant newval, string varname) externset = #204; /* Part of FTE_MULTIPROGS
Sets a global in the named progs by name.
prnum=0 is the 'default' or 'main' progs.
prnum=-1 means current progs.
prnum=-2 will scan through the active progs and will use the first it finds. */
void(entity portal, float state) openportal = #207; /*
Opens or closes the portals associated with a door or some such on q2 or q3 maps. On Q2BSPs, the entity should be the 'func_areaportal' entity - its style field will say which portal to open. On Q3BSPs, the entity is the door itself, the portal will be determined by the two areas found from a preceding setorigin call. */
void(optional __variant ret) abort = #211; /* Part of FTE_MULTITHREADED
QC execution is aborted. Parent QC functions on the stack will be skipped, effectively this forces all QC functions to 'return ret' until execution returns to the engine. If ret is ommited, it is assumed to be 0. */
void(vector org, vector dmin, vector dmax, float colour, float effect, float count) particle2 = #215; /* Part of FTE_HEXEN2*/
void(vector org, vector box, float colour, float effect, float count) particle3 = #216; /* Part of FTE_HEXEN2*/
void(vector org, float radius, float colour, float effect, float count) particle4 = #217; /* Part of FTE_HEXEN2*/
float(float number, float quantity) bitshift = #218; /* Part of EXT_BITSHIFT*/
void(vector pos) te_lightningblood = #219; /* Part of FTE_TE_STANDARDEFFECTBUILTINS*/
float(string s1, string sub, optional float startidx) strstrofs = #221; /* Part of FTE_STRINGS
Returns the 0-based offset of sub within the s1 string, or -1 if sub is not in s1.
If startidx is set, this builtin will ignore matches before that 0-based offset. */
float(string str, float index) str2chr = #222; /* Part of FTE_STRINGS
Retrieves the character value at offset 'index'. */
string(float chr, ...) chr2str = #223; /* Part of FTE_STRINGS
The input floats are considered character values, and are concatenated. */
string(float ccase, float redalpha, float redchars, string str, ...) strconv = #224; /* Part of FTE_STRINGS
Converts quake chars in the input string amongst different representations.
ccase specifies the new case for letters.
0: not changed.
1: forced to lower case.
2: forced to upper case.
redalpha and redchars switch between colour ranges.
0: no change.
1: Forced white.
2: Forced red.
3: Forced gold(low) (numbers only).
4: Forced gold (high) (numbers only).
5+6: Forced to white and red alternately.
You should not use this builtin in combination with UTF-8. */
string(float pad, string str1, ...) strpad = #225; /* Part of FTE_STRINGS
Pads the string with spaces, to ensure its a specific length (so long as a fixed-width font is used, anyway). If pad is negative, the spaces are added on the left. If positive the padding is on the right. */
string(infostring old, string key, string value) infoadd = #226; /* Part of FTE_STRINGS
Returns a new tempstring infostring with the named value changed (or added if it was previously unspecified). Key and value may not contain the \ character. */
string(infostring info, string key) infoget = #227; /* Part of FTE_STRINGS
Reads a named value from an infostring. The returned value is a tempstring */
#define strcmp strncmp
float(string s1, string s2, optional float len, optional float s1ofs, optional float s2ofs) strncmp = #228; /* Part of FTE_STRINGS
Compares up to 'len' chars in the two strings. s1ofs allows you to treat s2 as a substring to compare against, or should be 0.
Returns 0 if the two strings are equal, a negative value if s1 appears numerically lower, and positive if s1 appears numerically higher. */
float(string s1, string s2) strcasecmp = #229; /* Part of FTE_STRINGS
Compares the two strings without case sensitivity.
Returns 0 if they are equal. The sign of the return value may be significant, but should not be depended upon. */
float(string s1, string s2, float len, optional float s1ofs, optional float s2ofs) strncasecmp = #230; /* Part of FTE_STRINGS
Compares up to 'len' chars in the two strings without case sensitivity. s1ofs allows you to treat s2 as a substring to compare against, or should be 0.
Returns 0 if they are equal. The sign of the return value may be significant, but should not be depended upon. */
string(string s) strtrim = #0:strtrim; /*
Trims the whitespace from the start+end of the string. */
void() calltimeofday = #231; /* Part of FTE_CALLTIMEOFDAY
Asks the engine to instantly call the qc's 'timeofday' function, before returning. For compatibility with mvdsv.
timeofday should have the prototype: void(float secs, float mins, float hour, float day, float mon, float year, string strvalue)
The strftime builtin is more versatile and less weird. */
void(vector angle) rotatevectorsbyangle = #235;
void(vector fwd, vector right, vector up) rotatevectorsbyvectors = #236;
float(float mdlindex, string skinname) skinforname = #237;
float(string shadername, optional string defaultshader, ...) shaderforname = #238; /* Part of FTE_FORCESHADER
Caches the named shader and returns a handle to it.
If the shader could not be loaded from disk (missing file or ruleset_allow_shaders 0), it will be created from the 'defaultshader' string if specified, or a 'skin shader' default will be used.
defaultshader if not empty should include the outer {} that you would ordinarily find in a shader. */
void(vector org, optional float count) te_bloodqw = #239; /* Part of FTE_TE_STANDARDEFFECTBUILTINS*/
float(vector viewpos, entity entity) checkpvs = #240; /* Part of FTE_QC_CHECKPVS*/
vector(entity ent, float tagnum) rotatevectorsbytag = #244;
int(string) stoi = #259; /* Part of FTE_QC_INTCONV
Converts the given string into a true integer. Base 8, 10, or 16 is determined based upon the format of the string. */
string(int) itos = #260; /* Part of FTE_QC_INTCONV
Converts the passed true integer into a base10 string. */
int(string) stoh = #261; /* Part of FTE_QC_INTCONV
Reads a base-16 string (with or without 0x prefix) as an integer. Bugs out if given a base 8 or base 10 string. :P */
string(int) htos = #262; /* Part of FTE_QC_INTCONV
Formats an integer as a base16 string, with leading 0s and no prefix. Always returns 8 characters. */
int(float) ftoi = #0:ftoi; /*
Converts the given float into a true integer without depending on extended qcvm instructions. */
float(int) itof = #0:itof; /*
Converts the given true integer into a float without depending on extended qcvm instructions. */
float(float modlindex, optional float useabstransforms) skel_create = #263; /* Part of FTE_CSQC_SKELETONOBJECTS
Allocates a new uninitiaised skeletal object, with enough bone info to animate the given model.
eg: self.skeletonobject = skel_create(self.modelindex); */
float(float skel, entity ent, float modelindex, float retainfrac, float firstbone, float lastbone, optional float addfrac) skel_build = #264; /* Part of FTE_CSQC_SKELETONOBJECTS
Animation data (according to the entity's frame info) is pulled from the specified model and blended into the specified skeletal object.
If retainfrac is set to 0 on the first call and 1 on the others, you can blend multiple animations together according to the addfrac value. The final weight should be 1. Other values will result in scaling and/or other weirdness. You can use firstbone and lastbone to update only part of the skeletal object, to allow legs to animate separately from torso, use 0 for both arguments to specify all, as bones are 1-based. */
float(float skel) skel_get_numbones = #265; /* Part of FTE_CSQC_SKELETONOBJECTS
Retrives the number of bones in the model. The valid range is 1<=bone<=numbones. */
string(float skel, float bonenum) skel_get_bonename = #266; /* Part of FTE_CSQC_SKELETONOBJECTS
Retrieves the name of the specified bone. Mostly only for debugging. */
float(float skel, float bonenum) skel_get_boneparent = #267; /* Part of FTE_CSQC_SKELETONOBJECTS
Retrieves which bone this bone's position is relative to. Bone 0 refers to the entity's position rather than an actual bone */
float(float skel, string tagname) skel_find_bone = #268; /* Part of FTE_CSQC_SKELETONOBJECTS
Finds a bone by its name, from the model that was used to create the skeletal object. */
vector(float skel, float bonenum) skel_get_bonerel = #269; /* Part of FTE_CSQC_SKELETONOBJECTS
Gets the bone position and orientation relative to the bone's parent. Return value is the offset, and v_forward, v_right, v_up contain the orientation. */
vector(float skel, float bonenum) skel_get_boneabs = #270; /* Part of FTE_CSQC_SKELETONOBJECTS
Gets the bone position and orientation relative to the entity. Return value is the offset, and v_forward, v_right, v_up contain the orientation.
Use gettaginfo for world coord+orientation. */
void(float skel, float bonenum, vector org, optional vector fwd, optional vector right, optional vector up) skel_set_bone = #271; /* Part of FTE_CSQC_SKELETONOBJECTS
Sets a bone position relative to its parent. If the orientation arguments are not specified, v_forward+v_right+v_up are used instead. */
void(float skel, float bonenum, vector org, optional vector fwd, optional vector right, optional vector up) skel_mul_bone = #272; /* Part of FTE_CSQC_SKELETONOBJECTS
Transforms a single bone by a matrix. You can use makevectors to generate a rotation matrix from an angle. */
void(float skel, float startbone, float endbone, vector org, optional vector fwd, optional vector right, optional vector up) skel_mul_bones = #273; /* Part of FTE_CSQC_SKELETONOBJECTS
Transforms an entire consecutive range of bones by a matrix. You can use makevectors to generate a rotation matrix from an angle, but you'll probably want to divide the angle by the number of bones. */
void(float skeldst, float skelsrc, float startbone, float entbone) skel_copybones = #274; /* Part of FTE_CSQC_SKELETONOBJECTS
Copy bone data from one skeleton directly into another. */
void(float skel) skel_delete = #275; /* Part of FTE_CSQC_SKELETONOBJECTS
Deletes a skeletal object. The actual delete is delayed, allowing the skeletal object to be deleted in an entity's predraw function yet still be valid by the time the addentity+renderscene builtins need it. Also uninstanciates any ragdoll currently in effect on the skeletal object. */
float(float modidx, string framename) frameforname = #276; /* Part of FTE_CSQC_SKELETONOBJECTS
Looks up a framegroup from a model by name, avoiding the need for hardcoding. Returns -1 on error. */
float(float modidx, float framenum) frameduration = #277; /* Part of FTE_CSQC_SKELETONOBJECTS
Retrieves the duration (in seconds) of the specified framegroup. */
#define dotproduct(v1,v2) ((vector)(v1)*(vector)(v2))
vector(vector v1, vector v2) crossproduct = #0:crossproduct; /*
Small helper function to calculate the crossproduct of two vectors. */
void(float action, optional vector pos, optional float radius, optional float quant, ...) terrain_edit = #278; /*
Realtime terrain editing. Actions are the TEREDIT_ constants. */
typedef struct
{
string shadername;
vector planenormal;
float planedist;
vector sdir;
float sbias;
vector tdir;
float tbias;
} brushface_t;
int(float modelidx, int brushid, brushface_t *out_faces, int maxfaces, int *out_contents) brush_get = #0:brush_get; /*
Queries a brush's information. You must pre-allocate the face array for the builtin to write to. Return value is the number of faces retrieved, 0 on error. */
int(float modelidx, brushface_t *in_faces, int numfaces, int contents, optional int brushid) brush_create = #0:brush_create; /*
Inserts a new brush into the model. Return value is the new brush's id. */
void(float modelidx, int brushid) brush_delete = #0:brush_delete; /*
Destroys the specified brush. */
float(float modelid, int brushid, int faceid, float selectedstate) brush_selected = #0:brush_selected; /*
Allows you to easily set transient visual properties of a brush. returns old value. selectedstate=-1 changes nothing (called for its return value). */
int(float modelid, int brushid, int faceid, vector *points, int maxpoints) brush_getfacepoints = #0:brush_getfacepoints; /*
Returns the list of verticies surrounding the given face. If face is 0, returns the center of the brush (if space for 1 point) or the mins+maxs (if space for 2 points). */
int(int faceid, brushface_t *in_faces, int numfaces, vector *points, int maxpoints) brush_calcfacepoints = #0:brush_calcfacepoints; /*
Determines the points of the specified face, if the specified brush were to actually be created. */
int(float modelid, vector *planes, float *dists, int numplanes, int *out_brushes, int *out_faces, int maxresults) brush_findinvolume = #0:brush_findinvolume; /*
Allows you to easily obtain a list of brushes+faces within the given bounding region. If out_faces is not null, the same brush might be listed twice. */
void(optional entity ent, optional vector neworigin) touchtriggers = #279; /*
Triggers a touch events between self and every SOLID_TRIGGER entity that it is in contact with. This should typically just be the triggers touch functions. Also optionally updates the origin of the moved entity. */
float(entity skelent, string dollcmd, float animskel) skel_ragupdate = #281; /*
Updates the skeletal object attached to the entity according to its origin and other properties.
if animskel is non-zero, the ragdoll will animate towards the bone state in the animskel skeletal object, otherwise they will pick up the model's base pose which may not give nice results.
If dollcmd is not set, the ragdoll will update (this should be done each frame).
If the doll is updated without having a valid doll, the model's default .doll will be instanciated.
commands:
doll foo.doll : sets up the entity to use the named doll file
dollstring TEXT : uses the doll file directly embedded within qc, with that extra prefix.
cleardoll : uninstanciates the doll without destroying the skeletal object.
animate 0.5 : specifies the strength of the ragdoll as a whole
animatebody somebody 0.5 : specifies the strength of the ragdoll on a specific body (0 will disable ragdoll animations on that body).
enablejoint somejoint 1 : enables (or disables) a joint. Disabling joints will allow the doll to shatter. */
float*(float skel) skel_mmap = #282; /*
Map the bones in VM memory. They can then be accessed via pointers. Each bone is 12 floats, the four vectors interleaved (sadly). */
void(entity ent, float bonenum, vector org, optional vector angorfwd, optional vector right, optional vector up) skel_set_bone_world = #283; /*
Sets the world position of a bone within the given entity's attached skeletal object. The world position is dependant upon the owning entity's position. If no orientation argument is specified, v_forward+v_right+v_up are used for the orientation instead. If 1 is specified, it is understood as angles. If 3 are specified, they are the forawrd/right/up vectors to use. */
string(float modidx, float framenum) frametoname = #284;
string(float modidx, float skin) skintoname = #285;
float(float resourcetype, float tryload, string resourcename) resourcestatus = #286; /*
resourcetype must be one of the RESTYPE_ constants. Returns one of the RESSTATE_ constants. Tryload 0 is a query only. Tryload 1 will attempt to reload the content if it was flushed. */
hashtable(float tabsize, optional float defaulttype) hash_createtab = #287; /* Part of FTE_QC_HASHTABLES
Creates a hash table object with at least 'tabsize' slots. hash table with index 0 is a game-persistant table and will NEVER be returned by this builtin (except as an error return). */
void(hashtable table) hash_destroytab = #288; /* Part of FTE_QC_HASHTABLES
Destroys a hash table object. */
void(hashtable table, string name, __variant value, optional float typeandflags) hash_add = #289; /* Part of FTE_QC_HASHTABLES
Adds the given key with the given value to the table.
If flags&HASH_REPLACE, the old value will be removed, if not set then multiple values may be added for a single key, they won't overwrite.
The type argument describes how the value should be stored and saved to files. While you can claim that all variables are just vectors, being more precise can result in less issues with tempstrings or saved games. */
__variant(hashtable table, string name, optional __variant deflt, optional float requiretype, optional float index) hash_get = #290; /* Part of FTE_QC_HASHTABLES
looks up the specified key name in the hash table. returns deflt if key was not found. If stringsonly=1, the return value will be in the form of a tempstring, otherwise it'll be the original value argument exactly as it was. If requiretype is specified, then values not of the specified type will be ignored. Hurrah for multiple types with the same name. */
__variant(hashtable table, string name) hash_delete = #291; /* Part of FTE_QC_HASHTABLES
removes the named key. returns the value of the object that was destroyed, or 0 on error. */
string(hashtable table, float idx) hash_getkey = #292; /* Part of FTE_QC_HASHTABLES
gets some random key name. add+delete can change return values of this, so don't blindly increment the key index if you're removing all. */
float(string name) checkcommand = #294; /* Part of FTE_QC_CHECKCOMMAND
Checks to see if the supplied name is a valid command, cvar, or alias. Returns 0 if it does not exist. */
string(string s) argescape = #295; /*
Marks up a string so that it can be reliably tokenized as a single argument later. */
void() clearscene = #300; /*
Forgets all rentities, polygons, and temporary dlights. Resets all view properties to their default values. */
void(float mask) addentities = #301; /*
Walks through all entities effectively doing this:
if (ent.drawmask&mask){ if (!ent.predaw()) addentity(ent); }
If mask&MASK_DELTA, non-csqc entities, particles, and related effects will also be added to the rentity list.
If mask&MASK_STDVIEWMODEL then the default view model will also be added. */
void(entity ent) addentity = #302; /*
Copies the entity fields into a new rentity for later rendering via addscene. */
void(string texturename, float flags, void *verts, int *indexes, int numindexes) addtrisoup_1 = #0:addtrisoup_1; /*
Adds the specified trisoup into the scene as additional geometry. This permits caching geometry to reduce builtin spam. Indexes are a triangle list (so eg quads will need 6 indicies to form two triangles). NOTE: this is not going to be a speedup over polygons if you're still generating lots of new data every frame. */
#define setviewprop setproperty
float(float property, ...) setproperty = #303; /*
Allows you to override default view properties like viewport, fov, and whether the engine hud will be drawn. Different VF_ values have slightly different arguments, some are vectors, some floats. */
void() renderscene = #304; /*
Draws all entities, polygons, and particles on the rentity list (which were added via addentities or addentity), using the various view properties set via setproperty. There is no ordering dependancy.
The scene must generally be cleared again before more entities are added, as entities will persist even over to the next frame.
You may call this builtin multiple times per frame, but should only be called from CSQC_UpdateView. */
float(vector org, float radius, vector lightcolours, optional float style, optional string cubemapname, optional float pflags) dynamiclight_add = #305; /*
Adds a temporary dlight, ready to be drawn via addscene. Cubemap orientation will be read from v_forward/v_right/v_up. */
void(string texturename, optional float flags, optional float is2d) R_BeginPolygon = #306; /*
Specifies the shader to use for the following polygons, along with optional flags.
If is2d, the polygon will be drawn as soon as the EndPolygon call is made, rather than waiting for renderscene. This allows complex 2d effects. */
void(vector org, vector texcoords, vector rgb, float alpha) R_PolygonVertex = #307; /*
Specifies a polygon vertex with its various properties. */
void() R_EndPolygon = #308; /*
Ends the current polygon. At least 3 verticies must have been specified. You do not need to call beginpolygon if you wish to draw another polygon with the same shader. */
#define getviewprop getproperty
__variant(float property) getproperty = #309; /*
Retrieve a currently-set (typically view) property, allowing you to read the current viewport or other things. Due to cheat protection, certain values may be unretrievable. */
vector (vector v) unproject = #310; /*
Transform a 2d screen-space point (with depth) into a 3d world-space point, according the various origin+angle+fov etc settings set via setproperty. */
vector (vector v) project = #311; /*
Transform a 3d world-space point into a 2d screen-space point, according the various origin+angle+fov etc settings set via setproperty. */
void(vector pos, vector size, float alignflags, string text) drawtextfield = #0:drawtextfield; /*
Draws a multi-line block of text, including word wrapping and alignment. alignflags bits are RTLB, typically 3. */
void(float width, vector pos1, vector pos2, vector rgb, float alpha, optional float drawflag) drawline = #315; /*
Draws a 2d line between the two 2d points. */
float(string name) iscachedpic = #316; /*
Checks to see if the image is currently loaded. Engines might lie, or cache between maps. */
string(string name, optional float trywad) precache_pic = #317; /*
Forces the engine to load the named image. If trywad is specified, the specified name must any lack path and extension. */
void(string imagename, int width, int height, int *pixeldata) r_uploadimage = #0:r_uploadimage; /*
Updates a texture with the specified rgba data. Will be created if needed. */
int*(string filename, __out int width, __out int height) r_readimage = #0:r_readimage; /*
Reads and decodes an image from disk, providing raw pixel data. Returns __NULL__ if the image could not be read for any reason. Use memfree to free the data once you're done with it. */
#define draw_getimagesize drawgetimagesize
vector(string picname) drawgetimagesize = #318; /*
Returns the dimensions of the named image. Images specified with .lmp should give the original .lmp's dimensions even if texture replacements use a different resolution. */
void(string name) freepic = #319; /*
Tells the engine that the image is no longer needed. The image will appear to be new the next time its needed. */
float(vector position, float character, vector size, vector rgb, float alpha, optional float drawflag) drawcharacter = #320; /*
Draw the given quake character at the given position.
If flag&4, the function will consider the char to be a unicode char instead (or display as a ? if outside the 32-127 range).
size should normally be something like '8 8 0'.
rgb should normally be '1 1 1'
alpha normally 1.
Software engines may assume the named defaults.
Note that ALL text may be rescaled on the X axis due to variable width fonts. The X axis may even be ignored completely. */
float(vector position, string text, vector size, vector rgb, float alpha, optional float drawflag) drawrawstring = #321; /*
Draws the specified string without using any markup at all, even in engines that support it.
If UTF-8 is globally enabled in the engine, then that encoding is used (without additional markup), otherwise it is raw quake chars.
Software engines may assume a size of '8 8 0', rgb='1 1 1', alpha=1, flag&3=0, but it is not an error to draw out of the screen. */
float(vector position, string pic, vector size, vector rgb, float alpha, optional float drawflag) drawpic = #322; /*
Draws an shader within the given 2d screen box. Software engines may omit support for rgb+alpha, but must support rescaling, and must clip to the screen without crashing. */
float(vector position, vector size, vector rgb, float alpha, optional float drawflag) drawfill = #323; /*
Draws a solid block over the given 2d box, with given colour, alpha, and blend mode (specified via flags).
flags&3=0 simple blend.
flags&3=1 additive blend */
void(float x, float y, float width, float height) drawsetcliparea = #324; /*
Specifies a 2d clipping region (aka: scissor test). 2d draw calls will all be clipped to this 2d box, the area outside will not be modified by any 2d draw call (even 2d polygons). */
void(void) drawresetcliparea = #325; /*
Reverts the scissor/clip area to the whole screen. */
float(vector position, string text, vector size, vector rgb, float alpha, float drawflag) drawstring = #326; /*
Draws a string, interpreting markup and recolouring as appropriate. */
float(string text, float usecolours, optional vector fontsize) stringwidth = #327; /*
Calculates the width of the screen in virtual pixels. If usecolours is 1, markup that does not affect the string width will be ignored. Will always be decoded as UTF-8 if UTF-8 is globally enabled.
If the char size is not specified, '8 8 0' will be assumed. */
void(vector pos, vector sz, string pic, vector srcpos, vector srcsz, vector rgb, float alpha, optional float drawflag) drawsubpic = #328; /*
Draws a rescaled subsection of an image to the screen. */
void(vector pivot, vector mins, vector maxs, string pic, vector rgb, float alpha, float angle) drawrotpic = #0:drawrotpic; /*
Draws an image rotating at the pivot. To rotate in the center, use mins+maxs of half the size with mins negated. Angle is in degrees. */
void(vector pivot, vector mins, vector maxs, string pic, vector txmin, vector txsize, vector rgb, vector alphaandangles) drawrotsubpic = #0:drawrotsubpic; /*
Overcomplicated draw function for over complicated people. Positions follow drawrotpic, while texture coords follow drawsubpic. Due to argument count limitations in builtins, the alpha value and angles are combined into separate fields of a vector (tip: use fteqcc's [alpha, angle] feature. */
float(float stnum) getstati = #330; /*
Retrieves the numerical value of the given EV_INTEGER or EV_ENTITY stat (converted to a float). */
#define getstatbits getstatf
float(float stnum, optional float firstbit, optional float bitcount) getstatf = #331; /*
Retrieves the numerical value of the given EV_FLOAT stat. If firstbit and bitcount are specified, retrieves the upper bits of the STAT_ITEMS stat. */
string(float stnum) getstats = #332; /*
Retrieves the value of the given EV_STRING stat, as a tempstring.
Older engines may use 4 consecutive integer stats, with a limit of 15 chars (yes, really. 15.), but FTE QuakeWorld uses a separate namespace for string stats and has a much higher length limit. */
__variant(float playernum, float statnum, float stattype) getplayerstat = #0:getplayerstat; /*
Retrieves a specific player's stat, matching the type specified on the server. This builtin is primarily intended for mvd playback where ALL players are known. For EV_ENTITY, world will be returned if the entity is not in the pvs, use type-punning with EV_INTEGER to get the entity number if you just want to see if its set. STAT_ITEMS should be queried as an EV_INTEGER on account of runes and items2 being packed into the upper bits. */
void(entity e, float mdlindex) setmodelindex = #333; /*
Sets a model by precache index instead of by name. Otherwise identical to setmodel. */
string(float mdlindex) modelnameforindex = #334; /*
Retrieves the name of the model based upon a precache index. This can be used to reduce csqc network traffic by enabling model matching. */
float(string effectname) particleeffectnum = #335; /* Part of DP_ENT_TRAILEFFECTNUM, FTE_SV_POINTPARTICLES
Precaches the named particle effect. If your effect name is of the form 'foo.bar' then particles/foo.cfg will be loaded by the client if foo.bar was not already defined.
Different engines will have different particle systems, this specifies the QC API only. */
void(float effectnum, entity ent, vector start, vector end) trailparticles = #336; /* Part of FTE_SV_POINTPARTICLES
Draws the given effect between the two named points. If ent is not world, distances will be cached in the entity in order to avoid framerate dependancies. The entity is not otherwise used. */
void(float effectnum, vector origin, optional vector dir, optional float count) pointparticles = #337; /* Part of FTE_SV_POINTPARTICLES
Spawn a load of particles from the given effect at the given point traveling or aiming along the direction specified. The number of particles are scaled by the count argument. */
void(string s, ...) cprint = #338; /*
Print into the center of the screen just as ssqc's centerprint would appear. */
void(string s, ...) print = #339; /*
Unconditionally print on the local system's console, even in ssqc (doesn't care about the value of the developer cvar). */
string(float keynum) keynumtostring = #340; /*
Returns a hunam-readable name for the given keycode, as a tempstring. */
float(string keyname) stringtokeynum = #341; /*
Looks up the key name in the same way that the bind command would, returning the keycode for that key. */
string(float keynum) getkeybind = #342; /*
Returns the current binding for the given key (returning only the command executed when no modifiers are pressed). */
void(float usecursor, optional string cursorimage, optional vector hotspot, optional float scale) setcursormode = #343; /*
Pass TRUE if you want the engine to release the mouse cursor (absolute input events + touchscreen mode). Pass FALSE if you want the engine to grab the cursor (relative input events + standard looking). If the image name is specified, the engine will use that image for a cursor (use an empty string to clear it again), in a way that will not conflict with the console. Images specified this way will be hardware accelerated, if supported by the platform/port. */
float(float effective) getcursormode = #0:getcursormode; /*
Reports the cursor mode this module previously attempted to use. If 'effective' is true, reports the cursor mode currently active (if was overriden by a different module which has precidence, for instance, or if there is only a touchscreen and no mouse). */
vector() getmousepos = #344; /*
Nasty convoluted DP extension. Typically returns deltas instead of positions. Use CSQC_InputEvent for such things in csqc mods. */
float(float inputsequencenum) getinputstate = #345; /*
Looks up an input frame from the log, setting the input_* globals accordingly.
The sequence number range used for prediction should normally be servercommandframe < sequence <= clientcommandframe.
The sequence equal to clientcommandframe will change between input frames. */
void(float sens) setsensitivityscaler = #346; /*
Temporarily scales the player's mouse sensitivity based upon something like zoom, avoiding potential cvar saving and thus corruption. */
void(entity ent) runstandardplayerphysics = #347; /*
Perform the engine's standard player movement prediction upon the given entity using the input_* globals to describe movement. */
string(float playernum, string keyname) getplayerkeyvalue = #348; /*
Look up a player's userinfo, to discover things like their name, topcolor, bottomcolor, skin, team, *ver.
Also includes scoreboard info like frags, ping, pl, userid, entertime, as well as voipspeaking and voiploudness. */
float() isdemo = #349; /*
Returns if the client is currently playing a demo or not */
float() isserver = #350; /*
Returns if the client is acting as the server (aka: listen server) */
void(vector origin, vector forward, vector right, vector up, optional float reverbtype) SetListener = #351; /*
Sets the position of the view, as far as the audio subsystem is concerned. This should be called once per CSQC_UpdateView as it will otherwise revert to default. For reverbtype, see setup_reverb or treat as 'underwater'. */
typedef struct {
float flDensity;
float flDiffusion;
float flGain;
float flGainHF;
float flGainLF;
float flDecayTime;
float flDecayHFRatio;
float flDecayLFRatio;
float flReflectionsGain;
float flReflectionsDelay;
vector flReflectionsPan;
float flLateReverbGain;
float flLateReverbDelay;
vector flLateReverbPan;
float flEchoTime;
float flEchoDepth;
float flModulationTime;
float flModulationDepth;
float flAirAbsorptionGainHF;
float flHFReference;
float flLFReference;
float flRoomRolloffFactor;
int iDecayHFLimit;
} reverbinfo_t;
void(float reverbslot, reverbinfo_t *reverbinfo, int sizeofreverinfo_t) setup_reverb = #0:setup_reverb; /*
Reconfigures a reverb slot for weird effects. Slot 0 is reserved for no effects. Slot 1 is reserved for underwater effects. Reserved slots will be reinitialised on snd_restart, but can otherwise be changed. These reverb slots can be activated with SetListener. Note that reverb will currently only work when using OpenAL. */
void(string cmdname) registercommand = #352; /*
Register the given console command, for easy console use.
Console commands that are later used will invoke CSQC_ConsoleCommand. */
float(entity ent) wasfreed = #353; /*
Quickly check to see if the entity is currently free. This function is only valid during the two-second non-reuse window, after that it may give bad results. Try one second to make it more robust. */
string(string key) serverkey = #354; /*
Look up a key in the server's public serverinfo string */
string(optional string resetstring) getentitytoken = #355; /*
Grab the next token in the map's entity lump.
If resetstring is not specified, the next token will be returned with no other sideeffects.
If empty, will reset from the map before returning the first token, probably {.
If not empty, will tokenize from that string instead.
Always returns tempstrings. */
float(string s) findfont = #356; /*
Looks up a named font slot. Matches the actual font name as a last resort. */
float(string fontname, string fontmaps, string sizes, float slot, optional float fix_scale, optional float fix_voffset) loadfont = #357; /*
too convoluted for me to even try to explain correct usage. Try drawfont = loadfont("", "cour", "16", -1, 0, 0); to switch to the courier font (optimised for 16 virtual pixels high), if you have the freetype2 library in windows.. */
void(string evname, string evargs, ...) sendevent = #359; /*
Invoke Cmd_evname_evargs in ssqc. evargs must be a string of initials refering to the types of the arguments to pass. v=vector, e=entity(.entnum field is sent), f=float, i=int. 6 arguments max - you can get more if you pack your floats into vectors. */
float() readbyte = #360;
float() readchar = #361;
float() readshort = #362;
float() readlong = #363;
float() readcoord = #364;
float() readangle = #365;
string() readstring = #366;
float() readfloat = #367;
float() readentitynum = #368;
float(string modelname, float(float isnew) updatecallback, float flags) deltalisten = #371; /*
Specifies a per-modelindex callback to listen for engine-networking entity updates. Such entities are automatically interpolated by the engine (unless flags specifies not to).
The various standard entity fields will be overwritten each frame before the updatecallback function is called. */
__variant(float lno, float fld) dynamiclight_get = #372; /*
Retrieves a property from the given dynamic/rt light. Return type depends upon the light field requested. */
void(float lno, float fld, __variant value) dynamiclight_set = #373; /*
Changes a property on the given dynamic/rt light. Value type depends upon the light field to be changed. */
string(float efnum, float body) particleeffectquery = #374; /*
Retrieves either the name or the body of the effect with the given number. The effect body is regenerated from internal state, and can be changed before being reapplied via the localcmd builtin. */
void(string shadername, vector origin, vector up, vector side, vector rgb, float alpha) adddecal = #375; /*
Adds a temporary clipped decal shader to the scene, centered at the given point with given orientation. Will be drawn by the next renderscene call, and freed by the next clearscene call. */
void(entity e, string skinfilename, optional string skindata) setcustomskin = #376; /*
Sets an entity's skin overrides. These are custom per-entity surface->shader lookups. The skinfilename/data should be in .skin format:
surfacename,shadername - makes the named surface use the named shader
replace "surfacename" "shadername" - same.
qwskin "foo" - use an unmodified quakeworld player skin (including crop+repalette rules)
q1lower 0xff0000 - specify an override for the entity's lower colour, in this case to red
q1upper 0x0000ff - specify an override for the entity's lower colour, in this case to blue
compose "surfacename" "shader" "imagename@x,y:w,h$s,t,s2,t2?r,g,b,a" - compose a skin texture from multiple images.
The texture is determined to be sufficient to hold the first named image, additional images can be named as extra tokens on the same line.
Use a + at the end of the line to continue reading image tokens from the next line also, the named shader must use 'map $diffuse' to read the composed texture (compatible with the defaultskin shader). */
__variant*(int size) memalloc = #384; /* Part of FTE_MEMALLOC
Allocate an arbitary block of memory */
void(__variant *ptr) memfree = #385; /* Part of FTE_MEMALLOC
Frees a block of memory that was allocated with memfree */
void(__variant *dst, __variant *src, int size) memcpy = #386; /* Part of FTE_MEMALLOC
Copys memory from one location to another */
void(__variant *dst, int val, int size) memfill8 = #387; /* Part of FTE_MEMALLOC
Sets an entire block of memory to a specified value. Pretty much always 0. */
__variant(__variant *dst, float ofs) memgetval = #388; /*
Looks up the 32bit value stored at a pointer-with-offset. */
void(__variant *dst, float ofs, __variant val) memsetval = #389; /*
Changes the 32bit value stored at the specified pointer-with-offset. */
__variant*(__variant *base, float ofs) memptradd = #390; /*
Perform some pointer maths. Woo. */
float(string s) memstrsize = #0:memstrsize; /*
strlen, except ignores utf-8 */
string(string conname, string field, optional string newvalue) con_getset = #391; /* Part of FTE_CSQC_ALTCONSOLES
Reads or sets a property from a console object. The old value is returned. Iterrate through consoles with the 'next' field. Valid properties: title, name, next, unseen, markup, forceutf8, close, clear, hidden, linecount */
void(string conname, string messagefmt, ...) con_printf = #392; /* Part of FTE_CSQC_ALTCONSOLES
Prints onto a named console. */
void(string conname, vector pos, vector size, float fontsize) con_draw = #393; /* Part of FTE_CSQC_ALTCONSOLES
Draws the named console. */
float(string conname, float inevtype, float parama, float paramb, float paramc) con_input = #394; /* Part of FTE_CSQC_ALTCONSOLES
Forwards input events to the named console. Mouse updates should be absolute only. */
void(string newcaption) setwindowcaption = #0:setwindowcaption; /*
Replaces the title of the game window, as seen when task switching or just running in windowed mode. */
float() cvars_haveunsaved = #0:cvars_haveunsaved; /*
Returns true if any archived cvar has an unsaved value. */
float(entity e, float nowreadonly) entityprotection = #0:entityprotection; /*
Changes the protection on the specified entity to protect it from further edits from QC. The return value is the previous setting. Note that this can be used to unprotect the world, but doing so long term is not advised as you will no longer be able to detect invalid entity references. Also, world is not networked, so results might not be seen by clients (or in other words, world.avelocity_y=64 is a bad idea). */
entity(entity from, optional entity to) copyentity = #400; /* Part of DP_QC_COPYENTITY
Copies all fields from one entity to another. */
entity(.string field, string match) findchain = #402; /* Part of DP_QC_FINDCHAIN*/
entity(.float fld, float match) findchainfloat = #403; /* Part of DP_QC_FINDCHAINFLOAT*/
void(vector org, string modelname, float startframe, float endframe, float framerate) effect = #404; /* Part of DP_SV_EFFECT
Spawns a self-animating sprite */
void(vector org, vector dir, float count) te_blood = #405; /* Part of DP_TE_BLOOD*/
void(vector mincorner, vector maxcorner, float explosionspeed, float howmany) te_bloodshower = #406; /* Part of _DP_TE_BLOODSHOWER*/
void(vector org, vector color) te_explosionrgb = #407; /* Part of DP_TE_EXPLOSIONRGB*/
void(vector mincorner, vector maxcorner, vector vel, float howmany, float color, float gravityflag, float randomveljitter) te_particlecube = #408; /* Part of DP_TE_PARTICLECUBE*/
void(vector mincorner, vector maxcorner, vector vel, float howmany, float color) te_particlerain = #409; /* Part of _DP_TE_PARTICLERAIN*/
void(vector mincorner, vector maxcorner, vector vel, float howmany, float color) te_particlesnow = #410; /* Part of _DP_TE_PARTICLESNOW*/
void(vector org, vector vel, float howmany) te_spark = #411; /* Part of DP_TE_SPARK*/
void(vector org) te_gunshotquad = #412; /* Part of _DP_TE_QUADEFFECTS1*/
void(vector org) te_spikequad = #413; /* Part of _DP_TE_QUADEFFECTS1*/
void(vector org) te_superspikequad = #414; /* Part of _DP_TE_QUADEFFECTS1*/
void(vector org) te_explosionquad = #415; /* Part of _DP_TE_QUADEFFECTS1*/
void(vector org) te_smallflash = #416; /* Part of DP_TE_SMALLFLASH*/
void(vector org, float radius, float lifetime, vector color) te_customflash = #417; /* Part of DP_TE_CUSTOMFLASH*/
void(vector org, optional float count) te_gunshot = #418; /* Part of DP_TE_STANDARDEFFECTBUILTINS, FTE_TE_STANDARDEFFECTBUILTINS*/
void(vector org) te_spike = #419; /* Part of DP_TE_STANDARDEFFECTBUILTINS, FTE_TE_STANDARDEFFECTBUILTINS*/
void(vector org) te_superspike = #420; /* Part of DP_TE_STANDARDEFFECTBUILTINS, FTE_TE_STANDARDEFFECTBUILTINS*/
void(vector org) te_explosion = #421; /* Part of DP_TE_STANDARDEFFECTBUILTINS, FTE_TE_STANDARDEFFECTBUILTINS*/
void(vector org) te_tarexplosion = #422; /* Part of DP_TE_STANDARDEFFECTBUILTINS, FTE_TE_STANDARDEFFECTBUILTINS*/
void(vector org) te_wizspike = #423; /* Part of DP_TE_STANDARDEFFECTBUILTINS, FTE_TE_STANDARDEFFECTBUILTINS*/
void(vector org) te_knightspike = #424; /* Part of DP_TE_STANDARDEFFECTBUILTINS, FTE_TE_STANDARDEFFECTBUILTINS*/
void(vector org) te_lavasplash = #425; /* Part of DP_TE_STANDARDEFFECTBUILTINS, FTE_TE_STANDARDEFFECTBUILTINS*/
void(vector org) te_teleport = #426; /* Part of DP_TE_STANDARDEFFECTBUILTINS, FTE_TE_STANDARDEFFECTBUILTINS*/
void(vector org, float color, float colorlength) te_explosion2 = #427; /* Part of DP_TE_STANDARDEFFECTBUILTINS*/
void(entity own, vector start, vector end) te_lightning1 = #428; /* Part of DP_TE_STANDARDEFFECTBUILTINS, FTE_TE_STANDARDEFFECTBUILTINS*/
void(entity own, vector start, vector end) te_lightning2 = #429; /* Part of DP_TE_STANDARDEFFECTBUILTINS, FTE_TE_STANDARDEFFECTBUILTINS*/
void(entity own, vector start, vector end) te_lightning3 = #430; /* Part of DP_TE_STANDARDEFFECTBUILTINS, FTE_TE_STANDARDEFFECTBUILTINS*/
void(entity own, vector start, vector end) te_beam = #431; /* Part of DP_TE_STANDARDEFFECTBUILTINS*/
void(vector dir) vectorvectors = #432; /* Part of DP_QC_VECTORVECTORS*/
void(vector org) te_plasmaburn = #433; /* Part of _DP_TE_PLASMABURN*/
float(entity e, float s) getsurfacenumpoints = #434; /* Part of DP_QC_GETSURFACE*/
vector(entity e, float s, float n) getsurfacepoint = #435; /* Part of DP_QC_GETSURFACE*/
vector(entity e, float s) getsurfacenormal = #436; /* Part of DP_QC_GETSURFACE*/
string(entity e, float s) getsurfacetexture = #437; /* Part of DP_QC_GETSURFACE*/
float(entity e, vector p) getsurfacenearpoint = #438; /* Part of DP_QC_GETSURFACE*/
vector(entity e, float s, vector p) getsurfaceclippedpoint = #439; /* Part of DP_QC_GETSURFACE*/
float(string s) tokenize = #441; /* Part of KRIMZON_SV_PARSECLIENTCOMMAND*/
string(float n) argv = #442; /* Part of KRIMZON_SV_PARSECLIENTCOMMAND*/
void(entity e, entity tagentity, string tagname) setattachment = #443; /* Part of DP_GFX_QUAKE3MODELTAGS*/
searchhandle(string pattern, float caseinsensitive, float quiet) search_begin = #444; /* Part of DP_QC_FS_SEARCH
initiate a filesystem scan based upon filenames. Be sure to call search_end on the returned handle. */
void(searchhandle handle) search_end = #445; /* Part of DP_QC_FS_SEARCH*/
float(searchhandle handle) search_getsize = #446; /* Part of DP_QC_FS_SEARCH
Retrieves the number of files that were found. */
string(searchhandle handle, float num) search_getfilename = #447; /* Part of DP_QC_FS_SEARCH
Retrieves name of one of the files that was found by the initial search. */
float(searchhandle handle, float num) search_getfilesize = #0:search_getfilesize; /*
Retrieves the size of one of the files that was found by the initial search. */
string(searchhandle handle, float num) search_getfilemtime = #0:search_getfilemtime; /*
Retrieves modification time of one of the files. */
string(string cvarname) cvar_string = #448; /* Part of DP_QC_CVAR_STRING*/
entity(entity start, .float fld, float match) findflags = #449; /* Part of DP_QC_FINDFLAGS*/
entity(.float fld, float match) findchainflags = #450; /* Part of DP_QC_FINDCHAINFLAGS*/
float(entity ent, string tagname) gettagindex = #451; /* Part of DP_MD3_TAGSINFO*/
vector(entity ent, float tagindex) gettaginfo = #452; /* Part of DP_MD3_TAGSINFO
Obtains the current worldspace position+orientation of the bone or tag from the given entity. The return value is the world coord, v_forward, v_right, v_up are also set according to the bone/tag's orientation. */
void(vector org, vector vel, float howmany) te_flamejet = #457; /* Part of _DP_TE_FLAMEJET*/
entity(float entnum) edict_num = #459; /* Part of DP_QC_EDICT_NUM*/
strbuf() buf_create = #460; /* Part of DP_QC_STRINGBUFFERS*/
void(strbuf bufhandle) buf_del = #461; /* Part of DP_QC_STRINGBUFFERS*/
float(strbuf bufhandle) buf_getsize = #462; /* Part of DP_QC_STRINGBUFFERS*/
void(strbuf bufhandle_from, strbuf bufhandle_to) buf_copy = #463; /* Part of DP_QC_STRINGBUFFERS*/
void(strbuf bufhandle, float sortprefixlen, float backward) buf_sort = #464; /* Part of DP_QC_STRINGBUFFERS*/
string(strbuf bufhandle, string glue) buf_implode = #465; /* Part of DP_QC_STRINGBUFFERS*/
string(strbuf bufhandle, float string_index) bufstr_get = #466; /* Part of DP_QC_STRINGBUFFERS*/
void(strbuf bufhandle, float string_index, string str) bufstr_set = #467; /* Part of DP_QC_STRINGBUFFERS*/
float(strbuf bufhandle, string str, float order) bufstr_add = #468; /* Part of DP_QC_STRINGBUFFERS*/
void(strbuf bufhandle, float string_index) bufstr_free = #469; /* Part of DP_QC_STRINGBUFFERS*/
float(float s) asin = #471; /* Part of DP_QC_ASINACOSATANATAN2TAN*/
float(float c) acos = #472; /* Part of DP_QC_ASINACOSATANATAN2TAN*/
float(float t) atan = #473; /* Part of DP_QC_ASINACOSATANATAN2TAN*/
float(float c, float s) atan2 = #474; /* Part of DP_QC_ASINACOSATANATAN2TAN*/
float(float a) tan = #475; /* Part of DP_QC_ASINACOSATANATAN2TAN
Forgive me father, for I have a sunbed and I'm not afraid to use it. */
float(string s) strlennocol = #476; /* Part of DP_QC_STRINGCOLORFUNCTIONS
Returns the number of characters in the string after any colour codes or other markup has been parsed. */
string(string s) strdecolorize = #477; /* Part of DP_QC_STRINGCOLORFUNCTIONS
Flattens any markup/colours, removing them from the string. */
string(float uselocaltime, string format, ...) strftime = #478; /* Part of DP_QC_STRFTIME*/
float(string s, string separator1, ...) tokenizebyseparator = #479; /* Part of DP_QC_TOKENIZEBYSEPARATOR*/
string(string s) strtolower = #480; /* Part of DP_QC_STRING_CASE_FUNCTIONS*/
string(string s) strtoupper = #481; /* Part of DP_QC_STRING_CASE_FUNCTIONS*/
string(string s) cvar_defstring = #482; /* Part of DP_QC_CVAR_DEFSTRING*/
void(vector origin, string sample, float volume, float attenuation) pointsound = #483; /* Part of DP_SV_POINTSOUND*/
string(string search, string replace, string subject) strreplace = #484; /* Part of DP_QC_STRREPLACE*/
string(string search, string replace, string subject) strireplace = #485; /* Part of DP_QC_STRREPLACE*/
vector(entity e, float s, float n, float a) getsurfacepointattribute = #486; /* Part of DP_QC_GETSURFACEPOINTATTRIBUTE*/
float(string name) gecko_create = #487; /* Part of DP_GECKO_SUPPORT
Create a new 'browser tab' shader with the specified name that can then be drawn via drawpic (shader should not already exist - including from map/model textures or disk). In order to function correctly, this builtin depends upon external plugins being available. Use gecko_navigate to navigate it to a page of your choosing. */
void(string name) gecko_destroy = #488; /* Part of DP_GECKO_SUPPORT
Destroy a shader. */
void(string name, string URI) gecko_navigate = #489; /* Part of DP_GECKO_SUPPORT
Sends a command to the media decoder attached to the specified shader. In the case of a browser decoder, this changes the url that the browser displays. 'cmd:[un]focus' will tell the decoder that it has focus. */
float(string name, float key, float eventtype) gecko_keyevent = #490; /* Part of DP_GECKO_SUPPORT
Send a key event to a media decoder. This applies only to interactive decoders like browsers. */
void(string name, float x, float y) gecko_mousemove = #491; /* Part of DP_GECKO_SUPPORT
Sets a media decoder shader's mouse position. Values should be 0-1. */
void(string name, float w, float h) gecko_resize = #492; /* Part of DP_GECKO_SUPPORT
Request to resize a media decoder. */
vector(string name) gecko_get_texture_extent = #493; /* Part of DP_GECKO_SUPPORT
Retrieves a media decoder current image pixel sizes. */
string(string shadname, string propname) gecko_getproperty = #0:gecko_getproperty; /*
Queries the media decoder (especially browser ones) for decoder-specific properties. The cef plugin recognises url, title, status. */
float(string file, string id) cin_open = #0:cin_open;
void(string id) cin_close = #0:cin_close;
void(string id, float newstate) cin_setstate = #0:cin_setstate;
float(string id) cin_getstate = #0:cin_getstate;
void(string file) cin_restart = #0:cin_restart;
float(float caseinsensitive, string s, ...) crc16 = #494; /* Part of DP_QC_CRC16*/
float(string name) cvar_type = #495; /* Part of DP_QC_CVAR_TYPE*/
float() numentityfields = #496; /* Part of DP_QC_ENTITYDATA
Gives the number of named entity fields. Note that this is not the size of an entity, but rather just the number of unique names (ie: vectors use 4 names rather than 3). */
float(string fieldname) findentityfield = #0:findentityfield; /*
Find a field index by name. */
typedef .__variant field_t;
field_t(float fieldnum) entityfieldref = #0:entityfieldref; /*
Returns a field value that can be directly used to read entity fields. Be sure to validate the type with entityfieldtype before using. */
string(float fieldnum) entityfieldname = #497; /* Part of DP_QC_ENTITYDATA
Retrieves the name of the given entity field. */
float(float fieldnum) entityfieldtype = #498; /* Part of DP_QC_ENTITYDATA
Provides information about the type of the field specified by the field num. Returns one of the EV_ values. */
string(float fieldnum, entity ent) getentityfieldstring = #499; /* Part of DP_QC_ENTITYDATA*/
float(float fieldnum, entity ent, string s) putentityfieldstring = #500; /* Part of DP_QC_ENTITYDATA*/
string() ReadPicture = #501; /*
Reads a picture that was written by ReadPicture, and returns a name that can be used in drawpic and other 2d drawing functions. In FTE, this acts as a readstring-with-downloadcheck - the image will appear normally once it has been downloaded, but its size may be incorrect until then. */
void(float effectindex, entity own, vector org_from, vector org_to, vector dir_from, vector dir_to, float countmultiplier, optional float flags) boxparticles = #502;
string(string filename, optional float makereferenced) whichpack = #503; /* Part of DP_QC_WHICHPACK
Returns the pak file name that contains the file specified. progs/player.mdl will generally return something like 'pak0.pak'. If makereferenced is true, clients will automatically be told that the returned package should be pre-downloaded and used, even if allow_download_refpackages is not set. */
__variant(float entnum, float fieldnum) getentity = #504; /*
Looks up fields from non-csqc-visible entities. The entity will need to be within the player's pvs. fieldnum should be one of the GE_ constants. */
string(string in) uri_escape = #510; /* Part of DP_QC_URI_ESCAPE*/
string(string in) uri_unescape = #511; /* Part of DP_QC_URI_ESCAPE*/
float(entity ent) num_for_edict = #512;
#define uri_post uri_get
float(string uril, float id, optional string postmimetype, optional string postdata) uri_get = #513; /* Part of DP_QC_URI_GET, DP_QC_URI_POST
uri_get() gets content from an URL and calls a callback "uri_get_callback" with it set as string; an unique ID of the transfer is returned
returns 1 on success, and then calls the callback with the ID, 0 or the HTTP status code, and the received data in a string
For a POST request, you will typically want the postmimetype set to application/x-www-form-urlencoded.
For a GET request, omit the mime+data entirely.
Consult your webserver/php/etc documentation for best-practise. */
float(string str) tokenize_console = #514; /*
Tokenize a string exactly as the console's tokenizer would do so. The regular tokenize builtin became bastardized for convienient string parsing, which resulted in a large disparity that can be exploited to bypass checks implemented in a naive SV_ParseClientCommand function, therefore you can use this builtin to make sure it exactly matches. */
float(float idx) argv_start_index = #515; /*
Returns the character index that the tokenized arg started at. */
float(float idx) argv_end_index = #516; /*
Returns the character index that the tokenized arg stopped at. */
void(strbuf strbuf, string pattern, string antipattern) buf_cvarlist = #517;
string(string cvarname) cvar_description = #518; /*
Retrieves the description of a cvar, which might be useful for tooltips or help files. This may still not be useful. */
float(optional float timetype) gettime = #519;
string(float keynum) keynumtostring_omgwtf = #520;
string(string command, optional float bindmap) findkeysforcommand = #521; /*
Returns a list of keycodes that perform the given console command in a format that can only be parsed via tokenize (NOT tokenize_console). This only and always returns two values - if only one key is actually bound, -1 will be returned. The bindmap argument is listed for compatibility with dp-specific defs, but is ignored in FTE. */
string(string command, optional float bindmap) findkeysforcommandex = #0:findkeysforcommandex; /*
Returns a list of key bindings in keyname format instead of keynums. Use tokenize to parse. This list may contain modifiers. May return large numbers of keys. */
void(string s) loadfromdata = #529; /*
Reads a set of entities from the given string. This string should have the same format as a .ent file or a saved game. Entities will be spawned as required. If you need to see the entities that were created, you should use parseentitydata instead. */
void(string s) loadfromfile = #530; /*
Reads a set of entities from the named file. This file should have the same format as a .ent file or a saved game. Entities will be spawned as required. If you need to see the entities that were created, you should use parseentitydata instead. */
float(float v, optional float base) log = #532; /* Part of ??MVDSV_BUILTINS
Determines the logarithm of the input value according to the specified base. This can be used to calculate how much something was shifted by. */
float(entity e, float channel, string newsample, float volume, float attenuation, float pitchpct, float flags, float timeoffset) soundupdate = #0:soundupdate; /*
Changes the properties of the current sound being played on the given entity channel. newsample may be empty, and will be ignored in this case. timeoffset is relative to the current position (subtract the result of getsoundtime for absolute positions). Negative volume can be used to stop the sound. Return value is a fractional value based upon the number of audio devices that could be updated - test against TRUE rather than non-zero. */
float(entity e, float channel) getsoundtime = #533; /*
Returns the current playback time of the sample on the given entity's channel. Beware CHAN_AUTO (in csqc, channels are not limited by network protocol). */
float(string sample) soundlength = #534; /*
Provides a way to query the duration of a sound sample, allowing you to set up a timer to chain samples. */
float(string filename, strbuf bufhandle) buf_loadfile = #535; /*
Appends the named file into a string buffer (which must have been created in advance). The return value merely says whether the file was readable. */
float(filestream filehandle, strbuf bufhandle, optional float startpos, optional float numstrings) buf_writefile = #536; /*
Writes the contents of a string buffer onto the end of the supplied filehandle (you must have already used fopen). Additional optional arguments permit you to constrain the writes to a subsection of the stringbuffer. */
void(entity e, float physics_enabled) physics_enable = #540; /*
Enable or disable the physics attached to a MOVETYPE_PHYSICS entity. Entities which have been disabled in this way will stop taking so much cpu time. */
void(entity e, vector force, vector relative_ofs) physics_addforce = #541; /*
Apply some impulse directional force upon a MOVETYPE_PHYSICS entity. */
void(entity e, vector torque) physics_addtorque = #542; /*
Apply some impulse rotational force upon a MOVETYPE_PHYSICS entity. */
void(float trg) setmousetarget = #603;
float() getmousetarget = #604;
void(.../*, string funcname*/) callfunction = #605; /*
Invokes the named function. The function name is always passed as the last parameter and must always be present. The others are passed to the named function as-is */
void(filestream fh, entity e) writetofile = #606; /*
Writes an entity's fields to the named frik_file file handle. */
float(string s) isfunction = #607; /*
Returns true if the named function exists and can be called with the callfunction builtin. */
vector(float vidmode, optional float forfullscreen) getresolution = #608; /*
Supposed to query the driver for supported video modes. FTE does not query drivers in this way, nor would it trust drivers anyway. */
string(float keynum) keynumtostring_menu = #609;
float(float type) gethostcachevalue = #611; /* Part of FTE_CSQC_SERVERBROWSER*/
string(float type, float hostnr) gethostcachestring = #612; /* Part of FTE_CSQC_SERVERBROWSER*/
float(entity e, string s, optional float offset) parseentitydata = #613; /*
Reads a single entity's fields into an already-spawned entity. s should contain field pairs like in a saved game: {"foo1" "bar" "foo2" "5"}. Returns <=0 on failure, otherwise returns the offset in the string that was read to. */
string(entity e) generateentitydata = #0:generateentitydata; /*
Dumps the entities fields into a string which can later be parsed with parseentitydata. */
float(string key) stringtokeynum_menu = #614;
void() resethostcachemasks = #615; /* Part of FTE_CSQC_SERVERBROWSER*/
void(float mask, float fld, string str, float op) sethostcachemaskstring = #616; /* Part of FTE_CSQC_SERVERBROWSER*/
void(float mask, float fld, float num, float op) sethostcachemasknumber = #617; /* Part of FTE_CSQC_SERVERBROWSER*/
void() resorthostcache = #618; /* Part of FTE_CSQC_SERVERBROWSER*/
void(float fld, float descending) sethostcachesort = #619; /* Part of FTE_CSQC_SERVERBROWSER*/
void() refreshhostcache = #620; /* Part of FTE_CSQC_SERVERBROWSER*/
float(float fld, float hostnr) gethostcachenumber = #621; /* Part of FTE_CSQC_SERVERBROWSER*/
float(string key) gethostcacheindexforkey = #622; /* Part of FTE_CSQC_SERVERBROWSER*/
void(string key) addwantedhostcachekey = #623; /* Part of FTE_CSQC_SERVERBROWSER*/
string() getextresponse = #624; /* Part of FTE_CSQC_SERVERBROWSER*/
string(string dnsname, optional float defport) netaddress_resolve = #625;
string(string fmt, ...) sprintf = #627;
float(entity e, float s) getsurfacenumtriangles = #628;
vector(entity e, float s, float n) getsurfacetriangle = #629;
vector() getbindmaps = #631;
float(vector bm) setbindmaps = #632;
string(string digest, string data, ...) digest_hex = #639;
#if defined(CSQC) || defined(MENU)
#define K_TAB 9
#define K_ENTER 13
#define K_ESCAPE 27
#define K_SPACE 32
#define K_BACKSPACE 127
#define K_UPARROW 128
#define K_DOWNARROW 129
#define K_LEFTARROW 130
#define K_RIGHTARROW 131
#define K_LALT 132
#define K_RALT -245
#define K_LCTRL 133
#define K_RCTRL -246
#define K_LSHIFT 134
#define K_RSHIFT -247
#define K_F1 135
#define K_F2 136
#define K_F3 137
#define K_F4 138
#define K_F5 139
#define K_F6 140
#define K_F7 141
#define K_F8 142
#define K_F9 143
#define K_F10 144
#define K_F11 145
#define K_F12 146
#define K_INS 147
#define K_DEL 148
#define K_PGDN 149
#define K_PGUP 150
#define K_HOME 151
#define K_END 152
#define K_KP_HOME 164
#define K_KP_UPARROW 165
#define K_KP_PGUP 166
#define K_KP_LEFTARROW 161
#define K_KP_5 162
#define K_KP_RIGHTARROW 163
#define K_KP_END 158
#define K_KP_DOWNARROW 159
#define K_KP_PGDN 160
#define K_KP_ENTER 172
#define K_KP_INS 157
#define K_KP_DEL 167
#define K_KP_SLASH 168
#define K_KP_MINUS 170
#define K_KP_PLUS 171
#define K_KP_NUMLOCK 154
#define K_KP_STAR 169
#define K_KP_EQUALS 173
#define K_MOUSE1 512
#define K_MOUSE2 513
#define K_MOUSE3 514
#define K_MOUSE4 517
#define K_MOUSE5 518
#define K_MOUSE6 519
#define K_MOUSE7 520
#define K_MOUSE8 521
#define K_MOUSE9 522
#define K_MOUSE10 523
#define K_LWIN 239
#define K_RWIN 240
#define K_APP -241
#define K_SEARCH -242
#define K_POWER 130
#define K_VOLUP -243
#define K_VOLDOWN -244
#define K_JOY1 768
#define K_JOY2 769
#define K_JOY3 770
#define K_JOY4 771
#define K_AUX1 784
#define K_AUX2 785
#define K_AUX3 786
#define K_AUX4 787
#define K_AUX5 788
#define K_AUX6 789
#define K_AUX7 790
#define K_AUX8 791
#define K_AUX9 792
#define K_AUX10 793
#define K_AUX11 794
#define K_AUX12 795
#define K_AUX13 796
#define K_AUX14 797
#define K_AUX15 798
#define K_AUX16 799
#define K_AUX17 800
#define K_AUX18 801
#define K_AUX19 802
#define K_AUX20 803
#define K_AUX21 804
#define K_AUX22 805
#define K_AUX23 806
#define K_AUX24 807
#define K_AUX25 808
#define K_AUX26 809
#define K_AUX27 810
#define K_AUX28 811
#define K_AUX29 812
#define K_AUX30 813
#define K_AUX31 814
#define K_AUX32 815
#define K_PAUSE 153
#define K_MWHEELUP 515
#define K_MWHEELDOWN 516
#define K_PRINTSCREEN 174
#define K_CAPSLOCK 155
#define K_SCROLLLOCK 156
#define K_SEMICOLON 59
#define K_PLUS 43
#define K_TILDE 126
#define K_BACKQUOTE 96
#define K_BACKSLASH 92
#endif
#ifdef _ACCESSORS
accessor strbuf : float
{
inline get float asfloat[float idx] = {return stof(bufstr_get(this, idx));};
inline set float asfloat[float idx] = {bufstr_set(this, idx, ftos(value));};
get string[float] = bufstr_get;
set string[float] = bufstr_set;
get float length = buf_getsize;
};
accessor searchhandle : float
{
get string[float] = search_getfilename;
get float length = search_getsize;
};
accessor hashtable : float
{
inline get vector v[string key] = {return hash_get(this, key, '0 0 0', EV_VECTOR);};
inline set vector v[string key] = {hash_add(this, key, value, HASH_REPLACE|EV_VECTOR);};
inline get string s[string key] = {return hash_get(this, key, "", EV_STRING);};
inline set string s[string key] = {hash_add(this, key, value, HASH_REPLACE|EV_STRING);};
inline get string f[string key] = {return hash_get(this, key, 0.0, EV_FLOAT);};
inline set string f[string key] = {hash_add(this, key, value, HASH_REPLACE|EV_FLOAT);};
inline get __variant[string key] = {return hash_get(this, key, __NULL__);};
inline set __variant[string key] = {hash_add(this, key, value, HASH_REPLACE);};
};
accessor infostring : string
{
get string[string] = infoget;
inline set* string[string fld] = {(*this) = infoadd(*this, fld, value);};
};
accessor filestream : float
{
get string = fgets;
inline set string = {fputs(this,value);};
};
#endif
#pragma noref 0