From a2afae627244eaf93557618448f3ee933b8f6832 Mon Sep 17 00:00:00 2001 From: "Alejandro V. Garcia" Date: Sat, 31 Jul 2010 04:58:10 +0000 Subject: [PATCH] reference updates git-svn-id: svn://svn.code.sf.net/p/actiongame/code/trunk/ac@5508 e016b1c5-ed68-44aa-a2f7-31cac88cffde --- config/docs.cfg | 92 +-- docs/reference.xml | 1800 ++++++++++++++++++++++---------------------- 2 files changed, 953 insertions(+), 939 deletions(-) diff --git a/config/docs.cfg b/config/docs.cfg index 06769a64..c5c25cd1 100644 --- a/config/docs.cfg +++ b/config/docs.cfg @@ -370,7 +370,7 @@ docident [disconnect] [Leaves a server.]; docident [drawbeamtobots] [Draws a shooting line in the direction of all available bots.]; docargument [] [this command does not take any arguments] [none] [0]; docremark [This is a debugging command and only works for single player modes.]; -docident [dropflag] []; +docident [dropflag] [Drops the enemy flag.]; docident [footstepalign] [Maximum time span between player animation and the playback of the footstep sound]; docargument [T] [time span] [min 5/max 4000/default 15]; docremark [If the footstep sound would be played immediately when entering the radius of the other player, it would not be synchronous to the player model animation.]; @@ -382,7 +382,7 @@ docremark [This does not work in multiplayer. For entertainment purposes only :) docident [getclientmode] [Returns the current game mode number.]; docident [getdemo] []; docargument [X] [number in list] [] [0]; -docargument [P] [subpath (optional)] [] []; +docargument [P] [subpath (optional)] [] [0]; docident [getmap] [Retrieves the last map that was sent to the server using 'sendmap'.]; docident [hidecustomskins] []; docargument [B] [] [min 0/max 1/default 0]; @@ -404,7 +404,7 @@ docargument [N] [botname] [name of the bot to kick.] [0]; docexample [kickbot Robbie] [Will make the bot named "Robbie" dissapear from the current game.]; docident [lanconnect] []; docident [listcomplete] []; -docident [listdemos] []; +docident [listdemos] [Get the game demos listing from the server we are currently connected.]; docident [listignored] [Print a list of all players that you are currently ignoring.]; docident [listmuted] [Print a list of all players that you have muted.]; docident [loadcrosshair] [Loads a crosshair for a specific weapon of - if the weapon argument is omitted or <0 - for all weapons.]; @@ -826,13 +826,13 @@ docident [showmenu] [Displays the specified menu.]; docargument [N] [the name of a previously defined menu] [] [0]; docremark [The menu allows the user to pick an item with the cursor keys. Upon pressing return, the associated action will be executed. Pressing ESC will cancel the menu.]; docsection [Head-Up Display] -docident [aboveheadiconfadetime] [Time in milliseconds before the abovehead dissapears.]; -docargument [V] [] [min 1/max 10000/default 2000]; +docident [aboveheadiconfadetime] [Time in milliseconds before the abovehead icon dissapears.]; +docargument [V] [abovehead icon display time] [min 1/max 10000/default 2000]; docident [altconsize] [Sets the number of text lines on an alternate F11 history display.]; docargument [V] [] [min 0/max 100/default 0]; docident [clearminimap] [Recreates the minimap for the current map.]; docident [confade] [Sets how many seconds before the console text rolls up.]; -docargument [V] [] [min 0/max 60/default 20]; +docargument [V] [time before text rollout] [min 0/max 60/default 20]; docremark [It may also be viewed as the speed at wich the console text dissapears.]; docident [consize] [Sets how many lines of text the console displays.]; docargument [V] [] [min 0/max 100/default 6]; @@ -847,44 +847,44 @@ docident [crosshairsize] [Sets the size of your crosshair.]; docargument [N] [the crosshair size] [min 0/max 50/default 15]; docremark [The crosshair is turned off entirely if the size is set to 0.]; docident [crosshairteamsign] [Turns on/off display of team warning crosshair.]; -docargument [V] [] [min 0/max 1/default 1]; +docargument [V] [enable/disable warning crosshair] [min 0/max 1/default 1]; docident [damageindicatoralpha] [Set the level of transparency of the damage indicator, 0 = is fully transparent, 100 = totaly solid.]; -docargument [V] [] [min 1/max 100/default 50]; +docargument [V] [damage indicator alpha value] [min 1/max 100/default 50]; docident [damageindicatordist] [Sets the separation of the arrows in the damage indicator.]; -docargument [V] [] [min 0/max 10000/default 500]; +docargument [V] [damage indicator separation size] [min 0/max 10000/default 500]; docident [damageindicatorsize] [Sets the size of the damage indicator.]; -docargument [V] [] [min 0/max 10000/default 200]; +docargument [V] [damage indicator icon size] [min 0/max 10000/default 200]; docident [damageindicatortime] [Sets how long the damage indicator stays on screen.]; -docargument [V] [] [min 1/max 10000/default 1000]; +docargument [V] [damage indicator display time] [min 1/max 10000/default 1000]; docident [fullconsize] [Sets the number of text lines on the F11 history display.]; docargument [V] [] [min 0/max 100/default 40]; docident [hidebigmenuimages] [Hide big images in menus.]; docargument [N] [0: show, 1: hide] [min 0/max 1/default 0]; -docident [hidecompass] []; -docargument [V] [] [min 0/max 1/default 0]; +docident [hidecompass] [Turns on/off the radar compass]; +docargument [V] [enable/disable radar compass] [min 0/max 1/default 0]; docident [hideconsole] [Turns on or off the display of console text.]; -docargument [V] [] [min 0/max 1/default 0]; +docargument [V] [enable/disable console text] [min 0/max 1/default 0]; docident [hidectfhud] [Turns on or off the display of flag icons.]; -docargument [V] [] [min 0/max 1/default 0]; -docident [hidedamageindicator] []; -docargument [V] [] [min 0/max 1/default 0]; +docargument [V] [enable/disable flag icons] [min 0/max 1/default 0]; +docident [hidedamageindicator] [Turns on/off the damage indicator]; +docargument [V] [enable/disable damage indicator] [min 0/max 1/default 0]; docident [hidehudequipment] [Turns on or off the display of equipement icons.]; -docargument [V] [] [min 0/max 1/default 0]; +docargument [V] [enable/disable equipement icons] [min 0/max 1/default 0]; docident [hidehudmsgs] [Turns on or off the display of messages at the bottom of the screen.]; -docargument [V] [] [min 0/max 1/default 0]; +docargument [V] [enable/disable messages] [min 0/max 1/default 0]; docident [hideradar] [Turns on or off the display of the on-screen radar.]; -docargument [V] [] [min 0/max 1/default 0]; +docargument [V] [enable/disable radar] [min 0/max 1/default 0]; docident [hidespecthud] [Turns on or off the display of spectator staus.]; -docargument [V] [] [min 0/max 1/default 0]; +docargument [V] [enable/disable spectator status] [min 0/max 1/default 0]; docident [hideteam] [Turns on or off the display of local player team icons.]; -docargument [V] [] [min 0/max 1/default 0]; +docargument [V] [enable/disable team icons] [min 0/max 1/default 0]; docident [hidevote] [Turns on or off the display of vote icons.]; -docargument [V] [] [min 0/max 2/default 0]; +docargument [V] [enable/disable vote info] [min 0/max 2/default 0]; docident [history] [Executes the specified command in the command line history.]; docargument [N] [the N'th command from the history] [] [0]; docremark [For example, binding "history 1" to a key allows you to quickly repeat the last command typed in (useful for placing many identical entities etc.)]; docident [hudgun] [Turns on or off the display of the current selected gun.]; -docargument [V] [] [min 0/max 1/default 1]; +docargument [V] [show/hide guns 3D models] [min 0/max 1/default 1]; docident [maxcon] [Sets the total number of text lines from the console to store as history.]; docargument [V] [] [min 10/max 1000/default 200]; docident [maxhistory] [Sets how many typed console commands to store.]; @@ -899,7 +899,7 @@ docargument [V] [] [min 0/max 1/default 0]; docident [oldfashionedgunstats] [Show ammo stats like in 1.0]; docargument [N] [0: new, 1: old] [min 0/max 1/default 0]; docident [radarentsize] [Sets the icon size of the players shown in the radar and the minimap.]; -docargument [V] [] [min 1/max 64/default 4]; +docargument [V] [size of icons inside radar] [min 1/max 64/default 4]; docident [recoilbackfade] []; docargument [V] [] [min 0/max 1000/default 100]; docident [recoilbase] []; @@ -924,7 +924,7 @@ docsection [Visuals] docident [aadynshadow] [Sets the size/resolution of the dynamic shadow data.]; docargument [] [the size] [min 0/max 3/default 2]; docident [aboveheadiconsize] [Sets the size for the icon shown above a player using comunications voices.]; -docargument [V] [] [min 0/max 1000/default 50]; +docargument [V] [Icon size] [min 0/max 1000/default 50]; docident [animationinterpolationtime] [Sets the time available for interpolation between model animations.]; docargument [N] [the amount of milliseconds for the interpolation] [min 0/max 1000/default 100]; docident [ati_mda_bug] []; @@ -932,13 +932,13 @@ docargument [V] [] [min 0/max 1/default 0]; docident [bilinear] []; docargument [V] [] [min 0/max 1/default 1]; docident [blood] [Turn on and off the display of blood.]; -docargument [V] [] [min 0/max 1/default 1]; +docargument [V] [Enable/Disable blood] [min 0/max 1/default 1]; docident [bloodttl] [Sets the amount of time in milliseconds that blood is displayed on the ground.]; -docargument [V] [] [min 0/max 30000/default 10000]; -docident [bullethole] []; -docargument [V] [] [min 0/max 1/default 1]; -docident [bulletholettl] []; -docargument [V] [] [min 0/max 30000/default 10000]; +docargument [V] [Blood display time] [min 0/max 30000/default 10000]; +docident [bullethole] [Turns on/off the display of bullet holes]; +docargument [V] [Enable/Disable bullet holes] [min 0/max 1/default 1]; +docident [bulletholettl] [Specifies how long (in milliseconds) to display bullet holes.]; +docargument [V] [Bullethole display time] [min 0/max 30000/default 10000]; docident [colorbits] [Sets the bits per pixel value.]; docargument [] [bits per pixel] [min 0/max 32/default 0]; docident [dbgmbatch] []; @@ -981,7 +981,7 @@ docargument [B] [max] [] [0]; docident [fsaa] [Sets the level of fullscreen antialiasing (FSAA).]; docargument [] [fsaa] [min 0/max 16/default 0]; docident [fullbrightlevel] [Sets the level of brightness to use when using the command "/fullbright 1".]; -docargument [V] [] [min 0/max 255/default 176]; +docargument [V] [Light intensity level] [min 0/max 255/default 176]; docident [fullscreen] [Enables or disables fullscreen.]; docargument [] [fullscreen] [min 0/max 1/default 1]; docremark [Not supported on Windows and Mac.]; @@ -1051,24 +1051,24 @@ docident [shotlinettl] []; docargument [V] [] [min 0/max 10000/default 75]; docident [skyclip] []; docargument [V] [] [min 0/max 1/default 1]; -docident [spectfov] []; -docargument [V] [] [min 5/max 120/default 120]; +docident [spectfov] [Specifies the Field Of View when in spectating/ghost mode.]; +docargument [V] [Spectate FOV size] [min 5/max 120/default 120]; docident [stencilbits] []; docargument [V] [] [min 0/max 32/default 0]; docident [stencilshadow] [Sets the transparency/opacity level of stencil shadows.]; -docargument [V] [] [min 0/max 100/default 40]; +docargument [V] [Alpha level] [min 0/max 100/default 40]; docident [teamdisplaymode] [Sets the team display mode.]; docargument [N] [the team display mode] [0 (none), 1 (color vests), 2 (color skins) min 0/max 2/default 1]; -docremark [In mode 0 team display is disabled In mode 1 players will be rendered with a colored vest to make the teams distinguishable. In mode 2 almost the whole suit of the players will be colored. These display modes are only applied in team gamemodes.]; +docremark [In mode 0 team display is disabled In mode 1 players will be rendered with a colored vest to make the teams distinguishable. In mode 2 almost the whole suit of the players will be colored. These display modes are only applied in team gameodes.]; docident [trilinear] []; docargument [V] [] [min 0/max 1/default 1]; docident [vsync] [Enables or disables vsync.]; docargument [] [vsync] [min -1/max 1/default -1]; docremark [-1 uses the default settings obtained from the system. 0 disables, 1 enables vsync.]; -docident [waterreflect] []; -docargument [V] [] [min 0/max 1/default 1]; -docident [waterrefract] []; -docargument [V] [] [min 0/max 1/default 0]; +docident [waterreflect] [Turns on/off the reflections in the water surface.]; +docargument [V] [enable/disable water reflections] [min 0/max 1/default 1]; +docident [waterrefract] [Turns on/off water refractions.]; +docargument [V] [enable/disable water refractions] [min 0/max 1/default 0]; docident [watersubdiv] [Determines the subdivision of the water surface in maps.]; docargument [N] [the subdivisioin value] [min 1/max 64/default 4]; docremark [Must be a power of 2: 4 is the default, 8 is recommended for people on slow machines, 2 is nice for fast machines, and 1 is quite OTT. See "waterlevel" (edit reference) on how to add water to your own levels.]; @@ -1173,7 +1173,7 @@ docident [docwritebaseref] [Writes out a base XML documentation reference contai docargument [R] [the reference name] [] [0]; docargument [S] [the XML schema location string] [] [0]; docargument [T] [XML stylesheet to use] [] [0]; -docremark [The generated reference is written to "config/autogenerated_base_reference.xml" by default. The three arguments can be changed later on in the generated XML document.]; +docremark [The generated reference is written to "docs/autogenerated_base_reference.xml" by default. The three arguments can be changed later on in the generated XML document.]; docsection [Server commands] docident [addfavcategory] [Adds a new category in the serverbrowser favourites.]; docargument [A] [reference designator (keep short and unique)] [] [0]; @@ -1413,7 +1413,7 @@ docargument [D] [The angle in degrees to rotate the stencil shadows] [0...360, d docremark [When specifying shadowyaw, remember that the default angle is 45 degrees. The example below would make the shadows appear at 90 degrees (45 degrees more to the left).]; docexample [shadowyaw 90] []; docident [texture] [Binds a texture to the current texture slot.]; -docargument [0] [This is a redundant value. Always leave this value as 0 here so it doesn't break your configurations.] [0] [0]; +docargument [0] [This is a redundant value. Always leave this value as 0 here so it doesn'tbreak your configurations.] [0] [0]; docargument [F] [File name of the texture to bind] [String] [0]; docremark [Binds the texture indicated in the filename to the current texture slot and increments the slot number.]; docident [texturereset] [Sets the texture slots/indicies to 0 for the subsequent "texture" commands.]; @@ -1511,9 +1511,9 @@ docremark [other call forms may use the numerical item type]; docident [setwptriggernr] [TODO: Description]; docargument [A] [TODO] [] [0]; docident [showedithide] [shows the settings of edithide (sparklies)]; -docident [showmapbackdrop] [change whether to have a see-through map overview (0), or render it on a black backdrop (1) or a combination of both (2)]; +docident [showmapbackdrop] [change wether to have a see-through map overview (0), or render it on a black backdrop (1) or a combination of both (2)]; docargument [B] [backdrop-style] [min 0/max 2/default 2]; -docident [showmapbackdroptransparency] [change the level of transparency of "showmapbackdrop 2"]; +docident [showmapbackdroptransparency] []; docargument [T] [transparency] [min 0/max 100/default 75]; docident [soundmuted] [TODO: Description]; docargument [A] [TODO] [] [0]; @@ -1524,4 +1524,4 @@ docargument [N] [TODO] [min -1/max 3/default 0]; docident [texturescale] [TODO]; docargument [N] [TODO] [min 16/max 64/default 32]; docident [voicecomsounds] [TODO]; -docargument [N] [TODO] [min 0/max 2/default 1]; +docargument [N] [TODO] [min 0/max 2/default 1]; \ No newline at end of file diff --git a/docs/reference.xml b/docs/reference.xml index 2fa6b3a3..9f61694d 100644 --- a/docs/reference.xml +++ b/docs/reference.xml @@ -28,460 +28,460 @@ - - Determines if a floating-point value is smaller than a second floating-point value. - - - - - - + + Determines if a floating-point value is smaller than a second floating-point value. + + + + + + - - Determines if a floating-point value is less than or equal to a second floating-point value. - - - - - - + + Determines if a floating-point value is less than or equal to a second floating-point value. + + + + + + - - Determines if a floating-point value is equal to a second floating-point value. - - - - - - + + Determines if a floating-point value is equal to a second floating-point value. + + + + + + - - Determines if a floating-point value is greater than a second floating-point value. - - - - - - + + Determines if a floating-point value is greater than a second floating-point value. + + + + + + - - Determines if a floating-point value is greater than or equal to a second floating-point value. - - - - - - + + Determines if a floating-point value is greater than or equal to a second floating-point value. + + + + + + - - Determines if a floating-point value is not equal to a second floating-point value. - - - - - - + + Determines if a floating-point value is not equal to a second floating-point value. + + + + + + - - sets the result value of a CubeScript block - - - - + + sets the result value of a CubeScript block + + + + - + + + + + + + + + + + + Performs a floating-point modulo operation. + + + + + + + + + Output: 7.5 + + + + Output: 5.0 + + + + + - - + - + - + - - Performs a floating-point modulo operation. - - - - - - - - - Output: 7.5 - - - - Output: 5.0 - - - + + Performs an addition. + + + Example: echo the sum of x and y is (+ $x $y) + + + + + + + + - - - - - - - - + + Performs a subtraction. + + + + + + - - Performs an addition. - - - Example: echo the sum of x and y is (+ $x $y) - - - - - - - - + + Subtracts two floating-point numbers. + + + + + + - - Performs a subtraction. - - - - - - + + Adds up two floating-point numbers. + + + + + + - - Subtracts two floating-point numbers. - - - - - - + + Performs a multiplication. + + + + + + - - Adds up two floating-point numbers. - - - - - - + + Performs an integer division. + + + + + + - - Performs a multiplication. - - - - - - + + Performs a division with floating-point precision. + + + + + + - - Performs an integer division. - - - - - - + + Performs a modulo operation. + + + + + + - - Performs a division with floating-point precision. - - - - - - + + Determines if two values are equal. + + + + + + + + + Output: there are only 10 types of people in the world + + + - - Performs a modulo operation. - - - - - - + + Determines if two values are not equal. + + + + + + - - Determines if two values are equal. - - - - - - - - - Output: there are only 10 types of people in the world - - - + + Determines if a value is smaller than a second value. + + + + + + - - Determines if two values are not equal. - - - - - - + + Determines if a value is bigger than a second value. + + + + + + - - Determines if a value is smaller than a second value. - - - - - - + + Determines if a values is less than or equal than a second value. + + + + + - - Determines if a value is bigger than a second value. - - - - - - + + Determines if a values is greater than or equal than a second value. + + + + + - - Determines if a values is less than or equal than a second value. - - - - - + + logical AND. + + + + Output: 1 + + + + Output: 0 + + + + + + + + - - Determines if a values is greater than or equal than a second value. - - - - - + + logical OR. + + + + + output: 1 + + + + + + output: 0 + + + + + + + + + - - logical AND. - - - - Output: 1 - - - - Output: 0 - - - - - - - - + + Performs a negation. + + + + - - logical OR. - - - - - output: 1 - - - - - - output: 0 - - - - - - - - - + + Performs a floating point multiplication. + + + + + + - - Performs a negation. - - - - + + Random value + + + + + - - Performs a floating point multiplication. - - - - - - + + Determines if two strings are equal. + + + + + + - - Random value - - - - - + + Controls the script flow based on a boolean expression. + + + $x 10) [ echo x is bigger than 10 ] [ echo x too small ]]]> + + + + + + + + - - Determines if two strings are equal. - - - - - - + + Loops the specified body. + + This command sets the alias you choose, as first argument, from 0 to N-1 for every iteration. + + + + + + + + + + + + - - Controls the script flow based on a boolean expression. - - - $x 10) [ echo x is bigger than 10 ] [ echo x too small ]]]> - - - - - - - - + + Loops the specified body while the condition evaluates to true. + + + This command sets the alias "i" from 0 to N-1 for every iteration. + Note that the condition here has to have [], otherwise it would only be evaluated once. + + + + + + + + + + + + - - Loops the specified body. - - This command sets the alias you choose, as first argument, from 0 to N-1 for every iteration. - - - - - - - - - - - - + + Concatenates multiple strings with spaces inbetween. + + + + output: hello world + + + + + + + + - - Loops the specified body while the condition evaluates to true. - - - This command sets the alias "i" from 0 to N-1 for every iteration. - Note that the condition here has to have [], otherwise it would only be evaluated once. - - - - - - - - - - - - + + Concatenates multiple strings. + + The newly created string is saved to the alias 's'. + + + + + output: CubeScript + + + + + + + + - - Concatenates multiple strings with spaces inbetween. - - - - output: hello world - - - - - - - - + + Grabs a word out of a string. + + + + output: two + + + + + + + + - - Concatenates multiple strings. - - The newly created string is saved to the alias 's'. - - - - - output: CubeScript - - - - - - - - + + returns the element count of the given list. + + + + - - Grabs a word out of a string. - - - - output: two - - - - - - - - + + Searches a list for a specified value. + + + + + + - - returns the element count of the given list. - - - - + + Executes a command after specified time period. + + + + Prints 'foo' to the screen after 1 second. + + + + + + + - - Searches a list for a specified value. - - - - - - + + The number of arguments passed to the current alias + + - - Executes a command after specified time period. - - - - Prints 'foo' to the screen after 1 second. - - - - - - - - - - The number of arguments passed to the current alias - - - - - - - - - - - - output: 99 bottles of beer on the wall, 99 bottles of beer! - - - + + + + + + + + + output: 99 bottles of beer on the wall, 99 bottles of beer! + + + @@ -490,507 +490,507 @@
This section describes general identifiers. - - - - Toggle for taking an automatic screenshot during intermission. - - + + + + Toggle for taking an automatic screenshot during intermission. + + - - Toggle format of screenshot image. Your choice is for BMP (0) or JPEG (1). - - + + Toggle format of screenshot image. Your choice is for BMP (0) or JPEG (1). + + - - Sets the JPEG screenshot image quality. - - The image quality is set by it's compression level, a value of 10 sets maximum compression and a small file size but results in a bad quality image - while a value of 100 results in a large file but gives the best quality image. - - - + + Sets the JPEG screenshot image quality. + + The image quality is set by it's compression level, a value of 10 sets maximum compression and a small file size but results in a bad quality image + while a value of 100 results in a large file but gives the best quality image. + + + - - Plays all hardcoded sounds in order. - + + Plays all hardcoded sounds in order. + - - writes current configuration to config/saved.cfg - automatic on quit - + + writes current configuration to config/saved.cfg - automatic on quit + - - registers a track as music - the first three tracks have special meaning. Track #1 is for "flag grab" the second and third are used as "last minute" tracks. - - - - + + registers a track as music - the first three tracks have special meaning. Track #1 is for "flag grab" the second and third are used as "last minute" tracks. + + + + - - - - - + + + + + - - Dump all command arguments to STDOUT - - - - + + Dump all command arguments to STDOUT + + + + - - - - - Toggles getting descriptive text from CGZ or DMO files in menudirlist. - - - - - + + + + + Toggles getting descriptive text from CGZ or DMO files in menudirlist. + + + + + - - Toggles physics interpolation. - - + + Toggles physics interpolation. + + - - create a menu listing of files from a path and perform an action on them when clicked. - - use this inside menu definitions, almost always as the only command of that menu. - compare the usage inside config/menus.cfg - - - - - - - - will create a list of maps and load them when clicked - - - - - - - + + create a menu listing of files from a path and perform an action on them when clicked. + + use this inside menu definitions, almost always as the only command of that menu. + compare the usage inside config/menus.cfg + + + + + + + + will create a list of maps and load them when clicked + + + + + + + - - Toggles the console. - + + Toggles the console. + - - Triggers a jump. - - default keys: space and right mouse. - - + + Triggers a jump. + + default keys: space and right mouse. + + - - Contacts the masterserver and adds any new servers to the server list. - - The servers are written to the config/servers.cfg file. This menu can be reached through the Multiplayer menu. - - - - - + + Contacts the masterserver and adds any new servers to the server list. + + The servers are written to the config/servers.cfg file. This menu can be reached through the Multiplayer menu. + + + + + - - Returns the number of milliseconds since engine start. - - - - - - - + + Returns the number of milliseconds since engine start. + + + + + + + - - seconds since the epoch (00:00:00 UTC on January 1, 1970) - - - - - - + + seconds since the epoch (00:00:00 UTC on January 1, 1970) + + + + + + - - a list of values for current time - - format: YYYY mm dd HH MM SS - - - - - - - - - - - - - + + a list of values for current time + + format: YYYY mm dd HH MM SS + + + + + + + + + + + + + - - representation of date - - format: Www Mmm dd hh:mm:ss yyyy - Use timestamp to create your own formatting. - - - - - - - + + representation of date + + format: Www Mmm dd hh:mm:ss yyyy + Use timestamp to create your own formatting. + + + + + + + - - the current time in (H)H:MM:SS format - - - - - - - - - + + the current time in (H)H:MM:SS format + + + + + + + + + - - Binds a key to a command. - - - To find out what key names and their default bindings are, look at config/keymap.cfg, - then add bind commands to your autoexec.cfg. - - - - - - - + + Binds a key to a command. + + + To find out what key names and their default bindings are, look at config/keymap.cfg, + then add bind commands to your autoexec.cfg. + + + + + + + - - Executes a command on the release of a key/button. - - This command must be placed in an action in a bind or in an alias in a bind. - - - - - - - - - - - - - + + Executes a command on the release of a key/button. + + This command must be placed in an action in a bind or in an alias in a bind. + + + + + + + + + + + + + - - Binds a name to commands. - - - - - - - - It is possible to re-bind an alias, even during its evaluation. - - - - There is also the shorthand version of defining an alias via the "="-sign. - - - + + Binds a name to commands. + + + + + + + + It is possible to re-bind an alias, even during its evaluation. + + + + There is also the shorthand version of defining an alias via the "="-sign. + + + - - Quits the game without asking. - + + Quits the game without asking. + - - Moves the player forward. - - default keys: W and Up Arrow - - + + Moves the player forward. + + default keys: W and Up Arrow + + - - Moves the player backward. - - default keys: S and Down Arrow - - + + Moves the player backward. + + default keys: S and Down Arrow + + - - Moves the player left. - - default keys: A and Left Arrow - - + + Moves the player left. + + default keys: A and Left Arrow + + - - Moves the player right. - - default keys: D and Right Arrow - - + + Moves the player right. + + default keys: D and Right Arrow + + - - Fires the current weapon. - - default: left mouse button - - + + Fires the current weapon. + + default: left mouse button + + - - Sets mouse to "flight sim" mode. - - - - + + Sets mouse to "flight sim" mode. + + + + - - Takes a screenshot. - - - Screenshots are saved to "screenshots/screenshotN.bmp", - where N is the number of milliseconds since the game was launched. - - - - - - + + Takes a screenshot. + + + Screenshots are saved to "screenshots/screenshotN.bmp", + where N is the number of milliseconds since the game was launched. + + + + + + - - Executes all commands in a specified config file. - - - - + + Executes all commands in a specified config file. + + + + - - Sets up the keymap for the specified key. - - You should never have to use this command manually, use "bind" instead. - - - - - - - - - - + + Sets up the keymap for the specified key. + + You should never have to use this command manually, use "bind" instead. + + + + + + + + + + - - Sets the mouse sensitivity. - - - - + + Sets the mouse sensitivity. + + + + - - Adds a server to the list of server to query in the server list menu. - - - - - + + Adds a server to the list of server to query in the server list menu. + + + + + - - Clears the list of secured maps. - - - - + + Clears the list of secured maps. + + + + - - Adds a map to the list of secured maps. - - Secured maps can not be overwritten by the commands sendmap and getmap. - - - - - - - - - - + + Adds a map to the list of secured maps. + + Secured maps can not be overwritten by the commands sendmap and getmap. + + + + + + + + + + - - Enables output of processed network packets. - - This variable only has an effect if the client binary is compiled in debug mode. - - - + + Enables output of processed network packets. + + This variable only has an effect if the client binary is compiled in debug mode. + + + - - Determines if the current played map should be automatically downloaded if it is not available locally. - - + + Determines if the current played map should be automatically downloaded if it is not available locally. + + - - Automatically get new map revisions from the server. - - + + Automatically get new map revisions from the server. + + - - Sets the correction value for clockfix. - - Engine source-code snippet (main.cpp): if(clockfix) millis = int(millis*(double(clockerror)/1000000)); - - - - - - + + Sets the correction value for clockfix. + + Engine source-code snippet (main.cpp): if(clockfix) millis = int(millis*(double(clockerror)/1000000)); + + + + + + - - Enables correction of the system clock. - - - - - + + Enables correction of the system clock. + + + + + - - Enable triangle debug. - - Prints details while connecting triangles of 3d models. - - - + + Enable triangle debug. + + Prints details while connecting triangles of 3d models. + + + - - Limits the FPS (frames per second) of the game. - - + + Limits the FPS (frames per second) of the game. + + - - Gets the maximum number of supported textures when performing multitexturing. - - + + Gets the maximum number of supported textures when performing multitexturing. + + - - Minimal level of detail. - - + + Minimal level of detail. + + - - Toggles use of acronyms instead of full modenames in the serverbrowser. - - + + Toggles use of acronyms instead of full modenames in the serverbrowser. + + - - Resets all binds back to their default values. - - - This command executes the file /config/resetbinds.cfg which will bind all keys to the values specified in that - file, thus resetting the binds to their default values. - - - + + Resets all binds back to their default values. + + + This command executes the file /config/resetbinds.cfg which will bind all keys to the values specified in that + file, thus resetting the binds to their default values. + + + - - Swaps your player to the enemy team. - + + Swaps your player to the enemy team. + - - Determines if all settings should be reset when the game quits. - - - It is recommended to quit the game immediately after enabling this setting. Note that the reset happens - only once as the value of this variable is reset as well. - - - - - - - + + Determines if all settings should be reset when the game quits. + + + It is recommended to quit the game immediately after enabling this setting. Note that the reset happens + only once as the value of this variable is reset as well. + + + + + + + - - Determines the valid distance when extrapolating a players position. - - + + Determines the valid distance when extrapolating a players position. + + - - Determines the speed when extrapolating a players position. - - + + Determines the speed when extrapolating a players position. + + - - Determines how fast network throttling accelerates. - - - - - - + + Determines how fast network throttling accelerates. + + + + + + - - Determines how fast network throttling decelerates. - - - - - - + + Determines how fast network throttling decelerates. + + + + + + - - Determines the interval of re-evaluating network throttling. - - - - - - + + Determines the interval of re-evaluating network throttling. + + + + + + - - Swaps vertices of model triangles. - - + + Swaps vertices of model triangles. + + - - Gets an integer representing the game version. READ ONLY - - As example, version 1.0 is represented as value 1000. - - + + Gets an integer representing the game version. READ ONLY + + As example, version 1.0 is represented as value 1000. + + - - Holds the current game mode. READ ONLY - - - - Output: 5 - - - - - - + + Holds the current game mode. READ ONLY + + + + Output: 5 + + + + + + - - Indicates if a connection to a server exists. - - + + Indicates if a connection to a server exists. + + - - Sets the maximum value the display will roll on strafing. - - + + Sets the maximum value the display will roll on strafing. + +
@@ -1109,7 +1109,12 @@ - + + Get the game demos listing from the server we are currently connected. + + + + @@ -1121,7 +1126,9 @@ - + + Drops the enemy flag. + Draws a shooting line in the direction of all available bots. @@ -3038,11 +3045,13 @@ Output: - + Turns on/off the radar compass + - + Turns on/off the damage indicator + @@ -3067,7 +3076,7 @@ Output: It may also be viewed as the speed at wich the console text dissapears. - + @@ -3103,53 +3112,53 @@ Output: - Time in milliseconds before the abovehead dissapears. - + Time in milliseconds before the abovehead icon dissapears. + Turns on or off the display of console text. - + Turns on or off the display of equipement icons. - + Turns on or off the display of messages at the bottom of the screen. - + Turns on or off the display of spectator staus. - + Turns on or off the display of flag icons. - + Turns on or off the display of local player team icons. - + Turns on or off the display of the on-screen radar. - + Turns on or off the display of vote icons. - + Turns on or off the display of the current selected gun. - + @@ -3195,29 +3204,29 @@ Output: - + Turns on/off display of team warning crosshair. - + Set the level of transparency of the damage indicator, 0 = is fully transparent, 100 = totaly solid. - + Sets the separation of the arrows in the damage indicator. - + Sets the size of the damage indicator. - + Sets how long the damage indicator stays on screen. - + @@ -3246,7 +3255,7 @@ Output: Sets the icon size of the players shown in the radar and the minimap. - + @@ -3337,7 +3346,7 @@ Output: Sets the transparency/opacity level of stencil shadows. - + @@ -3362,7 +3371,7 @@ Output: Sets the level of brightness to use when using the command "/fullbright 1". - + @@ -3403,17 +3412,17 @@ Output: Sets the size for the icon shown above a player using comunications voices. - + Sets the amount of time in milliseconds that blood is displayed on the ground. - + Turn on and off the display of blood. - + @@ -3537,11 +3546,13 @@ Output: - + Turns on/off the reflections in the water surface. + - + Turns on/off water refractions. + @@ -3613,7 +3624,8 @@ Output: - + Specifies the Field Of View when in spectating/ghost mode. + @@ -3629,11 +3641,13 @@ Output: - + Specifies how long (in milliseconds) to display bullet holes. + - + Turns on/off the display of bullet holes + @@ -3864,7 +3878,7 @@ Output: An argument represents either a command argument or a variable value. - The last argument of an identifier can be flagged as variable-length + The last argument of an identifier can be flagged as variable-length to indicate that it represents an unknown number of arguments. @@ -4007,7 +4021,7 @@ Output: - + If the server was run with -n1 and -n2 arguments (prefix and suffix of descriptive title) a serveradmin can set a user-defined server description with this command, if it wasn't this command results @@ -4289,7 +4303,7 @@ Output:
- + @@ -4509,7 +4523,7 @@ Output: - + @@ -4856,7 +4870,7 @@ Output: This section describes identifiers that are not documented yet, but you may try to help us there. - + TODO: Description