From 0980a152355ca42ebe9bbb54e68a839d3ba4a8ed Mon Sep 17 00:00:00 2001 From: RandumKiwi Date: Mon, 19 May 2008 09:40:08 +0000 Subject: [PATCH] removed some obsolete reference commands git-svn-id: svn://svn.code.sf.net/p/actiongame/code/trunk/ac@2051 e016b1c5-ed68-44aa-a2f7-31cac88cffde --- config/docs.cfg | 2352 ++++++++++++++++++++++---------------------- docs/reference.xml | 5 +- 2 files changed, 1182 insertions(+), 1175 deletions(-) diff --git a/config/docs.cfg b/config/docs.cfg index a41199b3..f02cebd6 100644 --- a/config/docs.cfg +++ b/config/docs.cfg @@ -60,9 +60,7 @@ docargument [S] [the string] [] [0]; docargument [N] [the index of the word] [] [0]; -docremark [The word is saved to the alias 's'.]; - -docexample [at "zero one two three" 2; echo $s] [output: two]; +docexample [echo (at "zero one two three" 2)] [output: two]; @@ -72,9 +70,7 @@ docargument [S] [the first string] [] [0]; docargument [...] [collection of strings to concatenate] [] [1]; -docremark [The newly created string is saved to the alias 's'.]; - -docexample [alias a "hello"; concat $a "world"; echo $s] [output: hello world]; +docexample [alias a "hello"; echo (concat $a "world")] [output: hello world]; @@ -86,7 +82,7 @@ docargument [...] [collection of strings to concatenate] [] [1]; docremark [The newly created string is saved to the alias 's'.]; -docexample [alias a "Cube"; concatword $a "Script"; echo $s] [output: CubeScript]; +docexample [alias a "Cube"; echo (concatword $a "Script")] [output: CubeScript]; @@ -140,13 +136,15 @@ docargument [B] [the divisor] [] [0]; -docident [numargs] []; +docident [numargs] [The number of arguments passed to the current alias]; -docargument [V] [] [min 0/max 25/default 0]; +docargument [V] [numargs] [ read-only]; -docident [rnd] []; +docident [rnd] [Random value]; + +docargument [A] [The upper limit of the random value] [] [0]; @@ -180,6 +178,390 @@ docexample [alias i 0; while [ (< $i 10) ] [ echo $i; alias i (+ $i 1) ]] []; +docsection [General] + + + +docident [addserver] [Adds a server to the list of server to query in the server list menu.]; + +docargument [S] [the name of the server (cn/ip)] [] [0]; + +docargument [P] [the port] [] [0]; + + + +docident [alias] [Binds a name to commands.]; + +docargument [N] [the name of the alias] [string, must not contain '$'] [0]; + +docargument [A] [the commands] [string] [0]; + +docremark [It is possible to re-bind an alias, even during its evaluation.]; + +docremark [Example: alias myalias [ echo "hello world"; alias myalias [ echo "I already said hello" ] ]]; + + + +docident [attack] [Fires the current weapon.]; + +docremark [default: left mouse button]; + + + +docident [autogetmap] []; + +docargument [V] [] [min 0/max 1/default 1]; + + + +docident [autoteam] [Sets the automated team assignement.]; + +docargument [B] [enables or disables auto team] [1 (on), 0 (off)] [0]; + +docremark [Requires master or admin state.]; + + + +docident [backward] [Moves the player backward.]; + +docremark [default keys: S and Down Arrow]; + + + +docident [ban] [Bans a specified player from the server.]; + +docargument [N] [the player to ban] [client number] [0]; + +docremark [Requires master or admin state. The ban duration is fixed to 20 minutes.]; + + + +docident [bind] [Binds a key to a command.]; + +docargument [K] [the key to bind] [string] [0]; + +docargument [A] [the command] [string, usually an alias] [0]; + +docremark [To find out what key names and their default bindings are, look at config/keymap.cfg, then add bind commands to your autoexec.cfg.]; + + + +docident [callvote] []; + + + +docident [clearsecuremaps] [Clears the list of secured maps.]; + + + +docident [clockerror] []; + +docargument [V] [] [min 990000/max 1010000/default 1000000]; + + + +docident [clockfix] []; + +docargument [V] [] [min 0/max 1/default 0]; + + + +docident [connected] [Indicates if a connection to a server exists.]; + +docargument [B] [the connection state] [1 (connected), 0 (disconnected) min 0/max 1/default 0]; + + + +docident [dbgts] []; + +docargument [V] [] [min 0/max 1/default 0]; + + + +docident [exec] [Executes all commands in a specified config file.]; + +docargument [C] [the config file] [] [0]; + + + +docident [forceteam] [Forces a specified player to join the enemy team.]; + +docargument [N] [the player to assign to a team] [client number] [0]; + +docremark [Requires master or admin state.]; + + + +docident [forward] [Moves the player forward.]; + +docremark [default keys: W and Up Arrow]; + + + +docident [gamemode] [Holds the current game mode.]; + +docargument [] [gamemode] [min 1/max 0/default 0]; + + + +docident [giveadmin] [Gives the admin state to the specified player.]; + +docargument [N] [the player to become master] [client number] [0]; + +docremark [Requires admin state. The admin will lose his admin state after successfully issuing this command.]; + + + +docident [invmouse] [Sets mouse to "flight sim" mode.]; + +docargument [B] [sets invmouse] [0 (off), else (on)] [0]; + + + +docident [jump] [Triggers a jump.]; + +docremark [default keys: space and right mouse.]; + + + +docident [keymap] [Sets up the keymap for the specified key.]; + +docargument [K] [the key to map] [] [0]; + +docargument [N] [the name for the key] [] [0]; + +docargument [A] [the default action] [] [0]; + +docremark [You should never have to use this command manually, use "bind" instead.]; + + + +docident [kick] [Kicks a specified player from the server.]; + +docargument [N] [the player to kick] [client number] [0]; + +docremark [Requires master or admin state.]; + + + +docident [left] [Moves the player left.]; + +docremark [default keys: A and Left Arrow]; + + + +docident [map] [Loads up a map in the gamemode set previously by the 'mode' command.]; + +docargument [M] [name of the map to load] [string] [0]; + +docremark [If connected to a multiplayer server, votes to load this map (others will have to type "map M" as well to agree with loading this map). To vote for a map with a specific mode, set the mode before you issue the map command (see multiplayer menu).]; + +docremark [A map given as "blah" refers to "packages/base/blah.cgz", "mypackage/blah" refers to "packages/mypackage/blah.cgz". At every map load, "config/default_map_settings.cfg" is loaded which sets up all texture definitions, etc. Everything defined in there can be overridden per package or per map by creating a "package.cfg" or "mapname.cfg" which contains whatever you want to do differently from the default.]; + +docremark [When the map finishes it will load the next map when one is defined, otherwise reloads the current map. You can define what map follows a particular map by making an alias like (in the map script): alias nextmap_blah1 blah2 (loads "blah2" after "blah1").]; + +docremark [TODO: multiplayer voting]; + + + +docident [mastermode] [Sets the mastermode for the server.]; + +docargument [N] [the master mode] [0 (open), 1 (private)] [0]; + +docremark [Requires master or admin state. If the mastermode is set to 'private', no more clients can join the server. Default is 'open' that allows anyone to join the server.]; + + + +docident [maxfps] []; + +docargument [V] [] [min 0/max 500/default 200]; + + + +docident [maxrecoil] []; + +docargument [V] [] [min 0/max 1000/default 1000]; + + + +docident [maxroll] [Sets the maximum value the display will roll on strafing.]; + +docargument [N] [the roll value] [min 0/max 20/default 0]; + + + +docident [maxtmus] []; + +docargument [V] [] [min 1/max 0/default 0]; + + + +docident [millis] [Returns the number of milliseconds since engine start.]; + +docexample [echo (millis)] []; + + + +docident [minlod] []; + +docargument [V] [] [min LOW_LOD/max MAX_LOD/default 60]; + + + +docident [minmillis] [Sets the minimum number of milliseconds a frame should take.]; + +docargument [N] [the number of milliseconds] [integer, 0 (off), default is 5] [0]; + +docremark [This is for very fast machines that run Cube at hundreds of fps. Default is 5, i.e. try to stay close to 200fps. This command is not exact, i.e. the precise delay it generates depends on OS and other factors... experiment with your ideal setting.]; + + + +docident [modeacronyms] [Turns on/off use of acronyms instead of full modenames in the serverbrowser.]; + +docargument [B] [] [min 0/max 1/default 0]; + + + +docident [onrelease] [Executes a command on the release of a key/button.]; + +docargument [A] [the command] [] [0]; + +docremark [This command must be placed in an action in a bind or in an alias in a bind.]; + +docexample [bind CTRL [ echo "key pressed"; onrelease [ echo "key released" ] ]] []; + + + +docident [quit] [Quits the game without asking.]; + + + +docident [rate] [Sets the clients maximum downstream bandwidth.]; + +docargument [N] [the bytes per second] [min 0/max 25000/default 0]; + +docremark [Leaving it at 0 (the default) means the server will dynamically try to do the best thing, this is recommended for players who don't have a clue what their bandwidth is (setting your rate unoptimally is worse than not setting it all). Modem players (56k) could try rate 4000 and tweak from there, dsl players can try rate 6000-10000. Note that the more players on a server, the more critical the effect of your rate. If you are tweak addicted, you can try playing with the variables throttle_decel (how quickly to start dropping packets when your connection becomes bandwidth limited) throttle_accel (how quickly to recover once bandwidth becomes available again) and throttle_interval (how quickly to reestimate the situation). Change the defaults at your own risk.]; + + + +docident [removebans] [Removes all bans on the server.]; + +docremark [Requires master or admin state.]; + + + +docident [resetcfg] []; + +docargument [V] [] [min 0/max 1/default 0]; + + + +docident [right] [Moves the player right.]; + +docremark [default keys: D and Right Arrow]; + + + +docident [screenshot] [Takes a screenshot.]; + +docremark [Screenshots are saved to "screenshots/screenshotN.bmp", where N is the number of milliseconds since the game was launched.]; + +dockey [F12] [] []; + + + +docident [searchlan] []; + +docargument [V] [] [min 0/max 1/default 0]; + + + +docident [securemap] [Adds a map to the list of secured maps.]; + +docargument [S] [the name of the map] [] [0]; + +docremark [Secured maps can not be overwritten by the commands sendmap and getmap.]; + + + +docident [sensitivity] [Sets the mouse sensitivity.]; + +docargument [S] [the sensitivity] [integer] [0]; + +docremark [With 'sensitivityscale' you can specify a number that the sensitivity is divided by.]; + + + +docident [setadmin] [Claims or drops admin status.]; + +docargument [B] [status] [1 (claim), 0 (drop)] [0]; + +docargument [P] [password] [max. 15 characters] [0]; + +docremark [Successfully claiming admin status revokes other players master or admin state automatically. Failed logins result in an auto kick. The admin is granted the right to kick, ban, remove bans, set autoteam and change the mastermode. In the scoreboard, the admin is marked red.]; + + + +docident [setmaster] [Claims or drops master status.]; + +docargument [B] [status] [1 (claim), 0 (drop)] [0]; + +docremark [Claiming master status is only possible if no other player is already master. In the scoreboard, the master is marked green.]; + + + +docident [smoothdist] []; + +docargument [V] [] [min 0/max 16/default 8]; + + + +docident [smoothmove] []; + +docargument [V] [] [min 0/max 100/default 75]; + + + +docident [throttle_accel] []; + +docargument [V] [] [min 0/max 32/default 2]; + + + +docident [throttle_decel] []; + +docargument [V] [] [min 0/max 32/default 2]; + + + +docident [throttle_interval] []; + +docargument [V] [] [min 0/max 30/default 5]; + + + +docident [toggleconsole] []; + + + +docident [tsswap] []; + +docargument [V] [] [min 0/max 1/default 1]; + + + +docident [updatefrommaster] [Contacts the masterserver and adds any new servers to the server list.]; + +docremark [The servers are written to the config/servers.cfg file. This menu can be reached through the Multiplayer menu.]; + + + +docident [version] []; + +docargument [V] [] [min 1/max 0/default AC_VERSION]; + + + docsection [Gameplay] @@ -188,6 +570,12 @@ docident [alive] []; +docident [autoreload] [Indicates if the weapons should be reloaded automatically.]; + +docargument [B] [the autoreload state] [on (1), off (0) min 0/max 1/default 1]; + + + docident [connect] [Connects to a server.]; docargument [N] [the (dns) name or ip of the server] [] [0]; @@ -278,42 +666,6 @@ docident [getmap] [Retrieves the last map that was sent to the server using 'sen -docident [hidectfhud] []; - -docargument [V] [] [min 0/max 1/default 0]; - - - -docident [hideradar] []; - -docargument [V] [] [min 0/max 1/default 0]; - - - -docident [hidestats] [Turns on/off display of fps/rendering stats on the HUD.]; - -docargument [B] [Turns the stats off (1) or on (0)] [min 0/max 1/default 1]; - - - -docident [hideteam] []; - -docargument [V] [] [min 0/max 1/default 0]; - - - -docident [hidevote] []; - -docargument [V] [] [min 0/max 1/default 0]; - - - -docident [hudgun] []; - -docargument [V] [] [min 0/max 1/default 1]; - - - docident [magcontent] [Returns contents of current magazine.]; docargument [N] [the weapon number] [0 (knife), 1 (pistol), 2 (shotgun), 3 (sub), 4 (sniper), 5 (assault), 6 (grenades)] [0]; @@ -428,7 +780,7 @@ dockey [F8] [] [follow spectator (see followmode)]; -docident [stop] [Stops any demo recording or playback.]; +docident [stopdemo] [Stops any demo recording or playback.]; @@ -456,1122 +808,6 @@ docargument [V] [] [min 0/max 1/default 1]; -docsection [General] - - - -docident [aadynshadow] [Sets the size/resolution of the dynamic shadow data.]; - -docargument [] [the size] [min 0/max 3/default 2]; - - - -docident [aboveheadiconfadetime] []; - -docargument [V] [] [min 1/max 10000/default 2000]; - - - -docident [aboveheadiconsize] []; - -docargument [V] [] [min 0/max 1000/default 50]; - - - -docident [addserver] [Adds a server to the list of server to query in the server list menu.]; - -docargument [S] [the name of the server (cn/ip)] [] [0]; - -docargument [P] [the port] [] [0]; - - - -docident [alias] [Binds a name to commands.]; - -docargument [N] [the name of the alias] [string, must not contain '$'] [0]; - -docargument [A] [the commands] [string] [0]; - -docremark [It is possible to re-bind an alias, even during its evaluation.]; - -docremark [Example: alias myalias [ echo "hello world"; alias myalias [ echo "I already said hello" ] ]]; - - - -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 [attack] [Fires the current weapon.]; - -docremark [default: left mouse button]; - - - -docident [autogetmap] []; - -docargument [V] [] [min 0/max 1/default 1]; - - - -docident [autoreload] [Indicates if the weapons should be reloaded automatically.]; - -docargument [B] [the autoreload state] [on (1), off (0) min 0/max 1/default 1]; - - - -docident [autoteam] [Sets the automated team assignement.]; - -docargument [B] [enables or disables auto team] [1 (on), 0 (off)] [0]; - -docremark [Requires master or admin state.]; - - - -docident [backward] [Moves the player backward.]; - -docremark [default keys: S and Down Arrow]; - - - -docident [ban] [Bans a specified player from the server.]; - -docargument [N] [the player to ban] [client number] [0]; - -docremark [Requires master or admin state. The ban duration is fixed to 20 minutes.]; - - - -docident [bilinear] []; - -docargument [V] [] [min 0/max 1/default 1]; - - - -docident [bind] [Binds a key to a command.]; - -docargument [K] [the key to bind] [string] [0]; - -docargument [A] [the command] [string, usually an alias] [0]; - -docremark [To find out what key names and their default bindings are, look at config/keymap.cfg, then add bind commands to your autoexec.cfg.]; - - - -docident [blood] []; - -docargument [V] [] [min 0/max 1/default 1]; - - - -docident [bloodttl] []; - -docargument [V] [] [min 0/max 30000/default 10000]; - - - -docident [bulletairsound] []; - -docargument [V] [] [min 0/max 1/default 1]; - - - -docident [bulletairsounddestrad] []; - -docargument [V] [] [min 0/max 1000/default 8]; - - - -docident [bulletairsoundrad] []; - -docargument [V] [] [min 0/max 1000/default 15]; - - - -docident [bulletairsoundsourcerad] []; - -docargument [V] [] [min 0/max 1000/default 8]; - - - -docident [bulletbouncesound] []; - -docargument [V] [] [min 0/max 1/default 1]; - - - -docident [bulletbouncesoundrad] []; - -docargument [V] [] [min 0/max 1000/default 15]; - - - -docident [bullethole] []; - -docargument [V] [] [min 0/max 1/default 1]; - - - -docident [bulletholettl] []; - -docargument [V] [] [min 0/max 30000/default 10000]; - - - -docident [callvote] []; - - - -docident [chmenumdl] [Changes the menu model of a specified menu.]; - -docargument [N] [the name of the menu] [] [0]; - -docargument [M] [the (new) model] [] [0]; - -docargument [A] [the animation to play] [] [0]; - -docargument [R] [the rotation speed] [] [0]; - -docargument [S] [the scale] [] [0]; - - - -docident [clearminimap] [Recreates the minimap for the current map.]; - - - -docident [clearsecuremaps] [Clears the list of secured maps.]; - - - -docident [clockerror] []; - -docargument [V] [] [min 990000/max 1010000/default 1000000]; - - - -docident [clockfix] []; - -docargument [V] [] [min 0/max 1/default 0]; - - - -docident [colorbits] [Sets the bits per pixel value.]; - -docargument [] [bits per pixel] [min 0/max 32/default 0]; - - - -docident [confade] []; - -docargument [V] [] [min 0/max 60/default 20]; - - - -docident [connected] [Indicates if a connection to a server exists.]; - -docargument [B] [the connection state] [1 (connected), 0 (disconnected) min 0/max 1/default 0]; - - - -docident [consize] []; - -docargument [V] [] [min 0/max 100/default 6]; - - - -docident [conskip] [Allows to browse through the console history by offsetting the console output.]; - -docargument [N] [the offset] [] [0]; - -dockey [KP_MINUS] [- on the keypad] [scrolls into the history (conskip 1)]; - -dockey [KP_PLUS] [+ on the keypad] [resets the history (conskip -1000)]; - - - -docident [crosshairfx] [Turns on or off crosshair effects.]; - -docargument [B] [Turns the effects on (1) or off (0)] [min 0/max 1/default 1]; - -docremark [When on, the crosshair will go grey when the weapon is reloading, orange when health se 50 or red when se 25.]; - - - -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] []; - -docargument [V] [] [min 0/max 1/default 1]; - - - -docident [damageindicatoralpha] []; - -docargument [V] [] [min 1/max 100/default 50]; - - - -docident [damageindicatordist] []; - -docargument [V] [] [min 0/max 10000/default 500]; - - - -docident [damageindicatorsize] []; - -docargument [V] [] [min 0/max 10000/default 200]; - - - -docident [damageindicatortime] []; - -docargument [V] [] [min 1/max 10000/default 1000]; - - - -docident [dbgts] []; - -docargument [V] [] [min 0/max 1/default 0]; - - - -docident [depthbits] [Sets the bits for the depth buffer.]; - -docargument [] [depth pixels] [min 0/max 32/default 0]; - - - -docident [docargument] [Adds a new argument documentation to the last added identifier.]; - -docargument [T] [the token] [] [0]; - -docargument [D] [the description] [] [0]; - -docargument [V] [the value notes] [] [0]; - -docargument [I] [flags this argument as variable-length] [1 (true), 0 (false)] [0]; - -docremark [An argument represents either a command argument or a variable value.]; - -docremark [The last argument of an identifier can be flagged as variable-length to indicate that it represents an unknown number of arguments.]; - - - -docident [docexample] [Adds an example to the last added identifier.]; - -docargument [C] [the example code] [] [0]; - -docargument [E] [the explanation] [] [0]; - - - -docident [docfind] [Searches the ingame docs for identifier documentations matching the specified search string.]; - -docargument [S] [the search string] [] [0]; - -docremark [The name, description and remarks are included in the search.]; - - - -docident [docident] [Adds a new identifier documentation to the last added section.]; - -docargument [N] [name of the identifier] [] [0]; - -docargument [D] [the description] [] [0]; - -docremark [An identifier represents a command or variable. The new identifier]; - -docremark [The name may countain spaces to create a "multipart" identifier documentation that can be used to describe a complex argument as a single pseudo identifier, look at the examples.]; - -docexample [docident fov "Sets the field of view."] []; - -docexample [docident "newent light" "Adds a new light entitiy."] []; - - - -docident [docinvalid] [Outputs a list of identifer documentations that do not match any existing identifer.]; - -docremark [Multipart identifiers are not included in this list, see 'docident'.]; - - - -docident [dockey] []; - - - -docident [docref] [Adds a new documentation reference to an identifier.]; - -docargument [N] [the display name] [] [0]; - -docargument [I] [the identifier to refer to] [] [0]; - -docargument [U] [the URL to refer to] [] [0]; - -docremark [The new reference is added to the last added identifier documentation.]; - - - -docident [docremark] [Adds a new documentation remark to the last added identifier.]; - -docargument [S] [the remark] [] [0]; - - - -docident [docsection] [Adds a new section to the ingame documentation.]; - -docargument [S] [the section name] [] [0]; - - - -docident [docskip] []; - -docargument [V] [] [min 0/max 1000/default 0]; - - - -docident [docundone] [Outputs a list of yet undocumented identifiers (commands,variables, etc)]; - -docargument [A] [output all identifiers] [1 (true), 0 (false)] [0]; - -docremark [If the one argument is omitted, only the builtin identifiers will be listed. Therefore specify the argument other identifers like aliases should be included too.]; - -docremark [Note that the list also includes identifiers that contain the substrings "TODO" or "UNDONE" in their documentation.]; - - - -docident [docvisible] []; - -docargument [V] [] [min 0/max 1/default 1]; - - - -docident [docwritebaseref] [Writes out a base XML documentation reference containing templates for the builtin identifiers.]; - -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.]; - - - -docident [dynlight] [Determines wether dynamic shadows and lights are rendered, providedjust incase they slow your fps down too much.]; - -docargument [R] [the radius of a dynamic light] [min 0/max 32/default 16]; - -docremark [With radius you can specify the radius of a dynamic light, smaller to maybe gain some speed (0 is off entirely), or bigger to see the effect of dynamic shadows more dramatically (try shooting it past some pillars that have a dark area on the other side... or use the "gamespeed" variable).]; - - - -docident [dynshadow] [Sets the alpha value (transparency) for dynamic shadows.]; - -docargument [] [the alpha value] [min 0/max 100/default 40]; - - - -docident [dynshadowsize] [Sets the display size of the dynamic shadows.]; - -docargument [] [the size] [min 4/max 8/default 5]; - - - -docident [exec] [Executes all commands in a specified config file.]; - -docargument [C] [the config file] [] [0]; - - - -docident [fog] [Sets the fog distance.]; - -docargument [N] [the fog distance] [integer, default is 160] [0]; - -docremark [You can do this for tweaking the visual effect of the fog, or if you are on a slow machine, setting the fog to a low value can also be a very effective way to increase fps (if you are geometry limited). Try out different values on big maps / maps which give you low fps.]; - - - -docident [fogcolour] [Sets fog and clearing colour.]; - -docargument [C] [the colour] [integer, default is 0x8099B3] [0]; - -docremark [This and the fog variable can be set in the map config file.]; - - - -docident [font] []; - - - -docident [fontchar] []; - - - -docident [forceteam] [Forces a specified player to join the enemy team.]; - -docargument [N] [the player to assign to a team] [client number] [0]; - -docremark [Requires master or admin state.]; - - - -docident [forward] [Moves the player forward.]; - -docremark [default keys: W and Up Arrow]; - - - -docident [fov] [Sets the field of view (fov).]; - -docargument [N] [the fov value] [90..120] [0]; - - - -docident [fsaa] [Sets the level of fullscreen antialiasing (FSAA).]; - -docargument [] [fsaa] [min 0/max 16/default 0]; - - - -docident [fullscreen] [Enables or disables fullscreen.]; - -docargument [] [fullscreen] [min 0/max 1/default 1]; - -docremark [Not supported on Windows and Mac.]; - - - -docident [gamemode] [Holds the current game mode.]; - -docargument [] [gamemode] [min 1/max 0/default 0]; - - - -docident [gamma] [Sets the hardware gamma value.]; - -docargument [N] [the gamma value] [min 30/max 300/default 100]; - -docremark [May not work if your card/driver doesn't support it.]; - - - -docident [gibnum] [Sets the number of gibs to display when performing a "messy" kill (grenade, knife, sniper headshot).]; - -docargument [N] [number of gibs] [min 0/max 1000/default 6]; - -docremark [Larger values are more spectacular, but can slow down less powerful machines. Reducing gibttl may help in this case.]; - - - -docident [gibspeed] [Sets the velocity at which gibs will fly from a victim.]; - -docargument [N] [velocity] [min 1/max 100/default 30]; - - - -docident [gibttl] [Sets the time for gibs to live (in milliseconds), after which they will disappear.]; - -docargument [N] [time to live] [min 0/max 15000/default 5000]; - - - -docident [giveadmin] [Gives the admin state to the specified player.]; - -docargument [N] [the player to become master] [client number] [0]; - -docremark [Requires admin state. The admin will lose his admin state after successfully issuing this command.]; - - - -docident [hideconsole] []; - -docargument [V] [] [min 0/max 1/default 0]; - - - -docident [hidehudequipment] []; - -docargument [V] [] [min 0/max 1/default 0]; - - - -docident [hidehudmsgs] []; - -docargument [V] [] [min 0/max 1/default 0]; - - - -docident [hidespecthud] []; - -docargument [V] [] [min 0/max 1/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 0" to a key allows to quickly repeat the last command typed in (useful for placing many identical entities etc.)]; - - - -docident [hwtexsize] []; - -docargument [V] [] [min 1/max 0/default 0]; - - - -docident [invmouse] [Sets mouse to "flight sim" mode.]; - -docargument [B] [sets invmouse] [0 (off), else (on)] [0]; - - - -docident [jump] [Triggers a jump.]; - -docremark [default keys: space and right mouse.]; - - - -docident [keymap] [Sets up the keymap for the specified key.]; - -docargument [K] [the key to map] [] [0]; - -docargument [N] [the name for the key] [] [0]; - -docargument [A] [the default action] [] [0]; - -docremark [You should never have to use this command manually, use "bind" instead.]; - - - -docident [kick] [Kicks a specified player from the server.]; - -docargument [N] [the player to kick] [client number] [0]; - -docremark [Requires master or admin state.]; - - - -docident [left] [Moves the player left.]; - -docremark [default keys: A and Left Arrow]; - - - -docident [lighterror] [Allows to finetune the amount of "error" the mipmapper/stripifier allow themselves for changing lightlevels.]; - -docargument [E] [the error value, 1 being the best quality] [ read-only]; - -docremark [If this variable is changed this during play, a "recalc" is needed to see the effect.]; - - - -docident [lightscale] [Used to finetune the "overbright lighting" rendering feature when enabled.]; - -docargument [N] [the brightness of the scene] [min 1/max 100/default 4]; - -docremark [After changing this value, a "recalc" is needed to see the differences.]; - - - -docident [map] [Loads up a map in the gamemode set previously by the 'mode' command.]; - -docargument [M] [name of the map to load] [string] [0]; - -docremark [If connected to a multiplayer server, votes to load this map (others will have to type "map M" as well to agree with loading this map). To vote for a map with a specific mode, set the mode before you issue the map command (see multiplayer menu).]; - -docremark [A map given as "blah" refers to "packages/base/blah.cgz", "mypackage/blah" refers to "packages/mypackage/blah.cgz". At every map load, "config/default_map_settings.cfg" is loaded which sets up all texture definitions, etc. Everything defined in there can be overridden per package or per map by creating a "package.cfg" or "mapname.cfg" which contains whatever you want to do differently from the default.]; - -docremark [When the map finishes it will load the next map when one is defined, otherwise reloads the current map. You can define what map follows a particular map by making an alias like (in the map script): alias nextmap_blah1 blah2 (loads "blah2" after "blah1").]; - -docremark [TODO: multiplayer voting]; - - - -docident [mastermode] [Sets the mastermode for the server.]; - -docargument [N] [the master mode] [0 (open), 1 (private)] [0]; - -docremark [Requires master or admin state. If the mastermode is set to 'private', no more clients can join the server. Default is 'open' that allows anyone to join the server.]; - - - -docident [maxfps] []; - -docargument [V] [] [min 0/max 500/default 200]; - - - -docident [maxrecoil] []; - -docargument [V] [] [min 0/max 1000/default 1000]; - - - -docident [maxroll] [Sets the maximum value the display will roll on strafing.]; - -docargument [N] [the roll value] [min 0/max 20/default 0]; - - - -docident [maxsoundsatonce] []; - -docargument [V] [] [min 0/max 100/default 40]; - - - -docident [maxtexsize] []; - -docargument [V] [] [min 0/max 4096/default 0]; - - - -docident [maxtmus] []; - -docargument [V] [] [min 1/max 0/default 0]; - - - -docident [menuitem] [Creates a new menuitem.]; - -docargument [N] [the name of the menuitem] [] [0]; - -docargument [A] [the action on selection] [] [0]; - -docremark [If the action argument is omitted, then it will be set to the same value as the description. Upon pressing return, the associated action will be executed. See config/menus.cfg for examples.]; - - - -docident [menumdl] [Specifies a model to render while displaying the last added menu.]; - -docargument [M] [the model] [] [0]; - -docargument [A] [the animation to play] [] [0]; - -docargument [R] [the rotation speed] [] [0]; - -docargument [S] [the scale] [] [0]; - - - -docident [mergestrips] []; - -docargument [V] [] [min 0/max 1/default 1]; - - - -docident [millis] [Returns the number of milliseconds since engine start.]; - -docexample [echo (millis)] []; - - - -docident [minframetime] []; - -docargument [V] [] [min 5/max 20/default 10]; - - - -docident [minimapres] [Sets the resolution for the minimap.]; - -docargument [N] [the resoution] [min 7/max 10/default 9]; - - - -docident [minlod] []; - -docargument [V] [] [min LOW_LOD/max MAX_LOD/default 60]; - - - -docident [minmillis] [Sets the minimum number of milliseconds a frame should take.]; - -docargument [N] [the number of milliseconds] [integer, 0 (off), default is 5] [0]; - -docremark [This is for very fast machines that run Cube at hundreds of fps. Default is 5, i.e. try to stay close to 200fps. This command is not exact, i.e. the precise delay it generates depends on OS and other factors... experiment with your ideal setting.]; - - - -docident [modeacronyms] [Turns on/off use of acronyms instead of full modenames in the serverbrowser.]; - -docargument [B] [] [min 0/max 1/default 0]; - - - -docident [mtexplosion] []; - -docargument [V] [] [min 0/max 1/default 1]; - - - -docident [mtwater] []; - -docargument [V] [] [min 0/max 1/default 1]; - - - -docident [musicvol] [Sets the music volume.]; - -docargument [N] [the volume] [0..255] [0]; - - - -docident [newmenu] [Creates a new menu.]; - -docargument [N] [the name of the menu] [] [0]; - - - -docident [nosway] []; - -docargument [V] [] [min 0/max 1/default 0]; - - - -docident [onrelease] [Executes a command on the release of a key/button.]; - -docargument [A] [the command] [] [0]; - -docremark [This command must be placed in an action in a bind or in an alias in a bind.]; - -docexample [bind CTRL [ echo "key pressed"; onrelease [ echo "key released" ] ]] []; - - - -docident [particlesize] [Scales all particles.]; - -docargument [P] [the scale percentage] [min 20/max 500/default 100]; - - - -docident [quit] [Quits the game without asking.]; - - - -docident [radarentsize] []; - -docargument [V] [] [min 1/max 64/default 4]; - - - -docident [radarres] []; - -docargument [V] [] [min 1/max 1024/default 64]; - - - -docident [rate] [Sets the clients maximum downstream bandwidth.]; - -docargument [N] [the bytes per second] [min 0/max 25000/default 0]; - -docremark [Leaving it at 0 (the default) means the server will dynamically try to do the best thing, this is recommended for players who don't have a clue what their bandwidth is (setting your rate unoptimally is worse than not setting it all). Modem players (56k) could try rate 4000 and tweak from there, dsl players can try rate 6000-10000. Note that the more players on a server, the more critical the effect of your rate. If you are tweak addicted, you can try playing with the variables throttle_decel (how quickly to start dropping packets when your connection becomes bandwidth limited) throttle_accel (how quickly to recover once bandwidth becomes available again) and throttle_interval (how quickly to reestimate the situation). Change the defaults at your own risk.]; - - - -docident [recoilbackfade] []; - -docargument [V] [] [min 0/max 1000/default 100]; - - - -docident [recoilbase] []; - -docargument [V] [] [min 0/max 1000/default 40]; - - - -docident [recoilincrease] []; - -docargument [V] [] [min 1/max 10/default 2]; - - - -docident [recoiltest] []; - -docargument [V] [] [min 0/max 1/default 0]; - - - -docident [reflectclip] []; - -docargument [V] [] [min 0/max 100/default 3]; - - - -docident [reflectres] []; - -docargument [V] [] [min 6/max 10/default 8]; - - - -docident [reflectscissor] []; - -docargument [V] [] [min 0/max 1/default 1]; - - - -docident [removebans] [Removes all bans on the server.]; - -docremark [Requires master or admin state.]; - - - -docident [resetcfg] []; - -docargument [V] [] [min 0/max 1/default 0]; - - - -docident [right] [Moves the player right.]; - -docremark [default keys: D and Right Arrow]; - - - -docident [saveshadows] [Sets if dynamic shadows should be saved to disk.]; - -docargument [] [auto save] [min 0/max 1/default 1]; - - - -docident [scorch] []; - -docargument [V] [] [min 0/max 1/default 1]; - - - -docident [scorchttl] []; - -docargument [V] [] [min 0/max 30000/default 10000]; - - - -docident [screenshot] [Takes a screenshot.]; - -docremark [Screenshots are saved to "screenshots/screenshotN.bmp", where N is the number of milliseconds since the game was launched.]; - -dockey [F12] [] []; - - - -docident [scr_h] [Sets the screen height.]; - -docargument [] [the screen height] [min 0/max 768/default 10000]; - - - -docident [scr_w] [Sets the screen width.]; - -docargument [] [the screen width] [min 0/max 1024/default 10000]; - - - -docident [searchlan] []; - -docargument [V] [] [min 0/max 1/default 0]; - - - -docident [securemap] [Adds a map to the list of secured maps.]; - -docargument [S] [the name of the map] [] [0]; - -docremark [Secured maps can not be overwritten by the commands sendmap and getmap.]; - - - -docident [sensitivity] [Sets the mouse sensitivity.]; - -docargument [S] [the sensitivity] [integer] [0]; - -docremark [With 'sensitivityscale' you can specify a number that the sensitivity is divided by.]; - - - -docident [setadmin] [Claims or drops admin status.]; - -docargument [B] [status] [1 (claim), 0 (drop)] [0]; - -docargument [P] [password] [max. 15 characters] [0]; - -docremark [Successfully claiming admin status revokes other players master or admin state automatically. Failed logins result in an auto kick. The admin is granted the right to kick, ban, remove bans, set autoteam and change the mastermode. In the scoreboard, the admin is marked red.]; - - - -docident [setmaster] [Claims or drops master status.]; - -docargument [B] [status] [1 (claim), 0 (drop)] [0]; - -docremark [Claiming master status is only possible if no other player is already master. In the scoreboard, the master is marked green.]; - - - -docident [shotline] []; - -docargument [V] [] [min 0/max 1/default 1]; - - - -docident [shotlinettl] []; - -docargument [V] [] [min 0/max 10000/default 75]; - - - -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.]; - - - -docident [smoothdist] []; - -docargument [V] [] [min 0/max 16/default 8]; - - - -docident [smoothmove] []; - -docargument [V] [] [min 0/max 100/default 75]; - - - -docident [soundbufferlen] [Sets the sound buffer length.]; - -docargument [N] [the buffer length] [min 128/max 4096/default 1024]; - -docremark [Tweak this if you experience stuttering or lagging sound.]; - - - -docident [soundvol] [Sets the sound volume.]; - -docargument [N] [the volume] [min 0/max 255/default 155]; - - - -docident [spectfov] []; - -docargument [V] [] [min 5/max 120/default 120]; - - - -docident [swaymovediv] []; - -docargument [V] [] [min 1/max 1000/default 200]; - - - -docident [swayspeeddiv] []; - -docargument [V] [] [min 1/max 1000/default 105]; - - - -docident [swayupmovediv] []; - -docargument [V] [] [min 1/max 1000/default 200]; - - - -docident [swayupspeeddiv] []; - -docargument [V] [] [min 1/max 1000/default 105]; - - - -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.]; - - - -docident [throttle_accel] []; - -docargument [V] [] [min 0/max 32/default 2]; - - - -docident [throttle_decel] []; - -docargument [V] [] [min 0/max 32/default 2]; - - - -docident [throttle_interval] []; - -docargument [V] [] [min 0/max 30/default 5]; - - - -docident [toggleconsole] []; - - - -docident [trilinear] []; - -docargument [V] [] [min 0/max 1/default 1]; - - - -docident [tsswap] []; - -docargument [V] [] [min 0/max 1/default 1]; - - - -docident [updatefrommaster] [Contacts the masterserver and adds any new servers to the server list.]; - -docremark [The servers are written to the config/servers.cfg file. This menu can be reached through the Multiplayer menu.]; - - - -docident [version] []; - -docargument [V] [] [min 1/max 0/default AC_VERSION]; - - - -docident [vsync] [Enables or disables vsync.]; - -docargument [] [vsync] [min -1/max 1/default -1]; - - - -docident [waterreflect] []; - -docargument [V] [] [min 0/max 1/default 1]; - - - -docident [waterrefract] []; - -docargument [V] [] [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.]; - - - docsection [Editing] @@ -1684,6 +920,22 @@ docargument [] [flrceil] [0 (floor), 2 (ceiling) read-only]; +docident [fog] [Sets the fog distance.]; + +docargument [N] [the fog distance] [integer, default is 160] [0]; + +docremark [You can do this for tweaking the visual effect of the fog, or if you are on a slow machine, setting the fog to a low value can also be a very effective way to increase fps (if you are geometry limited). Try out different values on big maps / maps which give you low fps.]; + + + +docident [fogcolour] [Sets fog and clearing colour.]; + +docargument [C] [the colour] [integer, default is 0x8099B3] [0]; + +docremark [This and the fog variable can be set in the map config file.]; + + + docident [fullbright] [Sets all light values to fullbright.]; docargument [B] [sets fullbright on or off] [0 (off), 1 (on)] [0]; @@ -1702,6 +954,14 @@ docremark [Heightfields should be made the exact size that is needed, not more n +docident [lightscale] [Used to finetune the "overbright lighting" rendering feature when enabled.]; + +docargument [N] [the brightness of the scene] [min 1/max 100/default 4]; + +docremark [After changing this value, a "recalc" is needed to see the differences.]; + + + docident [loadsky] [Loads the skybox P]; docargument [P] [path to the six skybox textures] [string] [0]; @@ -1972,14 +1232,6 @@ docremark [This operation retains floor/ceiling heights/textures while swapping -docident [sound] [Plays the specified sound.]; - -docargument [S] [the sound to play] [string, see config/sounds.cfg] [0]; - -docremark [See config/sounds.cfg for default sounds, and use registersound to register your own. For example, sound 0 and sound (registersound "aard/jump") both play the standard jump sound.]; - - - docident [texture] [Binds a texture to the current texture slot.]; docargument [S] [number of a secondary texture (unused)] [string] [0]; @@ -2038,4 +1290,762 @@ docremark [Performance notes: water is rendered for a whole square encapsulating +docsection [Menu] + + + +docident [chmenumdl] [Changes the menu model of a specified menu.]; + +docargument [N] [the name of the menu] [] [0]; + +docargument [M] [the (new) model] [] [0]; + +docargument [A] [the animation to play] [] [0]; + +docargument [R] [the rotation speed] [] [0]; + +docargument [S] [the scale] [] [0]; + + + +docident [menuinit] [Specifies a block of commands to be executed when menu opens.]; + +docargument [C] [the code to execute on init] [] [0]; + + + +docident [menuitem] [Creates a new menuitem.]; + +docargument [N] [the name of the menuitem] [] [0]; + +docargument [A] [the action on selection] [] [0]; + +docremark [If the action argument is omitted, then it will be set to the same value as the description. Upon pressing return, the associated action will be executed. See config/menus.cfg for examples.]; + + + +docident [menumdl] [Specifies a model to render while displaying the last added menu.]; + +docargument [M] [the model] [] [0]; + +docargument [A] [the animation to play] [] [0]; + +docargument [R] [the rotation speed] [] [0]; + +docargument [S] [the scale] [] [0]; + + + +docident [newmenu] [Creates a new menu.]; + +docargument [N] [the name of the menu] [] [0]; + + + +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 [HUD] + + + +docident [aboveheadiconfadetime] []; + +docargument [V] [] [min 1/max 10000/default 2000]; + + + +docident [clearminimap] [Recreates the minimap for the current map.]; + + + +docident [confade] []; + +docargument [V] [] [min 0/max 60/default 20]; + + + +docident [consize] []; + +docargument [V] [] [min 0/max 100/default 6]; + + + +docident [conskip] [Allows to browse through the console history by offsetting the console output.]; + +docargument [N] [the offset] [] [0]; + +dockey [KP_MINUS] [- on the keypad] [scrolls into the history (conskip 1)]; + +dockey [KP_PLUS] [+ on the keypad] [resets the history (conskip -1000)]; + + + +docident [crosshairfx] [Turns on or off crosshair effects.]; + +docargument [B] [Turns the effects on (1) or off (0)] [min 0/max 1/default 1]; + +docremark [When on, the crosshair will go grey when the weapon is reloading, orange when health se 50 or red when se 25.]; + + + +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] []; + +docargument [V] [] [min 0/max 1/default 1]; + + + +docident [damageindicatoralpha] []; + +docargument [V] [] [min 1/max 100/default 50]; + + + +docident [damageindicatordist] []; + +docargument [V] [] [min 0/max 10000/default 500]; + + + +docident [damageindicatorsize] []; + +docargument [V] [] [min 0/max 10000/default 200]; + + + +docident [damageindicatortime] []; + +docargument [V] [] [min 1/max 10000/default 1000]; + + + +docident [hideconsole] []; + +docargument [V] [] [min 0/max 1/default 0]; + + + +docident [hidectfhud] []; + +docargument [V] [] [min 0/max 1/default 0]; + + + +docident [hidehudequipment] []; + +docargument [V] [] [min 0/max 1/default 0]; + + + +docident [hidehudmsgs] []; + +docargument [V] [] [min 0/max 1/default 0]; + + + +docident [hideradar] []; + +docargument [V] [] [min 0/max 1/default 0]; + + + +docident [hidespecthud] []; + +docargument [V] [] [min 0/max 1/default 0]; + + + +docident [hidestats] [Turns on/off display of fps/rendering stats on the HUD.]; + +docargument [B] [Turns the stats off (1) or on (0)] [min 0/max 1/default 1]; + + + +docident [hideteam] []; + +docargument [V] [] [min 0/max 1/default 0]; + + + +docident [hidevote] []; + +docargument [V] [] [min 0/max 1/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 0" to a key allows to quickly repeat the last command typed in (useful for placing many identical entities etc.)]; + + + +docident [hudgun] []; + +docargument [V] [] [min 0/max 1/default 1]; + + + +docident [minimapres] [Sets the resolution for the minimap.]; + +docargument [N] [the resoution] [min 7/max 10/default 9]; + + + +docident [nosway] []; + +docargument [V] [] [min 0/max 1/default 0]; + + + +docident [radarentsize] []; + +docargument [V] [] [min 1/max 64/default 4]; + + + +docident [radarres] []; + +docargument [V] [] [min 1/max 1024/default 64]; + + + +docident [recoilbackfade] []; + +docargument [V] [] [min 0/max 1000/default 100]; + + + +docident [recoilbase] []; + +docargument [V] [] [min 0/max 1000/default 40]; + + + +docident [recoilincrease] []; + +docargument [V] [] [min 1/max 10/default 2]; + + + +docident [recoiltest] []; + +docargument [V] [] [min 0/max 1/default 0]; + + + +docident [swaymovediv] []; + +docargument [V] [] [min 1/max 1000/default 200]; + + + +docident [swayspeeddiv] []; + +docargument [V] [] [min 1/max 1000/default 105]; + + + +docident [swayupmovediv] []; + +docargument [V] [] [min 1/max 1000/default 200]; + + + +docident [swayupspeeddiv] []; + +docargument [V] [] [min 1/max 1000/default 105]; + + + +docsection [Visuals] + + + +docident [aadynshadow] [Sets the size/resolution of the dynamic shadow data.]; + +docargument [] [the size] [min 0/max 3/default 2]; + + + +docident [aboveheadiconsize] []; + +docargument [V] [] [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 [bilinear] []; + +docargument [V] [] [min 0/max 1/default 1]; + + + +docident [blood] []; + +docargument [V] [] [min 0/max 1/default 1]; + + + +docident [bloodttl] []; + +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]; + + + +docident [colorbits] [Sets the bits per pixel value.]; + +docargument [] [bits per pixel] [min 0/max 32/default 0]; + + + +docident [depthbits] [Sets the bits for the depth buffer.]; + +docargument [] [depth pixels] [min 0/max 32/default 0]; + + + +docident [dynlight] [Determines wether dynamic shadows and lights are rendered, providedjust incase they slow your fps down too much.]; + +docargument [R] [the radius of a dynamic light] [min 0/max 32/default 16]; + +docremark [With radius you can specify the radius of a dynamic light, smaller to maybe gain some speed (0 is off entirely), or bigger to see the effect of dynamic shadows more dramatically (try shooting it past some pillars that have a dark area on the other side... or use the "gamespeed" variable).]; + + + +docident [dynshadow] [Sets the alpha value (transparency) for dynamic shadows.]; + +docargument [] [the alpha value] [min 0/max 100/default 40]; + + + +docident [dynshadowsize] [Sets the display size of the dynamic shadows.]; + +docargument [] [the size] [min 4/max 8/default 5]; + + + +docident [font] []; + + + +docident [fontchar] []; + + + +docident [fov] [Sets the field of view (fov).]; + +docargument [N] [the fov value] [90..120] [0]; + + + +docident [fsaa] [Sets the level of fullscreen antialiasing (FSAA).]; + +docargument [] [fsaa] [min 0/max 16/default 0]; + + + +docident [fullscreen] [Enables or disables fullscreen.]; + +docargument [] [fullscreen] [min 0/max 1/default 1]; + +docremark [Not supported on Windows and Mac.]; + + + +docident [gamma] [Sets the hardware gamma value.]; + +docargument [N] [the gamma value] [min 30/max 300/default 100]; + +docremark [May not work if your card/driver doesn't support it.]; + + + +docident [gibnum] [Sets the number of gibs to display when performing a "messy" kill (grenade, knife, sniper headshot).]; + +docargument [N] [number of gibs] [min 0/max 1000/default 6]; + +docremark [Larger values are more spectacular, but can slow down less powerful machines. Reducing gibttl may help in this case.]; + + + +docident [gibspeed] [Sets the velocity at which gibs will fly from a victim.]; + +docargument [N] [velocity] [min 1/max 100/default 30]; + + + +docident [gibttl] [Sets the time for gibs to live (in milliseconds), after which they will disappear.]; + +docargument [N] [time to live] [min 0/max 15000/default 5000]; + + + +docident [hwtexsize] []; + +docargument [V] [] [min 1/max 0/default 0]; + + + +docident [lighterror] [Allows to finetune the amount of "error" the mipmapper/stripifier allow themselves for changing lightlevels.]; + +docargument [E] [the error value, 1 being the best quality] [ read-only]; + +docremark [If this variable is changed this during play, a "recalc" is needed to see the effect.]; + + + +docident [maxtexsize] []; + +docargument [V] [] [min 0/max 4096/default 0]; + + + +docident [mergestrips] []; + +docargument [V] [] [min 0/max 1/default 1]; + + + +docident [mtexplosion] []; + +docargument [V] [] [min 0/max 1/default 1]; + + + +docident [mtwater] []; + +docargument [V] [] [min 0/max 1/default 1]; + + + +docident [particlesize] [Scales all particles.]; + +docargument [P] [the scale percentage] [min 20/max 500/default 100]; + + + +docident [reflectclip] []; + +docargument [V] [] [min 0/max 100/default 3]; + + + +docident [reflectres] []; + +docargument [V] [] [min 6/max 10/default 8]; + + + +docident [reflectscissor] []; + +docargument [V] [] [min 0/max 1/default 1]; + + + +docident [saveshadows] [Sets if dynamic shadows should be saved to disk.]; + +docargument [] [auto save] [min 0/max 1/default 1]; + + + +docident [scorch] []; + +docargument [V] [] [min 0/max 1/default 1]; + + + +docident [scorchttl] []; + +docargument [V] [] [min 0/max 30000/default 10000]; + + + +docident [scr_h] [Sets the screen height.]; + +docargument [] [the screen height] [min 0/max 768/default 10000]; + + + +docident [scr_w] [Sets the screen width.]; + +docargument [] [the screen width] [min 0/max 1024/default 10000]; + + + +docident [shotline] []; + +docargument [V] [] [min 0/max 1/default 1]; + + + +docident [shotlinettl] []; + +docargument [V] [] [min 0/max 10000/default 75]; + + + +docident [spectfov] []; + +docargument [V] [] [min 5/max 120/default 120]; + + + +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.]; + + + +docident [trilinear] []; + +docargument [V] [] [min 0/max 1/default 1]; + + + +docident [vsync] [Enables or disables vsync.]; + +docargument [] [vsync] [min -1/max 1/default -1]; + + + +docident [waterreflect] []; + +docargument [V] [] [min 0/max 1/default 1]; + + + +docident [waterrefract] []; + +docargument [V] [] [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.]; + + + +docsection [Sound] + + + +docident [bulletairsound] []; + +docargument [V] [] [min 0/max 1/default 1]; + + + +docident [bulletairsounddestrad] []; + +docargument [V] [] [min 0/max 1000/default 8]; + + + +docident [bulletairsoundrad] []; + +docargument [V] [] [min 0/max 1000/default 15]; + + + +docident [bulletairsoundsourcerad] []; + +docargument [V] [] [min 0/max 1000/default 8]; + + + +docident [bulletbouncesound] []; + +docargument [V] [] [min 0/max 1/default 1]; + + + +docident [bulletbouncesoundrad] []; + +docargument [V] [] [min 0/max 1000/default 15]; + + + +docident [maxsoundsatonce] []; + +docargument [V] [] [min 0/max 100/default 40]; + + + +docident [musicvol] [Sets the music volume.]; + +docargument [N] [the volume] [0..255] [0]; + + + +docident [sound] [Plays the specified sound.]; + +docargument [S] [the sound to play] [string, see config/sounds.cfg] [0]; + +docremark [See config/sounds.cfg for default sounds, and use registersound to register your own. For example, sound 0 and sound (registersound "aard/jump") both play the standard jump sound.]; + + + +docident [soundvol] [Sets the sound volume.]; + +docargument [N] [the volume] [min 0/max 255/default 155]; + + + +docsection [Ingame Reference] + + + +docident [docargument] [Adds a new argument documentation to the last added identifier.]; + +docargument [T] [the token] [] [0]; + +docargument [D] [the description] [] [0]; + +docargument [V] [the value notes] [] [0]; + +docargument [I] [flags this argument as variable-length] [1 (true), 0 (false)] [0]; + +docremark [An argument represents either a command argument or a variable value.]; + +docremark [The last argument of an identifier can be flagged as variable-length to indicate that it represents an unknown number of arguments.]; + + + +docident [docexample] [Adds an example to the last added identifier.]; + +docargument [C] [the example code] [] [0]; + +docargument [E] [the explanation] [] [0]; + + + +docident [docfind] [Searches the ingame docs for identifier documentations matching the specified search string.]; + +docargument [S] [the search string] [] [0]; + +docremark [The name, description and remarks are included in the search.]; + + + +docident [docident] [Adds a new identifier documentation to the last added section.]; + +docargument [N] [name of the identifier] [] [0]; + +docargument [D] [the description] [] [0]; + +docremark [An identifier represents a command or variable. The new identifier]; + +docremark [The name may countain spaces to create a "multipart" identifier documentation that can be used to describe a complex argument as a single pseudo identifier, look at the examples.]; + +docexample [docident fov "Sets the field of view."] []; + +docexample [docident "newent light" "Adds a new light entitiy."] []; + + + +docident [docinvalid] [Outputs a list of identifer documentations that do not match any existing identifer.]; + +docremark [Multipart identifiers are not included in this list, see 'docident'.]; + + + +docident [dockey] []; + + + +docident [docref] [Adds a new documentation reference to an identifier.]; + +docargument [N] [the display name] [] [0]; + +docargument [I] [the identifier to refer to] [] [0]; + +docargument [U] [the URL to refer to] [] [0]; + +docremark [The new reference is added to the last added identifier documentation.]; + + + +docident [docremark] [Adds a new documentation remark to the last added identifier.]; + +docargument [S] [the remark] [] [0]; + + + +docident [docsection] [Adds a new section to the ingame documentation.]; + +docargument [S] [the section name] [] [0]; + + + +docident [docskip] []; + +docargument [V] [] [min 0/max 1000/default 0]; + + + +docident [docundone] [Outputs a list of yet undocumented identifiers (commands,variables, etc)]; + +docargument [A] [output all identifiers] [1 (true), 0 (false)] [0]; + +docremark [If the one argument is omitted, only the builtin identifiers will be listed. Therefore specify the argument other identifers like aliases should be included too.]; + +docremark [Note that the list also includes identifiers that contain the substrings "TODO" or "UNDONE" in their documentation.]; + + + +docident [docvisible] []; + +docargument [V] [] [min 0/max 1/default 1]; + + + +docident [docwritebaseref] [Writes out a base XML documentation reference containing templates for the builtin identifiers.]; + +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.]; + + + diff --git a/docs/reference.xml b/docs/reference.xml index 16809a51..c534ab1c 100644 --- a/docs/reference.xml +++ b/docs/reference.xml @@ -263,9 +263,6 @@ This section describes general identifiers. - - - @@ -953,7 +950,7 @@ - + Stops any demo recording or playback.