QuakeC Functions Reference

Returns length (how many characters) of string.

Concatenates two or more strings (for example "abc", "def" would return "abcdef") and returns as a tempstring.

Returns a section of a string as a tempstring - see FTE_STRINGS for enhanced version.
NOTE: substring is upgraded by FTE_STRINGS extension with negative start/length handling identical to php 5.2.0.
NOTE: substring also exists in FRIK_FILE but this extension adds negative start and length as valid cases (see note above), substring is consistent with the php 5.2.0 substr function (not 5.2.3 behavior). Substring returns a section of a string as a tempstring, if given negative start the start is measured back from the end of the string, if given a negative length the length is the offset back from the end of the string to stop at, rather than being relative to start, if start is negative and larger than length it is treated as 0. Examples of substring:
substring("blah", -3, 3) returns "lah"
substring("blah", 3, 3) returns "h"
substring("blah", -10, 3) returns "bla"
substring("blah", -10, -3) returns "b"

Formats string with values.
supported stuff:
  %
  optional: <argpos>$ for the argument to format (the arg counter then is not increased)
  flags: #0- +
  optional: <width>, *, or *<argpos>$ for the field width (width is read before value and precision)
  optional: .<precision>, .*, or .*<argpos>$ for the precision (precision is read before value)
  length modifiers: h for forcing a float, l for forcing an entity (by default, %d etc. cast a float to int), ll for forcing an int
  conversions:
    d takes a float if no length is specified or h is, and an entity if l is specified as length, and an int if ll is specified as length, and cast it to an int
    i takes an entity if no length is specified or l is, and a float if h is specified as length, and an int if ll is specified as length, and cast it to an int
    ouxXc take a float if no length is specified or h is, and an entity if l is specified as length, and an int if ll is specified as length, and cast it to an unsigned int
    eEfFgG take a float if no length is specified or h is, and an entity if l is specified as length, and an int if ll is specified as length, and cast it to a double
    s takes a string
    vV takes a vector, and processes the three components as if it were a gG for all three components, separated by space
    For conversions s and c, the flag # makes precision and width interpreted
      as byte count, by default it is interpreted as character count in UTF-8
      enabled engines. No other conversions can create wide characters, and #
      has another meaning in these. When in character count mode, color codes
      are ignored. To get UTF-8 semantics WITHOUT color code parsing, use
      the + flag.

String length without color codes.

Removes color codes from string.

Converts string to lowercase.

Converts string to uppercase.

Returns the offset into a string of the matching text, or -1 if not found, case sensitive.

Returns the character at the specified offset as an integer, or 0 if an invalid index, or byte value - 256 if the engine supports UTF8 and the byte is part of an extended character.
NOTE: beware that str2chr() could return value bigger than 255 once utf8 is enabled

Returns a string representing the character given, if the engine supports UTF8 this may be a multi-byte sequence (length may be more than 1) for characters over 127.

Reformat a string with special color characters in the font.
DO NOT USE THIS ON UTF8 ENGINES (if you are lucky they will emit ^4 and such color codes instead), the parameter values are 0=same/1=lower/2=upper for ccase, 0=same/1=white/2=red/5=alternate/6=alternate-alternate for redalpha, 0=same/1=white/2=red/3=redspecial/4=whitespecial/5=alternate/6=alternate-alternate for rednum.

Pad string with spaces to a specified length, < 0 = left padding, > 0 = right padding.

Replaces all occurrences of 'search' with 'replace' in the string 'subject', and returns the result as a tempstring.

Replaces all occurrences of 'search' with 'replace' in the string 'subject', and returns the result as a tempstring, but uses case-insensitive matching of the 'search' term.

Compares two strings.

Compare two strings up to the specified number of characters, if their length differs and is within the specified limit the result will be negative, otherwise it is the difference in value of their first non-matching character.

Compare two strings with case-insensitive matching, characters a-z are considered equivalent to the matching A-Z character, no other differences, and this does not consider special characters equal even if they look similar.

Same as strcasecmp, but with a length limit, see strncmp.

Provides the ability to get the local (in your timezone) or world (Universal Coordinated Time) time as a string using the formatting of your choice:
example: "%Y-%m-%d %H:%M:%S"   (result looks like: 2007-02-08 01:03:15)
NOTE: "%F %T" gives the same result as "%Y-%m-%d %H:%M:%S" (ISO 8601 date format and 24-hour time).
For more format codes please do a web search for strftime 3 and you should find the man(3) pages for this standard C function.

Makes a copy of a string into the string zone and returns it, this is often used to keep around a tempstring for longer periods of time (tempstrings are replaced often).
NOTE: strzone functionality is partially superseded by DP_QC_UNLIMITEDTEMPSTRINGS when longterm storage is not needed

Removes a copy of a string from the string zone (you can not use that string again or it may crash).

Returns character from ASCII code.

Creates a new string buffer object (arbitrary length string arrays that are handled by the engine).

Deletes a string buffer object (arbitrary length string arrays that are handled by the engine).

Returns string buffer array size.

Copies one buffer to another.

Sorts buffer content.

Joins buffer elements into string.

Gets string from buffer.

Sets buffer string at index.

Adds string to buffer.

Frees buffer string memory.

Functions to list cvars and store their names into a stringbuffer cvars that start with pattern but not with antipattern will be stored into the buffer.

Returns string index.

Pattern match test. Returns 0/1. Provides a set of functions to manipulate with string buffers
pattern wildcards: * - any character (or no characters), ? - any 1 character
Warning: This extension is work-in-progress, it may be changed/revamped/removed at any time, dont use it if you dont want any trouble
Note: UTF8 is not supported yet.

Pattern match at offset. Provides a set of functions to manipulate with string buffers
pattern wildcards: * - any character (or no characters), ? - any 1 character
Warning: This extension is work-in-progress, it may be changed/revamped/removed at any time, dont use it if you dont want any trouble
Note: UTF8 is not supported yet

This function returns tokens separated by any of the supplied separator strings, example:
numnumbers = tokenizebyseparator("10.2.3.4", ".");
Returns 4 and the tokens are "10" "2" "3" "4"
Possibly useful for parsing IPv4 addresses (such as "1.2.3.4") and IPv6 addresses (such as "[1234:5678:9abc:def0:1234:5678:9abc:def0]:26000").

Splits string into tokens.

Sets or adds a key/value pair to an infostring - note: forbidden characters are \ and "

Gets a key/value pair in an infostring, returns value or null if not found.

Escapes URI components.

Unescapes URI components.

Checks if string is valid.

Returns count of entries in altstr.

Initializes altstr table.

Gets string from altstr index.

Sets string in altstr index.

Inserts string into altstr at index.

Creates a new entity, totally empty. You can manually set every field, or just set the origin and call one of the existing entity setup functions

Removes (deletes) an entity from the world.

Copies all data in the entity to another entity.

Sets an entity's position. Move an entity to a given location. That function is to be used when spawning an entity or when teleporting it. This is the only valid way to move an object without using the physics of the world (setting velocity and waiting). DO NOT change directly e.origin, otherwise internal links and entity clipping may be invalidated.

Sets the bounding box size of an entity.

Attachs e entity to a tag on tagentity
NOTE: use "" to attach to entity origin/angles instead of a tag.

Returns the name as a string, eg. "origin" or "classname" or whatever.

Returns a value that the constants represent, but the field may be of another type in more exotic progs.dat formats or compilers. String = 1, Float = 2, Vector = 3, Entity = 4, Function = 6.

Puts the data returned by getentityfieldstring back into the entity.

Returns data as would be written to a savegame, eg... "0.05" (float), "0 0 1" (vector), or "Hello World!" (string). Function names can also be returned.

Returns the entity corresponding to a given number, this works even for freed entities, but you should call wasfreed(ent) to see if is currently active.

Returns the entity corresponding to a given number, this works even for freed entities, but you should call wasfreed(ent) to see if is currently active.

Returns the number of an entity.

Make an entity static to the world, by sending a broadcast message to the network. The entity is then removed from the list of dynamic entities in the world, and it cannot be deleted (until the level ends).

Returns entity that is just after e in the entity list. Useful to browse the list of entities, because it skips the undefined ones.

Loads entity from a string.

Loads entity from file.

Writes entity to file.

Parses entity data.

Set parm1... to the values at level start for coop respawn. Restore the original spawn parameters of a client entity. Doesn't work if client is not a player.

Where: start is the beginning of list to search (world, for the beginning of list); field is the entity field that must be examined (ex: targetname); match is the value that must be matched (ex: other.target). Returns the entity found, or world if no entity was found. Searches the server entity list beginning at start, looking for an entity that has entity.field = match

Where: origin is the origin of sphere; radius is the radius of sphere. Returns a chain of entities that have their origins within a spherical area. The entity returned is e, and the next in the chain is e.chain, until e == FALSE. Typical usage: find and harm the victims of an explosion.

Similar to find() but returns a chain of entities like findradius.

Similar to findchain() etc, but stores the chain into .tofield instead of .chain.

Similar to findchain() etc, but stores the chain into .tofield instead of .chain.

Similar to findchain() etc, but stores the chain into .tofield instead of .chain.

Similar to findchain() etc, but stores the chain into .tofield instead of .chain.

Similar to findflags() but returns a chain of entities like findradius.

Similar to findentity()/findfloat() but returns a chain of entities like findradius.

Similar to findentity()/findfloat() but returns a chain of entities like findradius.

Finds an entity with the specified flag set in the field, similar to find().

Finds an entity, similar to find(), but for entity fields.

Finds an float field value, similar to find(), but for float fields.

Similar to findchain(), but for string field. Finds entities by string field match.

Allows to query parms from render entities, especially useful with attaching CSQC ents to server entities networked and interpolated by engine (monsters, players), number of entity is it's SVQC number you can send it via tempentity/CSQC entity message.
NOTE: this builtin doesnt know about entity removing/reallocating so it's meaning to work for short period of time, dont use it on missiles/grenades whatever will be removed next five seconds.

Allows to query parms from render entities, especially useful with attaching CSQC ents to server entities networked and interpolated by engine (monsters, players), number of entity is it's SVQC number you can send it via tempentity/CSQC entity message.
NOTE: this builtin doesnt know about entity removing/reallocating so it's meaning to work for short period of time, dont use it on missiles/grenades whatever will be removed next five seconds.

Gets number of fields on entity.

Sets the color on a client and updates internal color information accordingly (equivalent to stuffing a "color" command but immediate).

Returns entity by index.

Returns type of connected client.
float CLIENTTYPE_DISCONNECTED = 0;
float CLIENTTYPE_REAL = 1;
float CLIENTTYPE_BOT = 2;
float CLIENTTYPE_NOTACLIENT = 3;

Disconnects client from server. Causes the server to immediately drop the client, more reliable than stuffcmd(clent, "disconnect\n"); which could be intentionally ignored by the client engine.

Like spawn, but for client slots (also calls relevant connect/spawn functions), returns world if no clients available.

Returns the state of a client.
client state constants:
float CS_DEDICATED         = 0;
float CS_DISCONNECTED     = 1;
float CS_CONNECTED        = 2;

Returns number of connected clients.

Writes a byte to the message buffer. These are some of message types defined in the Quake network protocol. Values are used by the WriteByte() function.
SVC_SETVIEWPORT = 5;
SVC_SETANGLES = 10;
SVC_TEMPENTITY = 23;
SVC_KILLEDMONSTER = 27;
SVC_FOUNDSECRET = 28;
SVC_INTERMISSION = 30;
SVC_FINALE = 31;
SVC_CDTRACK = 32;
SVC_SELLSCREEN = 33;
SVC_UPDATE = 128;

Writes a character to the message buffer.

Writes a short integer to the buffer.

Writes a long integer to the buffer.

Writes a single map coordinate value to the current network message. Server commands normally expect three of these sequentially to mark the x, y, and z positions for a position argument.

This function writes a single byte, that represents 256 * (angle / 380). Writes a single angle value to the current network message. Server commands normally expect three of these sequentially to mark the pitch, yaw, and roll angles for an angle argument.

Writes a null-terminated string.

Like WriteString, but does not write a terminating 0 after the string. This means you can include things like a player's netname in the middle of a string sent over the network. Just be sure to end it up with either a call to WriteString (which includes the trailing 0) or WriteByte(0) to terminate it yourself.
NOTE: this extension was suggested by FrikaC years ago, more recently Shadowalker has been badmouthing LadyHavoc and Spike for stealing 'his' extension writestring2 which does exactly the same thing but uses a different builtin number and name and extension string, this argument hinges on the idea that it was his idea in the first place, which is incorrect as FrikaC first suggested it and used a rough equivilant of it in his FrikBot mod years ago involving WriteByte calls on each character.

This function writes an entity reference, taking two bytes. Writes the index for an entity to the current network message. This is used for server commands that expect entity arguments.

Writes a picture to the data stream so CSQC can read it using ReadPicture, which has the definition
string(void) ReadPicture = #501;
The picture data is sent as at most sz bytes, by compressing to low quality JPEG. The data being sent will be equivalent to:
WriteString(to, s);
WriteShort(to, imagesize);
for(i = 0; i < imagesize; ++i) WriteByte(to, [the i-th byte of the compressed JPEG image]);

Writes a float value.

Sends entity state over network. In this function, the entity which is being sent is self.
The viewer parameter is the client entity to whom the entity is being sent.
The return value should be TRUE if the entity is to be sent to that client, and FALSE if it not to be.
Inside this function, the core builtins WriteCoord, WriteAngle, WriteByte, WriteShort, WriteLong are used with the destination parameter MSG_ENTITY, indicating that the data is part of a CSQC entity update.

Performs HTTP GET request. Loads text from an URL into a string. Returns 1 on success of initiation, 0 if there are too many concurrent connections already or if the URL is invalid the following callback will receive the data and MUST exist!

void(float id, float status, string data) URI_Get_Callback;

status is either negative for an internal error, 0 for success, or the HTTP response code on server error (e.g. 404).
If 1 is returned by uri_get, the callback will be called in the future.

Performs HTTP POST request. Loads text from an URL into a string after POSTing via HTTP. Works like uri_get, but uri_post sends data with Content-Type: content_type to the server and uri_post sends the string buffer buf, joined using the delimiter delim.

POST request with buffer.

Gets a player config key.

Gets server-specific info string.

Gets host list value.

Gets full host cache as string.

Resolves hostname to IP.

Reads byte from network message, pair with WriteByte.

Reads char from network message.

Reads a signed 16-bit value. Paired with WriteShort.

Reads a signed 32-bit value. Paired with WriteLong or WriteInt.

Reads float coordinate. Reads a value matching the unspecified precision written ONLY by WriteCoord.

Reads float angle.

Reads null-terminated string.

Reads a float without any truncation nor conversions. Data MUST have originally been written with WriteFloat.

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.

Clientside playback of simple custom sprite effects (explosion sprites, etc).

Blood spray effect.
vector origin
byte xvelocity (-128 to +127)
byte yvelocity (-128 to +127)
byte zvelocity (-128 to +127)
byte count (0 to 255, how much blood)

Creates an exploding shower of blood, for making gibbings more convincing.

Creates a customized light flash.

Colored explosion effect.

Creates a single puff of flame particles.

Creates a cloud of particles, useful for forcefields but quite customizable.

Rain particle effect.

Snow particle effect.

Plasma burn effect.

Quad gunshot effect.

Quad spike impact effect.

Quad superspike effect.

Quad explosion effect.

Small flash effect.

Spark effect.

Gunshot effect.

Spike impact effect.

Superspike impact effect.

Standard explosion effect.

TAR explosion effect.

Wizard spike effect.

Knight spike effect.

Lava splash effect.

Teleport flash effect.

Alternate explosion effect.

Lightning bolt type 1.

Lightning bolt type 2.

Lightning bolt type 3.

Draws a beam effect.

Sine of angle in degrees.

Cosine of angle in degrees.

Square root of a number.

Returns absolute value of val (like the equivalent function in C).

Returns val, rounded up to the integer below (like the equivalent function in C).

Returns val, rounded up to the integer above (like the equivalent function in C).

Rounds to nearest int.

Raises to power.

Returns the lowest of all the supplied numbers.

Returns the highest of all the supplied numbers.

Natural logarithm.

Modulus operation.

Clamps the value to the range and returns it.

Returns random float (0-1).

Returns a vector of length < 1, much quicker version of this QC.

Multiplies number by a power of 2 corresponding to quantity (0 = *1, 1 = *2, 2 = *4, 3 = *8, -1 = /2, -2 = /4x, etc), and rounds down (due to integer math) like other bit operations do (& and | and the like).

Returns a vector of length 1.

Returns vector length.

Returns an angle in degrees. Vector to yaw: calculates the yaw angle (bearing) corresponding to a given 3D direction.

Vector to angles: calculates the pitch angle (aiming) and yaw angle (bearing) corresponding to a given 3D direction.

Variant of vectoangles that takes an up vector to calculate roll angle (also uses this to calculate yaw correctly if the forward is straight up or straight down).

Creates v_forward, v_right, and v_up vectors given a forward vector, similar to makevectors except it takes a forward direction vector instead of angles.

Calculates v_forward/v_right/v_up from angles.

Returns angle in radians for a given sin() value, the result is in the range -PI*0.5 to PI*0.5

Returns angle in radians for a given cos() value, the result is in the range 0 to PI.

Returns angle in radians for a given tan() value, the result is in the range -PI*0.5 to PI*0.5.

Returns angle in radians for a given cos() and sin() value pair, the result is in the range -PI to PI (this is identical to vectoyaw except it returns radians rather than degrees).

Returns tangent value (which is simply sin(a)/cos(a)) for the given angle in radians, the result is in the range -infinity to +infinity

Assigns a model to an entity.

Append each line of file as new buffer string, return 1 if succesful.

Writes buffer strings as lines, returns 1 if succesful

Opens a file inside quake/gamedir/data/ (mode is FILE_READ, FILE_APPEND, or FILE_WRITE), returns fhandle >= 0 if successful, or fhandle < 0 if unable to open file for any reason.

Closes an open file handle.

Reads a line of text from the file and returns as a tempstring.

Writes a string to file.

Copies one file to another.

Renames a file.

Deletes a file.

Checks if a file exists.

Deletes directory and contents.

Preloads a model.

Preloads model only for purchased Quake.

Preloads a file.

Preloads file for purchased Quake.

For files in a pak/pk3, returns the pack's file name in FRIK_FILE name space.

Extension to search_begin (DP_QC_FS_SEARCH), performs a filename search with the specified pattern (for example "maps/*.bsp") and stores the results in a search slot (minimum of 128 supported by any engine with this extension), the other functions take this returned search slot number, be sure to search_free when done (they are also freed on progs reload).

Performs a filename search with the specified pattern (for example "maps/*.bsp") and stores the results in a search slot (minimum of 128 supported by any engine with this extension), the other functions take this returned search slot number, be sure to search_free when done (they are also freed on progs reload).

Frees a search slot (also done at progs reload).

Returns how many filenames were found.

Returns a filename from the search.

Send a command to a given player, as if it had been typed on the player's console.

Execute a command on the server, as if it had been typed on the server's console.

Registers new command.

Adds a new console cvar to the server console (in singleplayer this is the player's console), the cvar exists until the mod is unloaded or the game quits.

Gets cvar value.

Sets cvar value.

Returns the default value of a cvar, as a tempstring.

Returns the description of a cvar.

Returns the value of a cvar, as a tempstring.

Gets cvar type (exists, saved, private, engine, hasdescription, readonly).

Gets string value of a cvar.

This function returns tokens separated just like the console does.

Returns the index of the first character of each token in the original string.

Returns the index of the last character of each token in the original string.

Sends command to client.

Gets argument from tokenized input.

Gets the input command name.

Gets key name from key code.

Gets key code from key name.

Gets binding for key.

Sets mouse cursor mode.

Gets mouse position.

Gets key/button input state.

Scales mouse sensitivity.

Gets bind from specific bindmap.

Binds key in specific bindmap.

Gets active bindmaps.

Sets active bindmaps.

Finds keys bound to a command.

Sets input destination.

Gets current key destination.

Sets mouse target entity.

Gets current mouse target.

Create a skeleton (be sure to assign this value into .skeletonindex for use), returns skeleton index (1 or higher) on success, returns 0 on failure (for example if the modelindex is not skeletal), it is recommended that you create a new skeleton if you change modelindex, as the skeleton uses the hierarchy from the model.

Blend in a percentage of standard animation, 0 replaces entirely, 1 does nothing, 0.5 blends half, etc, and this only alters the bones in the specified range for which out of bounds values like 0,100000 are safe (uses .frame, .frame2, .frame3, .frame4, .lerpfrac, .lerpfrac3, .lerpfrac4, .frame1time, .frame2time, .frame3time, .frame4time), returns skel on success, 0 on failure.

Returns how many bones exist in the created skeleton, 0 if skeleton does not exist.

Returns name of bone (as a tempstring), "" if invalid bonenum (< 1 for example) or skeleton does not exist.

Returns parent num for supplied bonenum, 0 if bonenum has no parent or bone does not exist (returned value is always less than bonenum, you can loop on this).

Get number of bone with specified name, 0 on failure, bonenum (1-based) on success, same as using gettagindex but takes modelindex instead of entity.

Get matrix of bone in skeleton relative to its parent - sets v_forward, v_right, v_up, returns origin (relative to parent bone).

Get matrix of bone in skeleton in model space - sets v_forward, v_right, v_up, returns origin (relative to entity).

Set matrix of bone relative to its parent, reads v_forward, v_right, v_up, takes origin as parameter (relative to parent bone).

Transform bone matrix (relative to its parent) by the supplied matrix in v_forward, v_right, v_up, takes origin as parameter (relative to parent bone).

Transform bone matrices (relative to their parents) by the supplied matrix in v_forward, v_right, v_up, takes origin as parameter (relative to parent bones).

Copy bone matrices (relative to their parents) from one skeleton to another, useful for copying a skeleton to a corpse

Deletes skeleton at the beginning of the next frame (you can add the entity, delete the skeleton, renderscene, and it will still work).

Finds number of a specified frame in the animation, returns -1 if no match found.

Returns the intended play time (in seconds) of the specified framegroup, if it does not exist the result is 0, if it is a single frame it may be a small value around 0.1 or 0.

CSQC builtin to clear the scene of all entities / reset our view properties.

Adds entities with these rendermask field var's to our view.

Adds a single entity to the scene.

Sets a render property on entity.