diff --git a/config/docs.cfg b/config/docs.cfg index 909b8f0a..60b2df1e 100644 --- a/config/docs.cfg +++ b/config/docs.cfg @@ -74,7 +74,7 @@ docargument [B] [the subtrahend] [float] [0]; docident [<] [Determines if a value is smaller than a second value.]; docargument [A] [the first value] [] [0]; docargument [B] [the second value] [] [0]; -docident [<=] [Determines if a values is less than or equal than a second value.]; +docident [<=] [Determines if a values is less than or equal to a second value.]; docargument [A] [the first value] [] [0]; docargument [B] [the second value] [] [0]; docident [<=f] [Compares if a particular floating-point value is less than or equal to another floating-point value.]; @@ -93,7 +93,7 @@ docargument [B] [The second value.] [] [0]; docident [>] [Determines if a value is bigger than a second value.]; docargument [A] [the first value] [] [0]; docargument [B] [the second value] [] [0]; -docident [>=] [Determines if a values is greater than or equal than a second value.]; +docident [>=] [Determines if a values is greater than or equal to a second value.]; docargument [A] [the first value] [] [0]; docargument [B] [the second value] [] [0]; docident [>=f] [Determines if the first floating-point value is greater than or equal to the second floating-point value.]; @@ -102,24 +102,19 @@ docargument [B] [the second value] [] [0]; docident [>f] [Determines if the first floating-point value is greater than the second floating-point value.]; docargument [A] [the first value] [] [0]; docargument [B] [the second value] [] [0]; -docident [add2alias] [This will append the passed 2nd argument to any existing content of the alias named in the 1st argument. Several popular aliases have predefined shortcuts using this scriptalias: addOnQuit, addOnLoadOnce, addOnLoadAlways. Check config/scripts.cfg for possible omissions in that list.]; +docident [add2alias] [This will append the passed 2nd argument to any existing content of the alias named in the 1st argument. Several popular aliases have predefined shortcuts using this scriptalias: addOnLoadOnce, addOnLoadAlways. Check config/scripts.cfg for possible omissions in that list.]; docexample [foo = "one" add2alias foo two echo foo] [Output: one two]; -docident [add2bind] [Adds a block of code, if it does not already exist, to a keybind.]; -docargument [K] [the key to add to] [] [0]; -docargument [C] [the code to add] [] [0]; docident [add2list] [Appends a new element to a list.]; docargument [A] [the alias (list) to add to] [] [0]; docargument [E] [the new element to add] [] [0]; docexample [tmp_list = []; add2list tmp_list Hello; add2list tmp_list world!; echo $tmp_list] [Output: Hello world!]; docident [addpunct] [Injects CubeScript punctuation.]; docargument [S] [a string] [] [0]; -docargument [N] [type ID] [min 0/max 5/default 0] [0]; +docargument [N] [ID or name] [0 (quotes), 1 (brackets), 2 (parenthesis), 3 (_$_), 4 (quote), 5 (percent)] [0]; docexample [echo (addpunct hello)] [Output: "hello"]; docexample [echo (addpunct hello 1)] [Output: [hello]]; docexample [echo (addpunct hello 2)] [Output: (hello)]; docexample [echo (addpunct hello 3)] [Output: $hello]; -docexample [echo (addpunct "" 4)] []; -docexample [echo (addpunct "" 5)] [Output: %]; docexample [test = (concat echo (addpunct fov 3)); test] [Output: 90.0]; docident [alias] [Binds a name to commands.]; docargument [N] [the name of the alias] [string, must not contain '$'] [0]; @@ -136,9 +131,10 @@ docexample [echo (at "zero one two three" 2)] [output: two]; docident [break] [Aborts a loop created with a 'loop', 'looplist' or 'while' command.]; docexample [loop i 10 [ if (= $i 4) [ break ]; echo $i]] [output: 0 1 2 3]; docident [breakparse] [Breaks out of a parsestring loop.]; -docremark [Important: This command should only be used within the 3rd argument (the cubescript to execute) of parsestring.]; +docremark [Important: this command should only be used within the 3rd argument (the cubescript to execute) of parsestring.]; +docremark [Remark: that's optional command, disabled by default, to enable it execute "run opt/parsestring".]; docident [c] [Adds color to a string.]; -docargument [N] [color id] [0 min, 9 max] [0]; +docargument [N] [color id] [0-9, A-Z] [0]; docexample [echo (c 3)Hello (c 0)world!] [Output: a red "Hello" and a green "world!"]; docident [ceil] [Upper value of a float number]; docargument [F] [The float number to get the ceil from] [] [0]; @@ -157,6 +153,9 @@ docargument [A] [the alias to check for] [] [0]; docargument [B] [the block of code to ensure that the alias contains] [] [0]; docexample [checkinit mapstartalways] [Output: if alias mapstartalways does not exist, this command initializes it.]; docexample [checkinit mapstartalways [ echo New map, good luck! ]] [Output: if alias mapstartalways does not exist, it is initialized, and if the block of code "[ echo New map, good luck! ]" does not exist within the aliases contents, this command adds it.]; +docident [compatibilitymode] [Sets whether or not to enable compatibility settings for old scripts]; +docargument [B] [0: off, 1: on] [min 0/max 1/default 1]; +docremark [To see compatibility settings, look in config/compatibility.cfg]; docident [concat] [Concatenates multiple strings with spaces inbetween.]; docargument [S] [the first string] [] [0]; docargument [...] [collection of strings to concatenate] [] [1]; @@ -182,8 +181,8 @@ docargument [...] [a list of strings] [] [0]; docremark [This command can handle up to 23 string arguments.]; docexample [echo (convertcase 0 ZERO ONE TWO THREE)] [Output: zero one two three]; docexample [echo (convertcase 1 zero one two three)] [Output: ZERO ONE TWO THREE]; -docident [curplayers] [Returns the current number of players.]; -docremark [The return value includes the local player "(you)", and works in both singleplayer and multiplayer scenarios.]; +docident [delalias] [deletes the passed alias.]; +docargument [N] [the name of the alias] [string, must not contain '$'] [0]; docident [div] [Performs an integer division.]; docargument [A] [the dividend] [] [0]; docargument [B] [the divisor] [] [0]; @@ -198,28 +197,19 @@ docremark [Example: div=f foo 13.37]; docident [divf] [Performs a division with floating-point precision.]; docargument [A] [] [the dividend] [0]; docargument [B] [] [the divisor] [0]; +docident [editsvar] [Interactively edits an alias in the console buffer.]; +docargument [A] [Alias to edit] [The alias name, without $] [0]; +docremark [This takes the current value of the alias, and inserts it into the command line / text entry box]; +docexample [alias test "Hello World"; editsvar test] [Result: edit test: Hello World]; +docident [escape] [Replaces control characters in a string with escaped sequences.]; +docargument [S] [string to escape] [] [0]; +docexample [echo (escape (concat (c 3) "Hello World"] [Output: "\f3Hello World"]; docident [execute] [Executes the specified string as CubeScript.]; docargument [S] [the string to execute] [] [0]; docexample [execute (concat echo (addpunct fov 3))] [Example output: 90.0]; -docident [findcn] [find client number (cn)]; -docargument [N] [NAME] [] [0]; -docident [findkey] [Returns the name of a key via a specified code.]; -docargument [I] [integer] [] [0]; -docremark [Returns -255 if the key does not exist.]; -docremark [See /config/keymap.cfg for a full list of valid key codes.]; -docexample [echo (findkey 8)] [Output: BACKSPACE]; -docexample [echo (findkey 280)] [Output: PAGEUP]; -docident [findkeycode] [Returns the integer code of a key.]; -docargument [K] [the name of the key] [] [0]; -docremark [Returns -255 if the key does not exist.]; -docremark [See /config/keymap.cfg for a full list of valid key names.]; -docexample [echo (findkeycode BACKSPACE)] [Output: 8]; -docexample [echo (findkeycode PAGEUP)] [Output: 280]; docident [findlist] [Searches a list for a specified value.]; docargument [L] [the list] [] [0]; docargument [I] [the item to find] [] [0]; -docident [findpn] [find player name]; -docargument [C] [CLIENTNUM] [] [0]; docident [floor] [Floor value of a float number]; docargument [F] [The float number to get the floor from] [] [0]; docident [forceinit] [Forcibly sets a list of aliases to a specified value.]; @@ -233,20 +223,26 @@ docargument [V] [value(s)] [] [0]; docexample [echo (format "%1 bottles of %2 on the %3, %1 bottles of %2!" 99 beer wall)] [output: 99 bottles of beer on the wall, 99 bottles of beer!]; docident [getalias] [return the value of the alias]; docargument [N] [alias name] [] [0]; -docident [highestcn] [Returns the highest valid client number available.]; +docident [getvarrange] [Gets range attribute for builtin variable.]; +docargument [W] [what] [min, max, default] [0]; +docargument [N] [the name of any builtin variable (integer or float)] [] [0]; docident [if] [Controls the script flow based on a boolean expression.]; docargument [cond] [the condition] [0 (false) or anything else (true)] [0]; docargument [true] [the body to execute if the condition is true] [] [0]; docargument [false] [the body to execute if the condition is false] [] [0]; docexample [if (> $x 10) [ echo x is bigger than 10 ] [ echo x too small ]] []; +docident [inputcommand] [Makes an input perform a certain command.]; +docargument [I] [input] [] [0]; +docargument [C] [command] [] [0]; +docargument [P] [prompt] [] [0]; docident [isIdent] [returns whether or not there is an identifier by that name]; docargument [N] [identifier name] [] [0]; docident [isconst] [Determines if the argument given is a constant or not.]; docargument [A] [the alias to check for] [] [0]; docexample [const hello ""; echo (isconst hello)] [Output: 1]; docexample [hello = value; echo (isconst hello)] [Output: 0]; -docident [keybind] [Returns the contents of a keybind.]; -docargument [K] [name of key] [] [0]; +docident [isolatecontext] [Isolates the given context. This disables access from this context to identifiers located in other contexts, also it removes all aliases created in this context once the running context changes]; +docargument [C] [the context] [] [0]; docident [l0] [leading zeros for the number V to make it W chars wide. It may look like 10 - which might be considered a mnemonic - but it's lowercase-L and 0!]; docargument [W] [WIDTH] [] [0]; docargument [V] [VALUE] [] [0]; @@ -257,6 +253,9 @@ docargument [L] [the list of numbers] [supports ints and floats] [0]; docexample [echo (listaverage "2 5 5")] [Output: 4.0]; docident [listlen] [returns the element count of the given list.]; docargument [L] [the list] [] [0]; +docident [listoptions] [Lists the argument options for several argument types.]; +docexample [echo (listoptions)] [Output: "entities ents weapons teamnames teamnames-abbrv punctuations crosshairnames"]; +docexample [echo (listoptions teamnames)] [Output: "CLA RVSF CLA-SPECT RVSF-SPECT SPECTATOR"]; docident [loop] [Loops the specified body.]; docargument [V] [the alias used as counter] [] [0]; docargument [N] [the amount of loops] [] [0]; @@ -265,9 +264,11 @@ docremark [This command sets the alias you choose, as first argument, from 0 to docexample [loop i 10 [ echo $i ]] []; docident [looplist] [Browses a list and executes a body for each element]; docargument [V] [the list to browse] [] [0]; -docargument [N] [the alias containing the current element value.] [] [0]; +docargument [N] [the alias(es) containing the current element value] [] [0]; docargument [body] [the body to execute on each iteration] [] [0]; -docexample [looplist "zero one two three" number [ echo $number ]] []; +docremark [It works optionally with several variables.]; +docexample [looplist "zero one two three" number [echo $number]] []; +docexample [looplist [0 "is knife" 1 "is pistol"] [n w] [echo weapon $n $w]] []; docident [mod] [Performs a modulo operation.]; docargument [A] [the dividend] [] [0]; docargument [B] [the divisor] [] [0]; @@ -284,6 +285,7 @@ docargument [A] [string] [name of alias to use as iterator] [0]; docargument [C] [string] [cubescript to execute on each iteration] [0]; docargument [B] [integer] [non-zero to force backwards parse] [0]; docremark [Important: A secondary iterator alias (prefixed with a double underscore "__") is automatically created before each iteration that contains the character position data.]; +docremark [Remark: that's optional command, disabled by default, to enable it execute "run opt/parsestring".]; docexample [parsestring "Hello world" iter [echo $iter]] [Uses echo on every character in the string: "Hello world"]; docexample [parsestring "Hello world" iter [echo (concatword "Char #" $__iter ": " $iter)]] [Uses echo on every character in the string: "Hello world" --- Also outputs the position of each character in the string.]; docexample [backwardsstring = []; parsestring "This will look interesting backwards." iter [backwardsstring = (concatword $backwardsstring $iter); if (= $__iter 0) [echo $backwardsstring]] 1] [Outputs: ".sdrawkcab gnitseretni kool lliw sihT"]; @@ -294,6 +296,7 @@ docexample [persistidents 0; foo = [ echo "bar"]] [foo will not be saved and has docexample [persistidents 1; bar = [ echo "foo"]] [bar will be saved and persistent across sessions.]; docident [pop] [Resets a previously pushed alias to it's original value.]; docargument [A] [alias] [] [0]; +docremark [It is allowed to use multiple arguments for "pop". So instead of "pop var_a ; pop var_b" you can write "pop var_a var_b". Also, "pop" will now give back the removed value of the first alias from the argument list. This allows using the pop'd value one last time.]; docexample [pop p; echo $p] [Output: 1]; docident [powf] [Returns A raised to the power of B (floating-point)]; docargument [A] [the mantissa] [] [0]; @@ -311,11 +314,18 @@ docident [rnd] [Random value]; docargument [A] [The upper limit of the random value] [] [0]; docident [round] [Round the given float]; docargument [F] [The float number to round] [] [0]; +docident [scriptcontext] []; +docargument [C] [context] [] [0]; +docargument [N] [idname] [] [0]; +docident [sealcontexts] [secure this configuration for the rest of the game]; docident [sleep] [Executes a command after specified time period.]; docargument [N] [the amount of milliseconds] [] [0]; docargument [C] [the command to execute] [] [0]; -docargument [P] [ignore map change (optionnal)] [] [0]; +docargument [P] [ignore map change (optional)] [] [0]; docexample [sleep 1000 [ echo foo ]] [Prints 'foo' to the screen after 1 second.]; +docident [sortlist] [Returns a sorted version of a list.]; +docargument [c] [List to sort] [] [0]; +docexample [echo (sortlist [1 3 2])] [Output: 1 2 3]; docident [storesets] [Generates an alias (list) of the current values for the given aliases/CVARs.]; docargument [L] [the list of aliases/CVARs] [] [0]; docargument [A] [the alias to store them in] [] [0]; @@ -327,10 +337,10 @@ docexample [if (strcmp yes yes) [echo the two strings are equal] [echo the two s docident [strlen] [Returns the length (in characters, including whitespace) of string S.]; docargument [S] [STRING] [] [0]; docexample [echo (strlen "Hello world!")] [Output: 12]; -docident [strpos] [Returns the position of a substring into another]; +docident [strpos] [Returns the position of a substring into another.]; docargument [H] [haystack string] [] [0]; docargument [S] [needle string] [] [0]; -docargument [N] [The occurence of 'needle' to find (optionnal)] [] [0]; +docargument [N] [The occurence of 'needle' to find (optional)] [] [0]; docremark [Character indexes and occurence number begin at 0.]; docexample [echo (strpos "hello world" "world") 6] []; docexample [echo (strpos "hello world" "l") 2] []; @@ -347,7 +357,7 @@ docexample [if (strstr "Hello world!" Hello) [echo found Hello in Hello world!] docident [substr] [Copies a substring out of the original.]; docargument [S] [the original string] [] [0]; docargument [A] [start position] [] [0]; -docargument [L] [substring length (optionnal)] [] [0]; +docargument [L] [substring length (optional)] [] [0]; docremark [Character indexes begins at 0. If "start position" is negative, the reference is the end of the string.]; docexample [echo (substr abcdefgh 2 5) cdefg] []; docexample [echo (substr abcdefgh -3 2) fg] []; @@ -357,6 +367,9 @@ docargument [I] [integer] [] [0]; docargument [C] [a variable number of 'case' arguments...] [] [0]; docremark [This command can only handle up to 23 'cases'. (because of cubescript's 24 argument limit)]; docexample [switch 2 [echo case 0] [echo case 1] [echo case 2] [echo case 3] [echo case 4]] [Output: case 2]; +docident [tempalias] [Creates a temporary alias that will not be written to saved.cfg, and thus will not persist after quitting.]; +docargument [N] [temporary alias name] [] [0]; +docargument [C] [Cubescript command(s)] [] [0]; docident [testchar] [Tests a character argument for various things.]; docargument [C] [the character to test] [] [0]; docargument [N] [type of test to run] [min 0/max 7/default 0] [0]; @@ -378,9 +391,11 @@ docargument [S] [a string] [] [0]; docexample [echo (toupper hello)] [Output: HELLO]; docident [trimAllUnnecessaryWhitespace] [Removes all unnecessary leading and trailing whitespace characters from the given string.]; docargument [S] [string] [string to modify] [0]; +docremark [Remark: that's optional command, disabled by default, to enable it execute "run opt/parsestring".]; docexample [echo (trimAllUnnecessaryWhitespace " H e ll o w o r l d ")] [Outputs: "H e ll o w o r l d"]; docident [trimAllWhitespace] [Removes all whitespace characters from the given string.]; docargument [S] [string] [string to modify] [0]; +docremark [Remark: that's optional command, disabled by default, to enable it execute "run opt/parsestring".]; docexample [echo (trimAllWhitespace " H e ll o w o r l d ")] [Outputs: Helloworld]; docident [while] [Loops the specified body while the condition evaluates to true.]; docargument [cond] [the condition] [the code evaluated before each iteration] [0]; @@ -393,56 +408,64 @@ docargument [B] [second value] [] [0]; docexample [echo (|| 1 0)] [output: 1]; docexample [echo (|| 0 0)] [output: 0]; docsection [General] +docident [addpckserver] [Adds a packages source server where to download custom content from.]; +docargument [S] [The server address. Trailing slash not needed.] [] [0]; +docargument [P] [priority of the server] [] [0]; +docremark [Only add servers you trust.]; +docremark [The list of servers is saved into config/pcksources.cfg on game quit.]; +docremark [If a priority is given, it influences the sorting of servers. Servers with higher priority are queried first. If servers have the same priority, they are sorted by ping. Default priority is zero.]; +docexample [addpckserver http://packages.ac-akimbo.net] []; docident [addserver] [Adds a server to the list of server to query in the server list menu.]; docargument [S] [the address of the server (hostname or IP)] [] [0]; docargument [P] [the port] [] [0]; +docident [addzipmod] [Add the zip package file "mods/zipname.zip" to the virtual file system.]; +docargument [N] [the name of the zip mod] [] [0]; +docremark [Add the zip package file "mods/zipname.zip" to the virtual file system. Only files below the path "packages/" are added (and also files below "config/", if zipname starts with "###"). If the size of the zip file is below "zipcachemaxsize", the whole zip file is cached in memory. (Un-cached zip files are kept open at all time, so caching keeps the number of simultaneously opened files lower.)]; docident [allowhudechos] [Enables or disables the ability of hudecho to output text to the heads up display.]; docargument [N] [0 off, 1 on] [min 0/max 1/default 1]; -docident [attack] [Fires the current weapon.]; -docremark [default: left mouse button]; +docident [applydialog] [Toggles the showing of the "Apply changes now?" menu when changing certain graphical settings.]; +docargument [N] [1 = show, 0 = don't show] [min 0/max 1/default 1]; +docident [autodownload] [Determines if the game should try to download missing packages such as textures or mapmodels on the fly.]; +docargument [V] [Note: This is turned on by default] [min 0/max 1/default 1]; +docident [autodownloaddebug] [When the variable autodownloaddebug is set to 1 and/or in debug binaries, more debug output is produced.]; +docargument [V] [Add debug info to autodownload] [min 0/max 1/default 0]; docident [autogetmap] [Determines if the current played map should be automatically downloaded if it is not available locally.]; docargument [B] [enable auto map download] [min 0/max 1/default 1]; docident [autogetnewmaprevisions] [Automatically get new map revisions from the server.]; docargument [N] [0: no, 1: yes] [min 0/max 1/default 0]; docident [autoscreenshot] [Toggle for taking an automatic screenshot during intermission.]; docargument [B] [0=Off, 1=On] [min 0/max 1/default 1]; -docident [backward] [Moves the player backward.]; -docremark [default keys: S and Down Arrow]; -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 [browsefiledesc] [Toggles getting descriptive text from CGZ or DMO files in menudirlist.]; -docargument [B] [] [min 0/max 1/default 1]; docident [changeteam] [Swaps your player to the enemy team.]; docident [cleanshot] [Take a "clean" screenshot with no HUD items.]; docremark [Your current HUD configuration is stored into a buffer, and is re-enabled afterwards.]; -docident [clearservers] []; +docident [clearservers] [Clears the server list.]; docident [clockerror] [Sets the correction value for clockfix.]; docargument [V] [correction value] [min 990000/max 1010000/default 1000000]; docremark [Engine source-code snippet (main.cpp): if(clockfix) millis = int(millis*(double(clockerror)/1000000));]; docident [clockfix] [Enables correction of the system clock.]; docargument [B] [enable correction] [min 0/max 1/default 0]; +docident [conline] [Returns text from the last line in the console.]; 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 [conopen] [Indicates the state of the console.]; +docargument [N] [console state] [0: closed, 1: open in an alternate size, 2: open regularly read-only]; +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 [datestring] [representation of date]; docremark [format: Www Mmm dd hh:mm:ss yyyy]; docremark [Use timestamp to create your own formatting.]; docexample [echo (datestring) "Sat Jun 7 17:08:35 2008"] []; -docident [dbgts] [Enable triangle debug.]; -docargument [B] [triangle debug] [min 0/max 1/default 0]; -docremark [Prints details while connecting triangles of 3d models.]; docident [debugargs] [Dump all command arguments to STDOUT]; docargument [...] [...] [] [1]; docident [echo] [Outputs text to the console.]; docargument [L] [List of strings] [] [0]; -docident [editbind] [Similar to bind, but is only active while editing, where it overrides the regular bind for the specified key.]; -docargument [K] [the key to bind] [string] [0]; -docargument [A] [the command] [string, usually an alias] [0]; docident [exec] [Executes all commands in a specified config file.]; docargument [C] [the config file] [] [0]; -docident [forward] [Moves the player forward.]; -docremark [default keys: W and Up Arrow]; +docident [execdir] [Executes all commands in all config files in the specified directory.]; +docargument [s] [the directory path from the assaultcube root] [] [0]; +docexample [execdir scripts] []; docident [gamemode] [Holds the current game mode. READ ONLY]; docexample [echo $gamemode] [Output: 5]; docident [getEngineState] [Returns a list of values describing the current engine (rendering) state.]; @@ -458,52 +481,35 @@ docident [getmode] [Returns the current game mode.]; docargument [N] [0 = full mode name, 1 = mode acronym] [min 0/max 1/default 0] [0]; docexample [echo (getmode)] [Example output: capture the flag]; docexample [echo (getmode 1)] [Example output: CTF]; +docident [getpckserver] [Returns a table with four columns of all configured package servers.]; +docremark [The columns are: host name, priority, ping and resolved. "resolved" is a flag, indicating, if the server answered the ping during game start.]; docident [getscrext] [Returns the file extension of the client's current screenshottype setting.]; docexample [echo (getscrext)] [Example output: .jpg]; +docident [groupvariables] [Controls how many variables (with similar names) are grouped together on one line. This only pertains to commented variables in saved.cfg caused by omitunchangeddefaults being 0.]; +docargument [N] [Variables per line] [min 0/max 10/default 4]; +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 [hudecho] [Outputs text to the console and heads up display.]; docargument [L] [List of strings] [] [0]; -docident [invmouse] [Sets mouse to "flight sim" mode.]; -docargument [B] [sets invmouse] [0 (off), else (on)] [0]; docident [jpegquality] [Sets the JPEG screenshot image quality.]; docargument [N] [Compression level] [min 10/max 100/default 70]; docremark [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]; docremark [while a value of 100 results in a large file but gives the best quality image.]; -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 [lang] [Sets the language for which a translated server MOTD will be fetched, if the server has one for this language.]; docargument [L] [the language code] [min /max /default ]; docremark [This is always a two-letter language code as defined in the ISO 639 standard, three-letter codes are currently not allowed.]; docremark [If lang is not set, or if the server does not have a matching MOTD file, it will fall back to English.]; docremark [Note: this does not affect the client language, which is derived from the system settings (e.g. on many *nix systems, it may be changed via the "LANG" environment variable).]; docexample [en, de, fr, ...] []; -docident [left] [Moves the player left.]; -docremark [default keys: A and Left Arrow]; docident [mapshot] [save an image of the entire radar-overview of the map.]; +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 [maxfps] [Limits the FPS (frames per second) of AssaultCube's video output.]; docargument [V] [maximum FPS] [0 disables maxfps min 25 or 0/max 1000/default 200]; -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] [Gets the maximum number of supported textures when performing multitexturing.]; -docargument [V] [max. number of textures] [ read-only]; -docident [megabind] [Binds a key to many different actions depending on the current game state.]; -docargument [K] [the key to bind] [string] [0]; -docargument [D] [body of code to execute if watching a demo] [a body of code] [0]; -docargument [E] [body of code to execute if editing or in coop-edit mode] [a body of code] [0]; -docargument [C] [body of code to execute if connected to a server] [a body of code] [0]; -docargument [B] [body of code to execute if in a bot mode] [a body of code] [0]; -docargument [O] [body of code to execute if none of the other arguments have been met] [a body of code] [0]; -docremark [This command requires 6 arguments, no less. Use an empty set of brackets [] for any of the arguments that you want to "do nothing".]; -docexample [megabind F9 [echo Demo!] [echo Editing or coop!] [echo Connected!] [echo Bots!] [echo Other!]] []; -docident [menudirlist] [create a menu listing of files from a path and perform an action on them when clicked.]; -docargument [] [] [] [0]; -docremark [use this inside menu definitions, almost always as the only command of that menu.]; -docremark [compare the usage inside config/menus.cfg]; -docexample [menudirlist "packages/maps" "cgz" "map $arg1"] [will create a list of maps and load them when clicked]; +docident [maxhistory] [Sets how many typed console commands to store.]; +docargument [N] [Total of stored commands] [min 0/max 10000/default 1000]; +docremark [This value sets how many command lines to store in memory, everytime a command is entered it gets store so it can be recalled using the "/" key along with the arrow keys to scroll back and forth through the list.]; docident [millis] [Returns the number of milliseconds since engine start.]; docexample [echo (millis)] []; docident [minlod] [Minimal level of detail.]; @@ -514,28 +520,22 @@ docident [networkdebug] [Enables output of processed network packets.]; docargument [B] [enable network debugging] [min 0/max 1/default 0]; docremark [This variable only has an effect if the client binary is compiled in debug mode.]; docident [numconlines] [Hold the current number of lines on the console.]; -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 [omitunchangeddefaults] [If this value is 1, variables that are at their default values are omitted from saved.cfg. If 0, the variables are written to saved.cfg, but commented out.]; +docargument [N] [1 = Omit, 0 = Comment out] [min 0/max 1/default 1]; docident [physinterp] [Toggles physics interpolation.]; docargument [B] [] [min 0/max 1/default 1]; docident [pngcompress] [Sets the PNG screenshot file compression.]; docargument [N] [Compression level] [min 0/max 9/default 9]; docremark [A value of 9 sets maximum data compression and a smaller file size while a value of 0 results in a large file image, quality is always the same since PNG its a loosless format.]; docident [protocol] [Gets an integer representing the game protocol. READ ONLY]; -docremark [As example, the protocol of version 1.1.0.4 is represented as value 1132.]; +docremark [As example, the protocol of version 1.2.0.2 is represented as value 1201.]; docident [quit] [Quits the game without asking.]; -docident [registermusic] [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.]; -docargument [M] [music file] [] [0]; -docident [resetbinds] [Resets all binds back to their default values.]; -docremark [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.]; docident [resetcfg] [Determines if all settings should be reset when the game quits.]; docargument [B] [enable reset] [min 0/max 1/default 0]; docremark [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.]; +docident [resetpckservers] [Resets the list of packages source servers where to download custom content from.]; +docremark [Restart AssaultCube to take the effect.]; docident [resetsecuremaps] [Clears the list of secured maps.]; -docident [right] [Moves the player right.]; -docremark [default keys: D and Right Arrow]; docident [run] [Executes a config file within /config/]; docargument [N] [the file name (without extension)] [] [0]; docident [screenshot] [Takes a screenshot.]; @@ -548,16 +548,10 @@ docargument [T] [0=BMP, 1=JPEG, 2=PNG] [min 0/max 2/default 1]; 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] [floating-point] [0]; docident [smoothdist] [Determines the valid distance when extrapolating a players position.]; docargument [V] [distance] [min 0/max 16/default 8]; docident [smoothmove] [Determines the speed when extrapolating a players position.]; docargument [V] [movement speed] [min 0/max 100/default 75]; -docident [soundtest] [Plays all hardcoded sounds in order.]; -docident [specbind] [Similar to bind, but is only active while spectating, where it overrides the regular bind for the specified key.]; -docargument [K] [the key to bind] [string] [0]; -docargument [A] [the command] [string, usually an alias] [0]; docident [systime] [seconds since the epoch (00:00:00 UTC on January 1, 1970)]; docexample [echo (systime)] []; docident [throttle_accel] [Determines how fast network throttling accelerates.]; @@ -581,38 +575,26 @@ docident [updatefrommaster] [Contacts the masterserver and adds any new servers docargument [B] [force update] [0 (delayed), 1 (immediate)] [0]; docremark [The servers are written to the config/servers.cfg file. This menu can be reached through the Multiplayer menu.]; docident [version] [Gets an integer representing the game version. READ ONLY]; -docremark [As example, version 1.0 is represented as value 1000.]; +docremark [As example, version 1.2.0.2 is represented as value 1202.]; docident [writecfg] [writes current configuration to config/saved.cfg - automatic on quit]; +docident [zipcachemaxsize] [Maximal size of the file, which is cached in memory.]; +docargument [S] [size [kB]] [min 0/max 1024/default 512]; +docremark [If the size of the zip file is below "zipcachemaxsize", then during loading the whole zip file is cached in memory. When the size is greater, then zip is just opened as a file and read from disk.]; +docident [zipmodclear] [Removes all zip files from the virtual file system.]; +docident [zipmodgetdesc] [Reads and returns the first 11 lines from the file "desc.txt" in the named zip file.]; +docargument [N] [the name of the zip mod] [] [0]; +docremark [The first line is supposed to contain a descriptive title for the zip (for use in menus) and the next 10 lines should contain a more detailed description (also for use in menus). The command also unpacks "preview.jpg" from the zip and mounts it as a temporary file under the name "packages/modpreviews/zipname.jpg".]; +docident [zipmodgetfiles] [Returns the list of files contained in a zip file.]; +docargument [N] [the name of the zip mod] [] [0]; +docident [zipmodgetrevision] [Returns the revision number of the zip file.]; +docargument [N] [the name of the zip mod] [] [0]; +docremark [The number is supposed to be part of a filename: "revision_n". If no such file is found in the zip file, the return value is zero. The content of the revision file is not relevant and a file size of zero is recommended.]; +docident [zipmodlist] [Lists zip files in "mods/".]; +docargument [W] [what] [all, active, inactive] [0]; +docremark [By default or if "what" is "all", all zips are listed. If "what" is "active", only those zips, that are already in use, are listed. If "what" is "inactive", only the unused zip files are listed.]; +docident [zipmodremove] [Removes one zip file from the virtual file system.]; +docargument [N] [the name of the zip mod] [] [0]; docsection [Gameplay] -docident [KEYPRESS] [If defined, this will be executed every time you press a key.]; -docargument [I] [integer key code] [] [0]; -docexample [checkinit KEYPRESS [echo You pressed key: (findkey $arg1)]] []; -docident [KEYRELEASE] [If defined, this will be executed every time you release a key.]; -docargument [I] [integer key code] [] [0]; -docexample [checkinit KEYRELEASE [echo You released key: (findkey $arg1)]] []; -docident [addListOnQuit] [Deletes a list of aliases (from saved.cfg) on quit.]; -docargument [L] [the list of aliases to delete] [min /max /default ]; -docexample [addListOnQuit "a b c"] [Deletes aliases a, b, and c from existance and saved.cfg upon quit.]; -docident [addOnQuit] [Execute a command or block of code on quit.]; -docargument [A] [the command or block of code to execute] [min /max /default ]; -docident [addbot] [add a bot for a given team with a given skill calling him a given name.]; -docargument [T] [team] [RVSF or CLA] [0]; -docargument [S] [skill] [best, good, medium, worse OR bad] [0]; -docargument [N] [name] [name for the bot] [0]; -docremark [This command only works for single player modes.]; -docexample [addbot RVSF medium Robbie] [Will add a bot named Robbie with a medium skill level to the RVSF team.]; -docident [addnbot] [will add a given count of bots for the given team with the given skill and select random names for them.]; -docargument [C] [count] [how many bots to add] [0]; -docargument [T] [team] [RVSF or CLA] [0]; -docargument [S] [skill] [best, good, medium, worse OR bad] [0]; -docremark [This command only works for single player modes.]; -docremark [The name of the bots will be selected randomly.]; -docexample [addnbot 2 CLA bad] [Will add 2 bots with a bad skill level to the CLA team.]; -docident [addpckserver] [Adds a packages source server where to download custom content from.]; -docargument [S] [The server address. Trailing slash not needed.] [] [0]; -docremark [Only add servers you trust.]; -docremark [The list of servers is saved into config/pcksources.cfg on game quit.]; -docexample [addpckserver http://packages.ac-akimbo.net] []; docident [afterinit] [If defined, this will be executed after saved.cfg is loaded.]; docident [akimboautoswitch] [Enables or disables automatic switching to the akimbo upon pickup.]; docargument [N] [enable or disable] [min 0/max 1/default 1]; @@ -625,29 +607,25 @@ docargument [N] [akimbo end action] [min 0/max 3/default 3]; docremark [If no ammunition is detected for the target weapon, it will fallback to the previous weapon until it finds a weapon with ammunition to use.]; docident [alive] [Returns 1 if the local player is alive.]; docexample [echo (alive)] [Output: 1]; -docident [autodownload] [Determines if the game should try to download missing packages such as textures or mapmodels on the fly.]; -docargument [V] [Note: This is turned on by default.] [min 0/max 1/default 1]; +docident [attack] [Fires the current weapon.]; +docremark [default: left mouse button]; 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 [backward] [Moves the player backward.]; +docremark [default keys: S and Down Arrow]; docident [benchme] [Move from active team to spectator during match.]; -docident [botskill] [changes the skill level for the given bot.]; -docargument [N] [botname] [the name of the bot] [0]; -docargument [S] [botskill] [best, good, medium, worse OR bad] [0]; -docexample [botskill Robbie best] [Changes the previous bot skill level of the bot named Robbie to a 'best' skill level.]; -docident [botskillall] [changes the skill level for all bots.]; -docargument [S] [botskill] [best, good, medium, worse OR bad] [0]; -docexample [botskillall worse] [Changes the previous bot skill level for all bots to a 'worse' skill level.]; -docident [botsshoot] [Enables or disables the ability of the bots to fire their weapons]; -docargument [T] [shooting bots?] [0||1] [0]; -docexample [botsshoot 0] [Bots won't shoot.]; +docident [burstshots] [Set the firing mode of automatic weapons between full auto mode and burst fire mode.]; +docargument [N] [the weapon number or name] [4 (subgun), 6 (assault), 8 (akimbo)] [0]; +docargument [S] [shots per burst] [Special values: 0: set weapon to full auto, -1: don't set, instead check and return shots per burst] [0]; docident [changefollowplayer] []; docargument [D] [delta] [how many players to shift +/-] [0]; docident [changespeed] [Smoothly changes your gamespeed to the specified value.]; docargument [S] [the gamespeed to change to] [] [0]; docargument [M] [milliseconds between gamespeed changes] [] [0]; +docremark [Remark: that's optional command, disabled by default, to enable it execute "run opt/survival" or start bot surival mode from menu.]; docexample [changespeed 1000 30] [Every 30 milliseconds your gamespeed is changed by 1 until it reaches its goal of gamespeed 1000.]; docident [checkmag] [Determines if you have any ammunition available for the specified weapon. (uses magcontent and magreserve)]; -docargument [N] [the weapon number] [] [0]; +docargument [N] [the weapon number or name] [0 (knife), 1 (pistol), 2 (carbine), 3 (shotgun), 4 (subgun), 5 (sniper), 6 (assault), 7 (grenades), 8 (akimbo)] [0]; docident [clearignored] [Clear list of ignored players.]; docargument [A] [client number, or -1 to clear the whole list] [] [0]; docremark [Omit the client number to clear the whole list.]; @@ -675,8 +653,10 @@ docremark [This command will connect to a server just like the command 'connect' docremark [If the server name ist omitted, the client will try to connect to an available server in the LAN. If the port is omitted or set to 0, the default port will be used.]; docexample [connectadmin 127.0.0.1 777 myAdminPassword] [connect as admin on port 777 of localhost]; docexample [connectadmin "" 0 myAdminPassword] [will try to connect to a LAN server on the default port as admin with the given password of "myAdminPassword".]; -docident [crouch] []; +docident [crouch] [Triggers a crouch.]; +docremark [default keys: left shift.]; docident [curautoteam] [Returns the server's current autoteam state.]; +docident [curdemofile] [Returns the name of played demo.]; docident [curmap] [Returns the current map being played.]; docargument [I] [clean] [0, 1] [0]; docremark [If you pass it a non-zero value, the result will be path-less.]; @@ -688,6 +668,9 @@ docident [curmode] [Returns the mode number for the current game.]; docident [curmodeattr] [Checks the current game mode for certain attributes.]; docargument [A] [attribute name] [] [0]; docremark [Possible attributes are: team, arena, flag and bot.]; +docident [curname] [Returns the nick name of the local player.]; +docident [curplayers] [Returns the size of the players vector.]; +docremark [The return value includes the local player "(you)" and works in both singleplayer and multiplayer scenarios. It can be used, for example, in a loop to find all valid clients (players) on server. Note: it DOESN'T return current number of players.]; docident [currentprimary] [Returns the weapon-index the local player currently has selected as primary.]; docremark [This is not the same as curweapon - which could be a grenade or the knife.]; docident [currole] [Returns 1 if the local player has admin privileges, 0 otherwise.]; @@ -712,9 +695,6 @@ docremark [Playback is interpolated for the player whose perspective you view.]; docident [disconnect] [Leaves a server.]; docident [dlmap] [Downloads and loads the specified map from an available packages source server.]; docargument [S] [the name of the map] [] [0]; -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 [drawzone] [Draws a zone marker with the specified color and dimensions on the minimap/radar. This is primarily intended for the survival mode.]; docargument [X1] [X-coordinate - top-left corner] [] [0]; docargument [X2] [X-coordinate - bottom-right corner] [] [0]; @@ -723,12 +703,18 @@ docargument [Y2] [Y-coordinate - bottom-right corner] [] [0]; docargument [C] [a color for the zone, in hexadecimal notation] [default: 0x00FF00 (green)] [0]; docremark [You can draw a few zones at a time. They will be reset (i.e. removed) once a new game starts.]; docremark [Note that the coordinates must be specified as integers, not as floating-point values.]; -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.]; +docremark [Remark: that's optional command, disabled by default, to enable it execute "run opt/survival" or start bot surival mode from menu.]; +docident [dropflag] [Drops the taken flag.]; +docident [findcn] [find client number (cn)]; +docargument [N] [NAME] [] [0]; +docident [findpn] [find player name]; +docargument [C] [CLIENTNUM] [] [0]; +docident [flyspeed] [Determines by how much to multiply the fly speeds by.]; +docargument [N] [the multiplier] [min 1.0/max 5.0/default 2.0]; docident [footsteps] [Indicates if the footsteps sound should be played]; docargument [B] [enable footsteps] [1 (true), 0 (false) min 0/max 1/default 1]; +docident [forward] [Moves the player forward.]; +docremark [default keys: W and Up Arrow]; docident [gamespeed] [Sets the gamespeed in percent.]; docargument [N] [the game speed] [min 10/max 1000/default 100]; docremark [This does not work in multiplayer. For entertainment purposes only :)]; @@ -744,6 +730,9 @@ docident [getmap] [Retrieves the last map that was sent to the server using 'sen docargument [S] [the name of the map] [] [0]; docargument [C] [cubescript to execute once map is installed] [] [0]; docremark [If the command is passed an argument, different than the map being played, the game tries to download the specified map from an available packages source server.]; +docident [getmod] [Try to download mods/modname.zip from all configured package servers.]; +docargument [N] [the name of the mod] [] [0]; +docremark [Does not automatically activate the mod.]; docident [gndtoggle] [Toggles between your primary weapon and grenades. (must be binded to a key)]; docident [grenades] [Switches to grenades. (if available) (must be binded to a key)]; docident [hasprimary] [Determines if the local player (you) are currently carrying a primary weapon.]; @@ -751,13 +740,10 @@ docremark [Returns 0 (false) or 1 (true).]; docexample [add2bind MOUSE1 [ if (hasprimary) [ echo you attacked with a primary weapon ] ]] [Everytime you press the left mouse button, assuming you are carrying your primary weapon, the above echo will be executed.]; docident [hidecustomskins] []; docargument [B] [] [min 0/max 1/default 0]; +docident [highestcn] [Returns the highest valid client number available.]; docident [hitsound] [Plays a sound upon every successful hit if enabled.]; docargument [B] [off OR on] [0 (disabled), 1 (server), 2 (local) min 0/max 2/default 0]; docremark [If hitsound is set to 2, the sound will be played instantly rather than after server acknowledgment.]; -docident [idlebots] [Enables or disables the processing of the bots artificial intelligence]; -docargument [T] [off OR on] [0||1] [0]; -docexample [idlebots 1] [Will make the bots stand still.]; -docexample [idlebots 0] [Will enable the bots to move and shoot.]; docident [ignore] [Ignore a player.]; docargument [A] [client number] [] [0]; docremark [You won't see any further game chat or hear any more voice com messages from that player.]; @@ -765,54 +751,49 @@ docident [ignoreall] [Ignores all clients currently on the server. (only works i docident [ignoreenemy] [Ignores all clients on the enemy team.]; docident [ignoreteam] [Ignores all clients on the specified team.]; docargument [T] [the team to ignore] [0 or 1 || cla or rvsf] [0]; -docident [inWater] [Determines if the local player is standing in water or submerged.]; -docargument [T] [check if submerged instead?] [min 0/max 1/default 0] [0]; -docexample [if (inWater) [echo in water] [echo not in water]] [Example output: in water]; -docexample [if (inWater 1) [echo submerged] [echo not submerged]] [Example output: not submerged]; -docident [inputcommand] [Makes an input perform a certain command.]; -docargument [I] [input] [] [0]; -docargument [C] [command] [] [0]; -docargument [P] [prompt] [] [0]; docident [isclient] [Determines if the client number given is a valid client (player).]; docargument [C] [client number] [] [0]; docexample [echo (isclient 0)] [Example output: 1]; docexample [echo (isclient 32)] [Example output: 0]; -docident [kickallbots] [Kicks all bots out of the current game.]; -docargument [] [this command does not take any arguments] [none] [0]; -docident [kickbot] [Kicks the bot with the given name out of the current game.]; -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 [jump] [Triggers a jump.]; +docremark [default keys: space and right ctrl.]; docident [knftoggle] [Toggles between your primary weapon and your knife. (must be binded to a key)]; docident [lanconnect] []; docident [lastgametimeupdate] [Returns the last time (in milliseconds) the gametime was updated. READ ONLY]; -docident [lasttarget] [Returns the name of the last player you aimed at.]; -docremark [Returns nothing "" if you have not yet aimed at a player.]; +docident [lastpm] [Holds the CN of the last client who sent you a private message.]; +docremark [If you haven't recieved any private messages, 'lastpm' is -1]; +docident [left] [Moves the player left.]; +docremark [default keys: A and Left Arrow]; docident [listcomplete] []; 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 argument T.]; +docargument [T] [type] [default, teammate, scope, edit, knife, pistol, carbine, shotgun, subgun, sniper, assault, grenade, akimbo] [0]; docargument [I] [image] [] [0]; -docargument [T] [type] [all, scope, teammate, knife, pistol, carbine, shotgun, smg, sniper, ar, cpistol, grenades, akimbo] [0]; docexample [loadcrosshair red_dot.png] [Loads the red_dot.png crosshair for all weapons.]; -docexample [loadcrosshair red_dot.png all] [Same as above. Loads the red_dot.png crosshair for all weapons.]; -docexample [loadcrosshair red_dot.png knife] [Loads the red_dot.png crosshair for your knife only.]; -docexample [loadcrosshair red_dot.png ar] [Loads the red_dot.png crosshair for your assault rifle only.]; -docexample [loadcrosshair red_dot.png scope] [Loads the red_dot.png crosshair for your sniper rifle scope only.]; +docexample [loadcrosshair default red_dot.png] [Same as above. Loads the red_dot.png crosshair for all weapons.]; +docexample [loadcrosshair knife red_dot.png] [Loads the red_dot.png crosshair for your knife only.]; +docexample [loadcrosshair assault red_dot.png] [Loads the red_dot.png crosshair for your assault rifle only.]; +docexample [loadcrosshair scope red_dot.png] [Loads the red_dot.png crosshair for your sniper rifle scope only.]; docident [localfootsteps] [Indicates if the footsteps sound for the local player should be played]; docargument [B] [enable footsteps] [1 (true), 0 (false) min 0/max 1/default 1]; docident [magcontent] [Returns contents of current magazine.]; -docargument [N] [the weapon number] [] [0]; +docargument [N] [the weapon number or name] [0 (knife), 1 (pistol), 2 (carbine), 3 (shotgun), 4 (subgun), 5 (sniper), 6 (assault), 7 (grenades), 8 (akimbo)] [0]; docremark [A knife will always return 1.]; docremark [Weapons that aren't available will return -1.]; docident [magreserve] [Returns contents of magazine reserve.]; -docargument [N] [the weapon number] [] [0]; +docargument [N] [the weapon number or name] [0 (knife), 1 (pistol), 2 (carbine), 3 (shotgun), 4 (subgun), 5 (sniper), 6 (assault), 7 (grenades), 8 (akimbo)] [0]; 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, it votes to load the 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.]; docremark [A map given as "blah" refers to "packages/maps/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 there can be overridden per package or per map by creating a "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 it 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").]; -docident [mapname] [returns the mapname]; +docident [mapmodelzoff] [Allows negative z-offsets for mapmodels.]; +docargument [N] [mapmodel slot number] [] [0]; +docremark [A mapmodel entity is placed at a z-coordinate that is based on the floor height of map geometry and a z-offset. The z-offset is a sum of the entity attribute 3 and the third mapmodel slot parameter. The entity z-offset can range from 0 to 255 while the mapmodel slot parameter can be any integer including negative numbers. So, to place a mapmodel below floor height, the mapmodel slot parameter has to be negative.]; +docremark ["mapmodelzoff" script decreases the mapmodel slot parameter by one and increases the z-offset of every mapmodel which uses that slot also by one. This means, that all mapmodel are exact in the same place afterwards - but the entity z-offset now has room to lower the mapmodel by one more cube.]; +docremark [If you need more z-offset available, run the script several times.]; docident [mapsize] [outputs the mapsize.]; docident [mapstartalways] [If this alias exists it will be run every time the game starts a new map.]; docexample [mapstartalways = [ echo "------------------------------" ]] [This will output the string and override any other actions that might've been defined.]; @@ -845,20 +826,20 @@ docexample [echo (modenum ctf)] [Output: 5]; docexample [echo (modenum btosok)] [Output: 21]; docident [modlanconnect] [Connect to a modified LAN server.]; docremark [The modified server needs to use the original client-server protocol. The protocol version number will be the negated value of an unmodded server.]; -docident [modmdlbounceN] [change name of directory used for bounce model number N]; +docident [modmdlbounceN] [Changes name of directory used for bounce model number N.]; docremark [These setting should be loaded from config/autoexec.cfg, but they work on-the-fly too.]; docremark [If the model fails to load you will end up with nothing being displayed; use delalias to get back to default]; docexample [modmdlbounce0 = misc/my_gib1] [This will make the gib 1 model use the data inside packages/models/misc/my_gib1]; docexample [modmdlbounce1 = misc/my_gib2] [This will make the gib 2 model use the data inside packages/models/misc/my_gib2]; docexample [modmdlbounce2 = misc/my_gib3] [This will make the gib 3 model use the data inside packages/models/misc/my_gib3]; docexample [modmdlbounce3 = weapons/grenade2/static] [This will make the grenade static model use the data inside packages/models/weapons/grenade2/static]; -docident [modmdlpickupN] [change name of directory used for pickup model number N]; +docident [modmdlpickupN] [Change name of directory used for pickup model number N.]; docremark [These setting should be loaded from config/autoexec.cfg, but they work on-the-fly too.]; docremark [If the model fails to load you will end up with nothing being displayed; use delalias to get back to default]; docexample [modmdlpickup3 = health2] [This will make the health pickup model use the data inside packages/models/pickups/health2]; docexample [modmdlpickup1 = my_ammobox] [This will make the ammobox pickup model use the data inside packages/models/pickups/my_ammobox]; -docident [modmdlvwepN] [change name of directory used for weapon model (viewable/world) number N]; -docident [modmdlweapN] [change name of directory used for weapon model (hudgun) number N]; +docident [modmdlvwepN] [Changes name of directory used for weapon model (viewable/world) number N.]; +docident [modmdlweapN] [Changes name of directory used for weapon model (hudgun) number N.]; docremark [These setting should be loaded from config/autoexec.cfg, but they work on-the-fly too.]; docremark [If the model fails to load you will end up with nothing being displayed; use delalias to get back to default]; docexample [modmdlweap4 = my_subgun] [This will make the subgun hudgun model use the data inside packages/models/weapon/my_subgun]; @@ -867,13 +848,14 @@ docargument [A] [client number] [] [0]; docremark [You won't hear any further voice com messages from that player.]; docident [name] [Sets the nick name for the local player.]; docargument [N] [the name] [] [0]; -docident [nextprimary] [Returns the primary weapon on next respawn.]; -docargument [A] [weapon id] [value] [0]; +docident [nextprimary] [Sets the primary weapon on next respawn.]; +docargument [A] [the weapon number or name] [2 (carbine), 3 (shotgun), 4 (subgun), 5 (sniper), 6 (assault)] [0]; docident [nickcomplete] [adds a command to complete nicknames on]; docremark [your own nick will be ignored]; docexample [nickgreet = [ say (concat "Hello," (concatword $arg1 "!")) ]; nickcomplete nickgreet] [with this you can enter "/nickgreet " and cycle via TAB to the nickname you want to greet.]; docident [onAttack] [If defined, this will be executed each time you shot a bullet, throw a grenade or use your knife.]; docargument [weapon] [The weapon that was used] [] [0]; +docremark [Remark: it works only in singleplayer.]; docident [onCallVote] [If this alias exists it will be run every time a vote is called.]; docident [onChangeVote] [If this alias exists it will be run every time a vote is changed.]; docident [onConnect] [If defined, this will be executed when you or another player join(s) a server.]; @@ -884,32 +866,43 @@ docident [onFlag] [If defined, this will be executed each time a flag action occ docargument [action] [The action that occured] [integer (0 = stolen, 1 = dropped, 2 = lost, 3 = returned, 4 = scored, 5 = ktfscore, 6 = failed to score, 7 = reset)] [0]; docargument [actor] [The client number of the actor] [integer] [0]; docargument [flag] [The flag owner team] [integer (0 = CLA, 1 = RVSF)] [0]; +docremark [Remark: it works only in singleplayer.]; docident [onHit] [If it's defined, this alias will be executed each time a damage is done.]; docargument [actor] [The client number of the actor] [integer] [0]; docargument [target] [The client number of the target] [integer] [0]; docargument [damage] [The damage done] [integer] [0]; docargument [gun] [The number of the gun used] [integer] [0]; docargument [gib] [Is it a gib or a normal frag] [integer (0 or 1)] [0]; +docremark [Remark: it works only in singleplayer.]; docident [onKill] [If it exists, this alias will be executing when any player get killed, receiving a few arguments :]; docargument [actor] [The client number of the actor] [integer] [0]; docargument [target] [The client number of the target] [integer] [0]; docargument [gun] [The number of the gun used] [integer] [0]; docargument [gib] [Is it a gib or a normal frag] [integer (0 or 1)] [0]; +docremark [Remark: it works only in singleplayer.]; docident [onLastMin] [If this alias exists, it will be automatically executed on the last minute remaining mark.]; docident [onNameChange] [If defined, this will be executed when you or another player change(s) his name.]; -docargument [player] [The client number of the player who connected] [integer] [0]; +docargument [player] [The client number of the player who changed name] [integer] [0]; docargument [new name] [The new name of the client] [string] [0]; docremark [The alias is executed before the name is effectively changed, so you can still get the previous name of the client from this alias.]; +docremark [Remark: it works only in singleplayer.]; +docident [onPM] [If defined, this will be executed when another player sent you private message.]; +docargument [player] [The client number who sent you private message] [integer] [0]; +docargument [message] [The private message] [string] [0]; docident [onPickup] [If defined, this will be executed each time you pick up an item.]; docargument [item] [The item that was picked up] [integer (0 = pistol clips, 1 = ammo box, 2 = grenade, 3 = health, 4 = helmet, 5 = armour, 6 = akimbo)] [0]; docargument [q] [The quantity that was received] [] [0]; +docremark [Remark: it works only in singleplayer.]; docident [onReload] [If defined, this will be executed each time you reload a weapon.]; docargument [B] [was autoreload?] [0 (false), 1 (true)] [0]; +docremark [Remark: it works only in singleplayer.]; docident [onSpawn] [If defined, this will be executed each time a player spawns.]; docargument [player] [The client number of the player who spawned] [integer] [0]; +docremark [Remark: it works only in singleplayer.]; docident [onVoteEnd] [If this alias exists it will be run every time a vote passes or fails.]; docident [onWeaponSwitch] [If defined, this will be executed each time you switch to a different weapon.]; -docargument [w] [The weapon ID that you switched to] [] [0]; +docargument [W] [The weapon number that you switched to] [] [0]; +docremark [Remark: it works only in singleplayer.]; docident [paused] [Determines if the game should be paused.]; docargument [B] [pause game] [min 0/max 1/default 0]; docident [pm] [Sends a private message to a specified client.]; @@ -923,19 +916,21 @@ docexample [echo (pstat_score 0)] [Output: 0 5 3 43 1 1 unarmed]; docident [pstat_weap] [Returns the shot statistics for the player with the given clientnumber.]; docargument [C] [client] [0..N] [0]; docremark [The list is:]; -docremark [knife/atk dmg pistol/atk dmg carbine/atk dmg shotgun/atk dmg smg/atk dmg sniper/atk dmg assault/atk dmg cpistol/atk dmg nade/atk dmg akimbo/atk dmg]; +docremark [knife/atk dmg pistol/atk dmg carbine/atk dmg shotgun/atk dmg smg/atk dmg sniper/atk dmg assault/atk dmg nade/atk dmg akimbo/atk dmg]; docexample [echo (pstat_weap 0)] [Output: 0 0 0 0 0 0 0 0 0 0 1 240 15 312 0 0 3 112 0 0]; docident [quickanswer] [Easily respond the the last client who sent you a private message.]; +docident [quicknadethrow] [Switches to grenades (if available). If grenades are already selected, throw a grenade and switch back to previous weapon. (must be binded to a key)]; docident [reconnect] [Disconnects then reconnects you to the current server.]; docargument [P] [the server password] [] [0]; docident [reload] [Reloads the weapon.]; docargument [A] [] [value] [0]; -docident [resetpckservers] [Resets the list of packages source servers where to download custom content from.]; -docremark [The list of servers is saved into config/pcksources.cfg on game quit.]; docident [resetzones] [Reset all drawn zones.]; +docremark [Remark: that's optional command, disabled by default, to enable it execute "run opt/survival" or start bot surival mode from menu.]; docident [rewind] [Rewind the current demo to S seconds ago.]; docargument [S] [the number of seconds to rewind] [] [0]; docremark [Note: you can use a negative value to forward.]; +docident [right] [Moves the player right.]; +docremark [default keys: D and Right Arrow]; docident [say] [Outputs text to other players.]; docargument [S...] [the text] [] [1]; docremark [If the text begins with a percent character (%), only team mates will receive the message.]; @@ -978,22 +973,20 @@ docargument [N] [skin id] [] [0]; docident [skin_rvsf] [Choose skin when playing for team RVSF.]; docargument [N] [skin id] [] [0]; docident [sndtoggle] [Toggles between your primary weapon and your secondary weapon. (must be binded to a key)]; -docident [sortpckservers] [Sorts the available packages source servers by ascendant ping. The fastest to reach is then used by default.]; docident [spectate] [Toggles spectator mode.]; docident [spectatemode] [Sets the desired spectating mode.]; docargument [M] [the mode] [2 (1st-person), 3 (3rd-person), 4 (3rd-person transparent), 5 (free flying), 6 (overview)] [0]; dockey [SPACE] [] [switch spectator mode]; docident [start_intermission] [If this alias exists it will be run when the game reaches intermission.]; docexample [start_intermission = [ echo "INTERMISSION - STATISTICS TIME" loop p 255 [ pn = (findpn $p) if (strcmp $pn "") [ ] [ echo (concatword Player $p ":") (pstat_score $p) ":" (pstat_weap $p) ] ] echo "------------------------------" ]] [This will output the full statistics line for all players.]; -docident [stopdemo] [Stops any demo recording or playback.]; +docident [stopdemo] [Stops demo playback.]; docident [suicide] [Kills your player. You will lose 1 frag point and receive 1 death point when using this command.]; -docident [survival] [Prepares a round of bot survival mode on the specified map.]; -docargument [M] [the map to use] [] [0]; -docargument [D] [the difficulty] [0 = easy, 1 = intermediate, 2 = hard, 3 = impossible] [0]; -docremark [All official maps are compatible with survival, if you want to play survival on a custom map, prior edits/additions to the script are necessary, such as adding a zone for that specific map.]; docident [team] [Sets the team for the local player.]; -docargument [S] [the team name] [either CLA or RVSF or SPECTATOR] [0]; +docargument [N] [the team number or name] [0 (CLA), 1 (RVSF), 2 (CLA-SPECT), 3 (RVSF-SPECT), 4 (SPECTATOR)] [0]; docexample [team CLA] []; +docident [teaminfo] [Returns attributes of a team.]; +docargument [T] [Team] [cla, rvsf, 0, 1] [0]; +docargument [A] [Attribute] [Valid attributes: flags, frags, deaths, points, name, players] [0]; docident [togglespect] [cycles through all available spectator modes. Follow-1stPerson, Follow-3rdPerson, Follow-3rdPerson-transparent and Fly.]; dockey [SPACE] [] [cycle spectator modes]; docident [unignoreall] [Unignores all clients currently on the server. (only works in multiplayer)]; @@ -1017,34 +1010,109 @@ docident [votepending] [Determines if there is a vote pending or not.]; docexample [echo $votepending] [Output: if there is currently a vote pending, returns 1, else returns 0.]; docident [watchingdemo] [Returns 1 when the current game is being played from a demo, else 0.]; docexample [echo I am (at [not now] (watchingdemo)) watching a demo. "so, are you?"] []; -docident [weapon] [Changes the weapon.]; -docargument [N] [the weapon number] [0 (knife), 1 (pistol), 2 (carbine), 3 (shotgun), 4 (sub), 5 (sniper), 6 (assault), 8 (grenades), 9 (akimbo)] [0]; +docident [weapon] [Changes the weapon. (must be binded to a key)]; +docargument [N] [the number/name of available weapon] [0 (knife), 1 (pistol), 2 (carbine), 3 (shotgun), 4 (subgun), 5 (sniper), 6 (assault), 7 (grenades), 8 (akimbo)] [0]; +docident [whereami] [Prints the local client's (x,y) coordinates.]; docident [whois] [get the IP address of a given clientnumber - only admins get shown the last octet]; docargument [C] [clientnum] [] [0]; -docident [xhairwpsel] [Determines if bot waypoints should be selected/placed using the crosshair or by the nearest location to your player.]; -docargument [V] [Note: This is turned on by default.] [min 0/max 1/default 1]; +docident [winners] [Returns the team number with the highest score, or if in a non-team mode, returns the CN of the player with the highest score.]; +docsection [Keyboard and mouse] +docident [KEYPRESS] [If defined, this will be executed every time you press a key.]; +docargument [I] [integer key code] [] [0]; +docexample [checkinit KEYPRESS [echo You pressed key: (findkey $arg1)]] []; +docident [KEYRELEASE] [If defined, this will be executed every time you release a key.]; +docargument [I] [integer key code] [] [0]; +docexample [checkinit KEYRELEASE [echo You released key: (findkey $arg1)]] []; +docident [add2bind] [Adds a block of code, if it does not already exist, to a keybind.]; +docargument [K] [the key to add to] [] [0]; +docargument [C] [the code to add] [] [0]; +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 [editbind] [Similar to bind, but is only active while editing, where it overrides the regular bind for the specified key.]; +docargument [K] [the key to bind] [string] [0]; +docargument [A] [the command] [string, usually an alias] [0]; +docident [findkey] [Returns the name of a key via a specified code.]; +docargument [I] [integer] [] [0]; +docremark [Returns -255 if the key does not exist.]; +docremark [See /config/keymap.cfg for a full list of valid key codes.]; +docexample [echo (findkey 8)] [Output: BACKSPACE]; +docexample [echo (findkey 280)] [Output: PAGEUP]; +docident [findkeycode] [Returns the integer code of a key.]; +docargument [K] [the name of the key] [] [0]; +docremark [Returns -255 if the key does not exist.]; +docremark [See /config/keymap.cfg for a full list of valid key names.]; +docexample [echo (findkeycode BACKSPACE)] [Output: 8]; +docexample [echo (findkeycode PAGEUP)] [Output: 280]; +docident [findsens] [Initiate sensitivity training, to help you find what sensitivity setting you like.]; +docident [invmouse] [Sets mouse to "flight sim" mode.]; +docargument [B] [sets invmouse] [0 (off), else (on)] [0]; +docident [keybind] [Returns the contents of a keybind, bound with 'bind'.]; +docargument [K] [name of key] [] [0]; +docident [keyeditbind] [Returns the contents of a keybind, bound with 'editbind'.]; +docargument [K] [name of key] [] [0]; +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 [keyspecbind] [Returns the contents of a keybind, bound with 'specbind'.]; +docargument [K] [name of key] [] [0]; +docident [megabind] [Binds a key to many different actions depending on the current game state.]; +docargument [K] [the key to bind] [string] [0]; +docargument [D] [body of code to execute if watching a demo] [a body of code] [0]; +docargument [E] [body of code to execute if editing or in coop-edit mode] [a body of code] [0]; +docargument [C] [body of code to execute if connected to a server] [a body of code] [0]; +docargument [B] [body of code to execute if in a bot mode] [a body of code] [0]; +docargument [O] [body of code to execute if none of the other arguments have been met] [a body of code] [0]; +docremark [This command requires 6 arguments, no less. Use an empty set of brackets [] for any of the arguments that you want to "do nothing".]; +docexample [megabind F9 [echo Demo!] [echo Editing or coop!] [echo Connected!] [echo Bots!] [echo Other!]] []; +docident [mfilter] [Sets the degree of mouse filtering (0.0 being no filtering)]; +docargument [N] [Amount of mouse filtration] [min 0.0/max 6.0/default 0.0]; +docident [mouseaccel] [Sets the mouse acceleration]; +docargument [N] [acceleration factor] [min 0.0/max 1000.0/default 0.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 [resetbinds] [Resets all binds back to their default values.]; +docremark [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.]; +docident [scopesensscale] [Scales the effect of an increase or decrease in the sensitivity value when scoping. The larger the value, the smaller the difference between sensitivity values.]; +docargument [N] [the scope sensitivity scale] [min 0.001/max 1000.0/default 0.5]; +docident [searchbinds] [Search keybinds (bound with 'bind'), return keys with matching contents.]; +docargument [S] [search string] [] [0]; +docremark [This is the inverse of 'keybind']; +docexample [echo (searchbinds "reload")] [Output: R]; +docident [searcheditbinds] [Search keybinds (bound with 'editbind'), return keys with matching contents.]; +docargument [s] [search string] [] [0]; +docremark [This is the inverse of 'keyeditbind']; +docexample [echo (searcheditbinds "toggleocull")] [Output: F5]; +docident [searchspecbinds] [Search keybinds (bound with 'specbind'), return keys with matching contents.]; +docargument [s] [search string] [] [0]; +docremark [This is the inverse of 'keyspecbind']; +docident [sensitivity] [Sets the mouse sensitivity.]; +docargument [S] [the sensitivity] [floating-point] [0]; +docident [sensitivityscale] [Scales the effect of an increase or decrease in the sensitivity value. The larger the value, the smaller the difference between sensitivity values.]; +docargument [N] [the sensitivity scale] [min 0.001/max 1000.0/default 1.0]; +docident [specbind] [Similar to bind, but is only active while spectating, where it overrides the regular bind for the specified key.]; +docargument [K] [the key to bind] [string] [0]; +docargument [A] [the command] [string, usually an alias] [0]; docsection [Editing] -docident [Map editing] [A variable indicating if the game is in editmode.]; -docargument [B] [editmode] [1 (true), 0 (false) read-only]; -docident [addpath1way1] []; -docident [addpath1way2] []; -docident [addpath2way1] []; -docident [addpath2way2] []; -docident [addselection] [Select the given area, as if dragged with the mouse holding CTRL.]; +docident [addentity] [Adds an entity of the specified type at the current camera position.]; +docargument [E] [the entity type or number] [light (1), playerstart (2), pistol (3), ammobox (4), grenades (5), health (6), helmet (7), armour (8), akimbo (9), mapmodel (10), ladder (12), ctf-flag (13), sound (14), clip (15), plclip (16)] [0]; +docremark [It also returns the index number of the new entity, so that the other attributes can be set by editentity.]; +docident [addselection] [Select the given area, as if dragged with the mouse holding editmeta.]; docargument [X] [the X coordinate] [] [0]; docargument [Y] [the Y coordinate] [] [0]; docargument [XS] [the length along the X axis] [] [0]; docargument [XY] [the length along the Y axis] [] [0]; -docremark [This command is useful for making complex geometry-generating scripts. It adds a selection to the current list of selections. The dimensions of the current selections can be accessed by the commands selsx, selsy, selsxs and selsys. These commands return the list of coordinates corresponding to each selection.]; +docremark [This command is useful for making complex geometry-generating scripts. It adds a selection to the current list of selections. The dimensions of the current selections can be accessed by the commands selx, sely, selxs and selys. These commands return the list of coordinates corresponding to each selection.]; docremark [Coordinates are as follows: after a "newmap 6" the top-left corner (the one where the red dot points) are (8,8), the opposite corner is (56,56) (or (120,120) on a "newmap 7" etc.).]; -docident [addwp] [Adds a bot waypoint at the current position.]; -docargument [A] [connect automatically] [0 or 1] [0]; docident [advancemaprevision] [Select the increment of the map revision number for the next 'savemap'.]; docargument [N] [increment] [min 1/max 100/default 1]; docident [ambient] [Controls the ambient lighting of the map, i.e. how bright areas not affected by any light entities will appear.]; docargument [N] [the ambient color] [min 0x000000/max 0xFFFFFF/default 0]; -docident [ambientsoundvol] [Deletes the entity closest to the player]; -docremark [hotkey x]; docident [applymapsoundchanges] [During map editing, drop all mapsounds so they can be re-added.]; docident [arch] [Makes an arch out of the current selection.]; docargument [S] [side delta] [] [0]; @@ -1054,16 +1122,19 @@ docargument [S] [span value] [integer] [0]; docargument [V] [vertex value] [integer] [0]; docargument [D] [delta value] [integer] [0]; docremark [See config/prefabs.cfg for an example on usage.]; -docident [autowp] [Automatically place waypoints.]; +docident [automapconfig] [Enables the "automatic embedded map config data" feature.]; +docremark [With the next map save the map config file will get renamed and the map config data stored inside the map file.]; +docident [calcmipstats] [Counts all the mips in the current map and prints their numbers as 1x1/2x2/4x4/8x8/16x16/32x32/64x64.]; docident [clearents] [Deletes all entities of said type.]; docargument [T] [the entity type, see command 'newent'] [string] [0]; +docident [clearvantagepoint] [Clears a set parameters of vantage point.]; docident [closestenttype] [Restrict 'closest entity' display to one entity type.]; docargument [A] [entity type] [] [0]; docident [convertclips] [Converts the nearest entity (if its a clip or plclip) to its opposite type.]; docexample [convertclips] [Assuming the nearest entity is a clip, it will be converted to a plclip.]; docexample [convertclips] [Assuming the nearest entity is a plclip, it will be converted to a clip.]; docident [copy] [Copies the current selection into a buffer.]; -docremark [hotkey c]; +dockey [C] [] []; docident [copyent] [Copies the current closest entity into a buffer.]; docremark [Only works while in edit mode.]; docident [corner] [Makes the current selection into a "corner".]; @@ -1073,21 +1144,68 @@ dockey [K] [] []; docident [countwalls] [Returns the number of solid walls contained into the current selection.]; docargument [T] [the integer of type of the walls you want to count] [ 0 (solid), 1 (corner), 2 (floor heightfield), 3 (ceil heightfield), 4 (empty cube), 5 (semi solid)] [0]; docexample [echo (concat "The selection contains " (countwalls 0) "solid wall(s)")] [Output: The selection contains 3 solid wall(s)]; -docident [delent] [Deletes the entity closest to the player]; -docremark [hotkey x]; -docident [delpath1way1] []; -docident [delpath1way2] []; -docident [delpath2way1] []; -docident [delpath2way2] []; -docident [delwp] [Deletes the selected waypoint.]; +docident [delent] [Deletes the entity closest to the player.]; +dockey [BACKSPACE] [] []; +docident [deleteentity] [Deletes a map entity.]; +docargument [N] [entity index/number] [] [0]; +docremark [Note: deleting an entity only marks it as unused. It will be completely removed after saving and loading the map.]; +docident [deletemapmodelslot] [Deletes an unused mapmodel slot.]; +docargument [N] [mapmodel slot number] [] [0]; +docargument [P] [purge] [] [0]; +docremark [If "purge" is specified as second argument, it also deletes an used slot (including all map entities which use that mapmodel).]; +docremark [Also it enables automapconfig.]; +docident [deletemapsoundslot] [Deletes an unused map sound slot.]; +docargument [N] [map sound slot number] [] [0]; +docargument [P] [purge] [] [0]; +docremark [If "purge" is specified as second argument, it also deletes an used slot (including all map entities which use that sound).]; +docremark [Also it enables automapconfig.]; +docident [deletetextureslot] [Deletes an unused texture slot.]; +docargument [N] [texture slot number] [0..255] [0]; +docargument [P] [delete used slot?] [purge] [0]; +docargument [R] [replacement slot] [0..255] [0]; +docremark [If "purge" word is put as second argument, it also deletes an used slot. All mapmodels that use that texture as skin are changed to default skin. All world geometry, which uses the texture, is instead set to use slot #255 or a specified replacement slot. Slots below #5 always require "purge", no matter if they are in use (default slots).]; +docremark [Also enables automapconfig.]; docident [editaxis] [Contains the main axis of the player orientation.]; docargument [N] [11: X, 12: Y, 13: Z] [min 0/max 13/default 0]; +docident [editentity] [Edits a map entity.]; +docargument [N] [entity index/number] [] [0]; +docargument [A] [list of attributes] [] [0]; +docremark [It edits only parameters given a non-empty value. Returns the type and the values of all attributes (x, y, z, attr1 - attr7). It uses float values for some attributes, return values also may be float.]; +docexample [echo (editentity 33)] [Prints all attributes of map entity number 33, for example "light 174 172 12 20 255 200 200 0 0 0"]; +docexample [editentity 33 "" 173] [Changes the y-position of entity 33 to 173]; docident [editheight] [Changes the height of the current selection.]; docargument [T] [an integer denoting the type] [0 (floor), 2 (ceiling)] [0]; docargument [D] [the delta value to move it in] [1 (forwards), -1 (backwards)] [0]; docremark [Default keys are [ and ] for floor level, and o/p for ceiling.]; -docident [editing] []; -docargument [V] [] [min 1/max 0/default 0]; +docident [editing] [A variable indicating if the game is in editmode.]; +docargument [B] [editmode] [1 (true), 0 (false) read-only]; +docident [editmapmodelslot] [Edits the parameters of a mapmodel slot.]; +docargument [N] [mapmodel slot number] [integer] [0]; +docargument [R] [radius] [integer] [0]; +docargument [H] [height] [integer] [0]; +docargument [Z] [z-offset] [integer] [0]; +docargument [0] [redundant, leave it at zero so you don't break the command] [0] [0]; +docargument [P] [mapmodel path] [string] [0]; +docremark [Edits the parameters of a mapmodel slot. Only non-empty parameters actually change something.]; +docremark [The command returns the resulting data of the mapmodel slot. If only the mapmodel slot number is specified, no changes are made, but the current data is returned. Therefore the command can be used to get and set parameters.]; +docremark [If anything is changed, automapconfig is enabled.]; +docexample [editmapmodelslot 33 "" "" -5] [sets the z-offset of slot #33 to -5 without affecting other parameters]; +docexample [echo (editmapmodelslot 33)] [prints the current parameters of mapmodel slot #33 , for example: 0 0 0 0 "makke/lightbulb"]; +docident [editmapmsg] [Allows to edit the map message.]; +docident [editmapsoundslot] [Edits path/name and maxuses parameters of a mapsound slot.]; +docargument [N] [map sound slot number] [] [0]; +docargument [P] [map sound path] [] [0]; +docargument [M] [maxuses] [] [0]; +docremark [Only non-empty parameters actually change something. The command returns the resulting data of the map sound slot. If only the map sound slot number is specified, no changes are made, but the current data is returned. Therefore the command can be used to get and set parameters.]; +docremark [If anything is changed, automapconfig is enabled.]; +docident [editmeta] [First modifier key for editing mode (LCTRL by default).]; +docremark [Go to references mentioned below to see the use.]; +docident [editmeta2] [Second modifier key for editing mode (LSHIFT by default).]; +docremark [Go to references mentioned below to see the use.]; +docident [editmeta2down] [Indicates if editmeta key is pressed.]; +docargument [N] [state of the second editmeta key] [0: unpressed, 1: pressed read-only]; +docident [editmetakeydown] [Indicates if editmeta key is pressed.]; +docargument [N] [state of the first editmeta key] [0: unpressed, 1: pressed read-only]; docident [edittag] []; docargument [T] [tag] [integer value] [0]; docident [edittex] [Changes the texture on current selection by browsing through a list of textures directly shown on the cubes.]; @@ -1095,21 +1213,39 @@ docargument [T] [an integer denoting the type] [0 (floor), 1 (lower or wall), 2 docargument [D] [the direction you want to cycle the textures in] [1 (forwards), -1 (backwards)] [0]; docremark [Default keys are the six keys above the cursor keys, which each 2 of them cycle one type (and numpad 7/4 for upper).]; docremark [The way this works is slightly strange at first, but allows for very fast texture assignment. All textures are in 3 individual lists for each type (both wall kinds treated the same), and each time a texture is used, it is moved to the top of the list. So after a bit of editing, all your most frequently used textures will come first when pressing these keys, and the most recently used texture is set immediately when you press the forward key for the type. These lists are saved with the map. make a selection (including wall bits) and press these keys to get a feel for what they do.]; +docident [edittextureslot] [Edits the parameters of a texture slot.]; +docargument [N] [texture slot number] [0..255] [0]; +docargument [S] [scale] [] [0]; +docargument [P] [path] [] [0]; +docremark [Only non-empty parameters actually change something. The command returns the resulting data of the texture slot. If only the texture slot number is specified, no changes are made, but the current data is returned. Therefore the command can be used to get and set parameters.]; +docremark [If anything is changed, automapconfig is enabled.]; +docexample [edittextureslot 33 "" "arcitool/rohbaubims.jpg"] [Sets texture name of slot #33]; +docexample [echo (edittextureslot 33)] [Prints the current parameters of texture slot #33, for example: 0 "zastrow/3wood_crate_10.jpg"]; +docident [edittexturestack] [Puts a texture slot in a "last used" list up front.]; +docargument [S] [surface] [floor, wall or ceiling] [0]; +docargument [N] [texture slot number] [0..255] [0]; +docremark [The first parameter picks the list, the second parameter is the texture slot number to be used for the next edit.]; docident [edittoggle] [switches between map edit mode and normal.]; docremark [In map edit mode you can select bits of the map by clicking or dragging your crosshair on the floor or ceiling (using the "attack" identifier, normally MOUSE1), then use the identifiers below to modify the selection. While in edit mode, normal physics and collision don't apply (clips), and key repeat is ON. Note that if you fly outside the map, cube still renders the world as if you were standing on the floor directly below the camera.]; -docremark [Hotkey E]; -docident [entproperty] [Changes property of the closest entity.]; -docargument [P] [the property to change] [0..3] [0]; -docargument [A] [amount by wich the property is increased] [integer] [0]; +dockey [E] [] []; +docident [entproperty] [Changes property (attributes) of the closest entity.]; +docargument [A] [attribute index] [0..6 (atrr1 - attr7), 11..13 (x, y, z)] [0]; +docargument [I] [attribute increment] [] [0]; +docargument [U] [unscaled flag] [0 or 1] [0]; docremark [For example 'entproperty 0 2' when executed near a lightsource would increase its radius by 2.]; +docremark [Keys 1..7, in combination with the scrollwheel, can be used to alter the new entity attributes (attr1 - attr7). Pressing editmeta speeds up the scrolling. Pressing editmeta2 enables unscaled editing of entity attributes.]; +docremark [Increment is a float for some attributes. If "unscaled" flag is "1", increment is applied as unscaled integer, which means, it will change float attributes at their highest resolution.]; docident [entset] [Edits the closest entity.]; -docargument [type] [the entity type] [light, sound, clip, plclip, playerstart, pistol, ammobox, grenades, health, armour, akimbo, mapmodel, ladder, ctf-flag, helmet] [0]; -docargument [value1] [see newent 'type'] [] [0]; -docargument [value2] [see newent 'type'] [] [0]; -docargument [value3] [see newent 'type'] [] [0]; -docargument [value4] [see newent 'type'] [] [0]; -docremark [Overwrites the closest entity with the specified values.]; +docargument [E] [the entity type or number] [light (1), playerstart (2), pistol (3), ammobox (4), grenades (5), health (6), helmet (7), armour (8), akimbo (9), mapmodel (10), ladder (12), ctf-flag (13), sound (14), clip (15), plclip (16)] [0]; +docargument [attr1] [see newent 'type'] [] [0]; +docargument [attr2] [see newent 'type'] [] [0]; +docargument [attr3] [see newent 'type'] [] [0]; +docargument [attr4] [see newent 'type'] [] [0]; +docremark [Overwrites the closest entity with the specified attributes. Some attributes may be specified as floats.]; docident [entstats] [Print some map entity statistics to the console.]; +docident [enumentities] [Returns a list of the numbers of all entities of that type.]; +docargument [type] [the entity type] [light, sound, clip, plclip, playerstart, pistol, ammobox, grenades, health, armour, akimbo, mapmodel, ladder, ctf-flag, helmet] [0]; +docremark [If no such entities exist or the entity type could not be recognised, the list is empty.]; docident [equalize] [Levels the floor/ceiling of the selection.]; docargument [T] [an integer denoting the type] [0 (floor), 2 (ceiling)] [0]; docremark [default keys , and .]; @@ -1118,44 +1254,130 @@ docargument [N] [number of cubes] [integer] [0]; docremark [Instead of manually executing this command, you can bind "domodifier 11" to a key. While holding this key you can expand/shrink the current selection with the mouse wheel.]; docident [flrceil] [A variable indicating if the player looks at the floor or at the ceiling.]; docargument [B] [flrceil] [0 (floor), 2 (ceiling) read-only]; -docident [flyspeed] [Determines by how much to multiply the fly speeds by.]; -docargument [N] [the multiplier] [min 1.0/max 5.0/default 2.0]; docident [fullbright] [Sets all light values to fullbright.]; docargument [B] [sets fullbright on or off] [0 (off), 1 (on)] [0]; docremark [Will be reset when you issue a 'recalc'. Only works in edit mode.]; -docident [getentattr] []; -docident [getenttype] []; -docident [getmapmsg] [Returns the map message of the current map.]; +docident [getautomapconfig] [Returns "1" if automapconfig is already enabled, "0" otherwise.]; +docident [getclosestent] [Returns the entity index number of the closest entity (or of the pinned entity, if one exists).]; +docremark [Returns -1, if no entities are on the map.]; +docremark [Returns always exactly the entity, that edit commands like delent will use next.]; +docident [getdeletedentities] [Returns a list of deleted entities.]; +docremark [Each line contains the entity type, the position and all seven attributes.]; +docident [getentattr] [Returns the value of the selected attribute of the nearest entity.]; +docargument [A] [attribute index] [0..6] [0]; +docargument [U] [unscaled flag] [0 or 1] [0]; +docremark [It returns float values for some attributes. If "unscaled" flag is "1", raw integer values (representing the highest resolution) are returned.]; +docident [getenttype] [Returns the entity type of the nearest entity.]; +docident [getmapmodelattributes] [Returns values for all attributes to a specific mapmodel.]; +docargument [P] [model path] [] [0]; +docargument [N] [attribute name] [keywords, desc, defaults, usage, author, license, distribution, version] [0]; +docremark [If modelpath is a number, it is interpreted as index for the list of models in the current map config. If no attribute name is specified, all attributes are printed to the console instead.]; +docident [getmapsoundlist] [Returns a list of all *.wav and *.ogg files below packages/audio/ambience.]; +docident [getmapsoundorigin] [Returns the location where the map sound file actually can be found.]; +docargument [N] [filename or partial path with filename] [] [0]; +docremark [The possibilities are:]; +docremark ["official": mapsound file was found in the working directory, which indicates an official mapsound.]; +docremark ["custom": mapsound file was found in the profile directory, which means, the mapsound is either manually installed or downloaded.]; +docremark ["package dir #x": mapsound file was found in a mod directory.]; +docremark [""]; +docident [gettexturelist] [Returns a table of all texture files fitting a certain description.]; +docargument [includes] [Optional list of path prefixes to include in the table.] [] [0]; +docargument [excludes] [Optional list of path prefixes to exclude from the table.] [] [0]; +docargument [extensions] [Optional list of filename extensions to include in the table.] [] [0]; +docremark [All files found under packages/textures are examined.]; +docremark [By default, the command returns a list with two columns: path and filename. If "excludes" is exactly one path prefix to exclude, the table gets a third column with path names without that prefix. If "extensions" is exactly one extension which does not start with the character '.', the table gets an additional (third or fourth) column containing file names without that extension.]; +docexample [echo (gettexturelist)] [Outputs two columns like "noctua/wall" "wall02.jpg"]; +docexample [echo (gettexturelist "" "map_editor skymaps")] [Outputs two columns like "noctua/wall" "wall02.jpg", but omits skymaps and special textures for the editor]; +docexample [echo (gettexturelist makke)] [Outputs only textures by makke and adds a third column like "makke/rattrap" "rb_box_03.jpg" "/rattrap"]; +docexample [echo (gettexturelist "skymaps/" "" "_ft.jpg")] [Outputs four columns like "skymaps/egypt" "egypt_ft.jpg" "egypt" "egypt", "skymaps/humus" "meadow_ft.jpg" "humus" "meadow"]; +docident [gettextureorigin] [Returns the location where the texture file actually can be found.]; +docargument [N] [filename or partial path with filename] [] [0]; +docremark [The possibilities are:]; +docremark ["official": texture file was found in the working directory, which indicates an official texture.]; +docremark ["custom": texture file was found in the profile directory, which means, the texture is either manually installed or downloaded.]; +docremark ["package dir #x": texture file was found in a mod directory.]; +docremark [""]; +docident [gotoentity] [Jump to the location of a map entity.]; +docargument [N] [the entity number] [] [0]; +docremark [You can get the entity number with use "enumentities" command.]; +docident [gotoposition] [Only in edit mode: get and set camera position.]; +docargument [x] [X coordinate] [float] [0]; +docargument [y] [Y coordinate] [float] [0]; +docargument [z] [Z coordinate] [float] [0]; +docargument [yaw] [yaw] [integer] [0]; +docargument [pitch] [pitch] [integer] [0]; +docremark [Returns x, y, z, yaw and pitch. Sets x, y, z, yaw and pitch, if the parameter is not an empty string.]; +docexample [echo (gotoposition)] [Output: 67.7 78.6 5.5 8 0]; +docexample [gotoposition "" "" "" 180 0] [Change yaw and pitch to look straight in +y direction.]; +docident [gotovantagepoint] [Sets camera position in vantage point.]; docident [guidetoggle] [Enables or disables a special set of default textures while editing.]; docremark [The textures in "packages/textures/map_editor" are used.]; docident [heightfield] [Marks the current selection as a heightfield.]; docargument [T] [an integer denoting the type] [0 (floor), 2 (ceiling)] [0]; docremark [marks the current selection as a heightfield, with T being floor or ceiling, as above. A surface marked as heightfield will use the vdelta values (see below) of its 4 corners to create a sloped surface. To mark a heightfield as normal again (ignoring vdelta values, set or not) use "solid 0". Default keys are h (floor) and i (ceiling).]; docremark [Heightfields should be made the exact size that is needed, not more not less. The most important reason for this is that cube automatically generates "caps" (side-faces for heightfields) only on the borders of the heightfield. This also means if you have 2 independent heightfields accidentally touch each other, you will not get correct caps. Also, a heightfield is slightly slower to render than a non-heightfield floor or ceiling. Last but not least, a heightfield should have all the same baseheight (i.e. the height determined by a normal editheight operation) to get correct results.]; -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 [hudtexttl] [show preview of textures during editing.]; +docargument [T] [time to show texture preview [ms]] [min 0/max 10000/default 2500]; +docremark [When textures of the map geometry are changed, five textures around the current pick from the "last used" stack are shown.]; +docremark [The texture assigned to the "sky" slot is not shown. Instead, a plain blue rectangle is used.]; +docident [listallmapmodelattributes] [Returns a table of all known mapmodels.]; +docargument [N] [list of attribute names] [explodekeywords, sortby:, keywords, desc, defaults, usage, author, license, distribution, version] [0]; +docremark [Each model is listed with the modelpath and the values for the requested attributes. To be used instead of a fixed table in menu_edit.cfg.]; +docremark [In addition to attribute names, the function also allows the keywords "explodekeywords" and "sortby:" as arguments. If "explodekeywords" is given, all mapmodels with more than one keyword are listed multiple times, once for each keyword. If an attribute name is preceeded by "sortby:" the list will be sorted by this table column. If "sortby:" is used several times, this first sort will have highest priority. The list is always sorted by path by default.]; +docexample [getmapmodelattributes sortby: author sortby: desc explodekeywords] []; +docident [loadallmapmodels] [Tries to load mapmodels from all paths below packages/models/mapmodels.]; +docremark [It will throw a lot of error messages, because not all directories contain models to load. This command can be used to build or rebuild the complete list of all available mapmodels. It is only necessary, if models are added manually to the directories, since every mapmodel gets added to the list when it is loaded - which takes care of all automatically downloaded models.]; docident [mapbackupsonsave] [Determines if map backups (.bak) should be created when a map is saved.]; docargument [N] [0 off, 1 on] [min 0/max 1/default 1]; docident [mapenlarge] [Enlarges the current map.]; docremark [This command will make the current map 1 power of two bigger. So a size 6 map (64x64 units) will become a size 7 map (128x128), with the old map in the middle (from 32-96) and the new areas solid.]; +docident [mapmodelchanged] [Set to "1" with every command that changes mapmodel slots.]; +docargument [N] [0: not changed, 1: changed] [min 0/max 1/default 0]; +docremark [Should be used to trigger a rebuild of mapsound menus.]; +docident [mapmodelregister] [Adds values for all attributes to a specific mapmodel.]; +docargument [P] [model path] [] [0]; +docargument [V] [list of all attribute values] [] [0]; +docremark [This is used to restore the cached values from config/mapmodelattributes.cfg during game start. It does not actually verify of load the model.]; +docident [mapmodelslotbyname] [Returns the slot number registered in the map config file of the model with the given name.]; +docargument [M] [mapmodel name (with path)] [] [0]; +docexample [echo (mapmodelslotbyname "mapmodels/makke/platform_bridge")] [Output: 5]; +docident [mapmodelslotname] [Returns the map model name (and path) of the mapmodel registered in the given slot number in the map config file.]; +docargument [N] [mapmodel slot number] [] [0]; +docident [mapmodelslotusage] [Returns a list of map entity indices which use a certain mapmodel slot.]; +docargument [N] [mapmodel slot number] [] [0]; +docremark [If the mapmodel is unused, it returns an empty string.]; +docident [mapmrproper] [Cleanups hidden map attributes.]; +docremark ["mapmrproper" tries to optimize hidden attributes of maps in a way, that the map can be handled in bigger chunks by the renderer.]; +docremark [The mipmapping routine does not take into account, if certain textures of a cube are visible at all, when it collects otherwise identical cubes to be handled en-bloc. "mapmrproper" changes invisible textures in a way, that the cubes are in fact identical - so, that the mipmapper is satisfied. The optimizer does not change any map properties that are visible in any way.]; +docremark [Before any changes are made, mapmrproper creates a backup, which can be restored by "undo" command. Enable mipstats ("showmip" command), to see, what has been done.]; docident [mapmsg] [Sets the map message, which will be displayed when the map loads.]; docargument [M] [The map message] [String] [0]; docremark [You will need to use quote marks around the message, otherwise it save the message correctly.]; docremark [For example: /mapmsg "Map By Author"]; +docremark [You can get the current map message with the $mapmsg variable.]; docident [mapshrink] [Reduces the world size by 1.]; docremark [This command will make the current map 1 power of two smaller. So a size 7 map (128x128) will become a 6 size map (64x64 units), by removing 32 cubes from each side. The area to be removed needs to be empty (= all solid).]; +docident [mapsoundchanged] [Set to "1" with every command that changes mapsound slots.]; +docargument [N] [0: not changed, 1: changed] [min 0/max 1/default 0]; +docremark [Should be used to trigger a rebuild of mapsound menus.]; +docident [mapsoundslotbyname] [Returns the list of numbers of all mapsound slots which use that sound file.]; +docargument [N] [map sound filename] [] [0]; +docident [mapsoundslotusage] [Returns a list of map entity indices which use a certain map sound slot.]; +docargument [N] [map sound slot number] [] [0]; +docremark [If the sound is unused, it returns an empty string.]; +docident [mapstats_hud] [Controls whether or not to show map statistics on map load.]; +docargument [N] [0: Don't show, 1: Show] [min 0/max 1/default 0]; docident [movemap] [Move the whole map (including all entities) in the specified direction.]; docargument [dX] [x-offset] [] [0]; docargument [dY] [y-offset] [] [0]; docargument [dZ] [z-offset] [] [0]; docident [newent] [Adds a new entity]; -docargument [type] [the entity type] [light, sound, clip, plclip, playerstart, pistol, ammobox, grenades, health, armour, akimbo, mapmodel, ladder, ctf-flag, helmet] [0]; -docargument [value1] [see newent 'type'] [] [0]; -docargument [value2] [see newent 'type'] [] [0]; -docargument [value3] [see newent 'type'] [] [0]; -docargument [value4] [see newent 'type'] [] [0]; -docremark [(x,y) is determined by the current selection (the red dot corner) and z by the camera height, of said type. Type is a string giving the type of entity, such as "light", and may optionally take values (depending on the entity).]; +docargument [E] [the entity type or number] [light (1), playerstart (2), pistol (3), ammobox (4), grenades (5), health (6), helmet (7), armour (8), akimbo (9), mapmodel (10), ladder (12), ctf-flag (13), sound (14), clip (15), plclip (16)] [0]; +docargument [attr1] [see newent 'type'] [] [0]; +docargument [attr2] [see newent 'type'] [] [0]; +docargument [attr3] [see newent 'type'] [] [0]; +docargument [attr4] [see newent 'type'] [] [0]; +docremark [(x,y) is determined by the current selection (the red dot corner) and z by the camera height, of said type. The type of entity may optionally take attributes (depending on the entity).]; docident [newent akimbo] [Adds a new akimbo item.]; docident [newent ammobox] [Adds a new ammo box item.]; docident [newent armour] [Adds a new armour item.]; @@ -1202,28 +1424,21 @@ docargument [N] [the sound to play] [integer] [0]; docargument [R] [the radius] [] [0]; docargument [S] [the size] [default 0] [0]; docargument [V] [the volume] [default 255] [0]; -docremark [Will play map-specific sound so long as the player is within the radius. However, only up to the max uses allowed for N (specified in the mapsound command) will play, even if the player is within the radius of more N sounds than the max. By default (size 0), the sound is a point source. Its volume is maximal at the entity's location, and tapers off to 0 at the radius. If size is specified, the volume is maximal within the specified size, and only starts tapering once outside this distance. Radius is always defined as distance from the entity's location, so a size greater than or equal to the radius will just make a sound that is always max volume within the radius, and off outside.]; +docremark [Will play map-specific sound so long as the player is within the radius. However, only up to the maxuses allowed for N (specified in the mapsound command) will play, even if the player is within the radius of more N sounds than the max. By default (size 0), the sound is a point source. Its volume is maximal at the entity's location, and tapers off to 0 at the radius. If size is specified, the volume is maximal within the specified size, and only starts tapering once outside this distance. Radius is always defined as distance from the entity's location, so a size greater than or equal to the radius will just make a sound that is always max volume within the radius, and off outside.]; docremark [A sound entity can be either ambient or non-ambient. Ambient sounds have no specific direction, they are 'just there'. Non-ambient sounds however appear to come from a specific direction (stereo panning). If S is set to 0, the sound is a single point and will therefore be non-ambient. However if S is greater than 0, the sound will be ambient as it covers a specified area instead of being a single point.]; docident [newmap] [Creates a new map.]; docargument [S] [the size of the new map] [6..9] [0]; docremark [The new map has 2^S cubes. For S, 6 is small, 7 medium, 8 large.]; -docident [newselkeys] [Binds a list of keys to be used to create new (multiple) selections in editmode.]; -docremark [LCTRL is default.]; -docexample [newselkeys = [LCTRL RCTRL LALT RALT]] [Makes all 4 keys create new (multiple) selections in editmode.]; docident [nextclosestent] [Choose another 'closest ent'.]; docremark [Use this, when two entities are placed in exactly the same location.]; docident [nextplayerstart] [Visit next player spawn entity.]; docargument [TYPE] [0|1|100] [] [0]; -docident [old_editbinds] [Enables or disables the old editing binds.]; -docremark [If disabled, an updated editing binds system is used, see the comments in "/config/resetbinds.cfg" for more info.]; -docexample [old_editbinds = 0] [disables the old editing binds]; -docexample [old_editbinds = 1] [enables the old editing binds]; -docident [oldselstyle] [Enables or disables using triangles to render the editing grid/current selection instead of squares.]; +docident [oldselstyle] [Enables or disables using squares to render the editing grid/current selection instead of triangles.]; docargument [N] [0 off, 1 on] [min 0/max 1/default 1]; -docident [onNewMap] [If this alias exists, it will be automatically executed when you start a new map.]; +docident [onNewMap] [If this alias exists, it will automatically be executed when you create a new map via the "newmap" command (not to be confused with loading an existing map).]; docident [paste] [Pastes a previously copied selection.]; docremark [To paste a selection back requires a same size selection at the destination location. If it is not the same size the selection will be resized automatically prior to the paste operation (with the red dot as anchor), which is easier for large selections.]; -docremark [hotkey v]; +dockey [V] [] []; docident [pasteent] [Pastes a previously copied entity.]; docremark [Only works while in edit mode.]; docident [perlin] [Generates a perlin noise landscape in the current selection.]; @@ -1232,13 +1447,17 @@ docargument [E] [the random seed] [integer] [0]; docargument [C] [cube size, how many cubes to generate a surface for at once (unused)] [] [0]; docremark [Keep the seed the same to create multiple perlin areas which fit with each other, or use different numbers if to create alternative random generations.]; docident [recalc] [Recomputes all there is to recompute about a map, currently only lighting.]; -docremark [hotkey R]; -docident [registersound] [Registers a sound.]; -docargument [N] [sound name] [string, see config/sounds.cfg] [0]; -docremark [This command returns the sound number, which is assigned from 0 onwards, and which can be used with "sound" command. If the sound was already registered, its existing index is returned. registersound does not actually load the sound, this is done on first play.]; -docremark [See for example config/sounds.cfg.]; +docident [redo] [Redoes editing operations undone by 'undo'.]; +docremark [With editmeta pressed it also restores player position and selects the affected area.]; +dockey [R] [] []; docident [replace] [Repeats the last texture edit throughout the map.]; docremark [The way it works is intuitive: simply edit any texture anywhere, then using "replace" will replace all textures throughout the map in the same way (taking into account whether it was a floor/wall/ceil/upper too). If the there was more than one "old" texture in your selection, the one nearest to the red dot is used. This operation can't be undone.]; +docident [rereadsoundlists] [Variable, which is set to "1" when a sound is downloaded.]; +docargument [N] [is sound downloaded?] [0: no, 1: yes min 0/max 1/default 1]; +docremark [Used to trigger menu rebuilds.]; +docident [rereadtexturelists] [Variable, which is set to "1" when a texture is downloaded.]; +docargument [N] [is texture downloaded?] [0: no, 1: yes min 0/max 1/default 1]; +docremark [Used to trigger menu rebuilds.]; docident [resetselections] [Resets all current selections.]; docident [savemap] [Saves the current map.]; docargument [M] [file name of the map, see command 'map' for the naming scheme] [string] [0]; @@ -1259,23 +1478,34 @@ docargument [AXIS] [X or Y] [] [0]; docident [selectionrotate] [Rotate the selected part of the map in 90 degree steps.]; docargument [D] [steps] [] [0]; docremark [To rotate clockwise, use a positive number of steps. Note, that only quadratic selections can be rotated by 90 degrees.]; -docident [selsx] [Return a list containg the x-coordinate of each selection]; -docident [selsxs] [Return a list containg the x-span of each selection]; -docident [selsy] [Return a list containg the y-coordinate of each selection]; -docident [selsys] [Return a list containg the y-span of each selection]; -docident [setjumpwp] []; +docident [selx] [Returns the x-coordinate of the westernmost (towards negative x) cube(s) in the current selection.]; +docident [selxs] [Returns the x-span (size on the x-axis) of the current selection.]; +docident [sely] [Returns the y-coordinate of the northernmost (towards negative y) cube(s) in the current selection.]; +docident [selys] [Returns the y-span (size on the y-axis) of the current selection.]; docident [settex] [Set a texture for the current selection.]; docargument [T] [position of the texture to set in map cfg] [integer] [0]; docargument [t] [the type of the texture] [0 (floor), 1 (wall), 2 (ceil), 3 (upper wall)] [0]; -docident [setwpyaw] [takes the current player yaw for the current waypoint]; +docident [setvantagepoint] [Sets vantage point in current camera position.]; +docremark [The vantage point is supposed to be a distinctive view on a map - like the angle from which the preview picture was taken.]; +docremark [A map can only have one vantage point.]; docident [showclips] [Show clips/plclips/mapmodel clips in edit mode.]; docargument [N] [-] [min 0/max 1/default 1]; +docident [showfocuscubedetails] [Shows detailed geometry data of the cube inside editing focus.]; +docremark [It shows on the HUD cube type, floor and ceiling heights, vdelta and all textures.]; docident [showgrid] [Show editing cursor grid.]; docargument [N] [-] [min 0/max 1/default 1]; +docident [showmapdims] [Prints map dimensions.]; +docident [showmapstats] [Prints some map statistics.]; docident [showmip] [Toggles between showing what parts of the scenery are rendered.]; docremark [Shows what parts of the scenery are rendered using what size cubes, and outputs some statistics about it. This can give map editors hints as to what architecture to align, textures to change, etc.]; +docremark [If "showfocuscubedetails" is enabled, "showmip" stats on the HUD are hidden.]; docident [showmodelclipping] [Show mapmodel clipping during edit mode.]; docargument [N] [-] [min 0/max 1/default 0]; +docident [showplayerstarts] [Show all playerstarts in edit mode.]; +docargument [N] [0: hide, 1: show] [min 0/max 1/default 0]; +docremark [Set showplayerstarts to "1" to see a playermodel rendered at all playerstart entities.]; +docident [showtagclips] [Show tagclips/tagplclips in edit mode.]; +docargument [N] [-] [min 0/max 1/default 1]; docident [shrinkselection] [Decreases the size of the current selection by N cubes on all sides.]; docargument [N] [number of cubes] [integer] [0]; docremark [Instead of manually executing this command, you can bind "domodifier 11" to a key. While holding this key you can expand/shrink the current selection with the mouse wheel.]; @@ -1286,84 +1516,189 @@ docremark [The selection must be a heightfield before this command can be used. docident [solid] [makes the current selection all solid (i.e. wall) or all non-solid.]; docargument [B] [an integer denoting the solid-ness] [0 (non-solid), 1..* (solid)] [0]; docremark [This operation retains floor/ceiling heights/textures while swapping between the two. Default keys f and g respectively.]; -docident [telebot] [teletransports the bot with the lowest connection number to you current position.]; -docargument [] [this command does not take any arguments] [none] [0]; -docremark [This is a debugging command and only works for single player modes.]; -docident [testvisible] []; -docargument [D] [direction] [0..5 for Forward, Backward, Left, Right, Up AND Down] [0]; -docident [togglebotview] [When used you will see what the bot sees. Type it again (with or without name) to return to the game(you will respawn).]; -docargument [N] [botname] [the name of the bot] [0]; +docident [textureslotbyname] [Returns the list of numbers of all texture slots which use that texture file.]; +docargument [N] [texture filename] [] [0]; +docident [textureslotusage] [Returns a list of mapmodels who use that texture as skin.]; +docargument [N] [texture slot number] [0..255] [0]; +docremark [If no mapmodel uses the texture, but world geometry does, a string of whitespace is returned. If the mapmodel is unused, an empty string is returned.]; +docident [textureslotusagelist] [Returns a list of 256 numbers representing the number of uses for every texture slot.]; +docargument [W] [what] [onlygeometry, onlymodels] [0]; +docremark [If "what" is "onlygeometry", the uses as map model skin do not count. If "what" is "onlymodels", the uses in map geometry do not count.]; +docident [toggleclosestentpin] [Toggles the pin on the "closest entity" selector.]; +docremark [The HUD will indicate the lock by showing "pinned" instead of "closest" entity. All actions, that would otherwise affect the closest entity, will affect the pinned entity instead. Deleting the locked entity will unlock it.]; +docremark [Bound to MOUSE3 (middle mouse button) by default.]; docident [togglegrab] [Will toggle the focus of the mouse in game. Normally you can use your mouse to look around, when you type this command your mouse cursor is visible and can be used as normally. This is only useful when you run cube windowed.]; docident [toggleocull] [Turns occlusion culling on and off.]; docremark [The reason one may want to turn it off is to get an overview of the map from above, without having all occluded bits stripped out.]; -docident [undo] [Multi-level undo of any of the changes caused by editing operations]; -docremark [hotkey u]; +docident [transformclipentities] [Transforms all clip entities to tag clips, if they are big enough (so that no player could be above or below them).]; +docident [undelent] [Restores deleted entity.]; +docargument [I] [index] [] [0]; +docremark [If no index is specified, the last deleted entity is restored. If an index is given, the specified entity from the list of deleted entities is restored.]; +docremark [BACKSPACE in combination with editmeta undeletes the last deleted entity.]; +docremark [BACKSPACE in combination with editmeta2 brings up the menu "deleted entities".]; +docident [undo] [Multi-level undo of any of the changes caused by editing operations.]; +docremark [With editmeta pressed it also restores player position and selects the affected area.]; +dockey [U] [] []; docident [undomegs] [Sets the number of megabytes used for the undo buffer.]; -docargument [N] [number of megabytes, default is 1] [integer] [0]; -docremark [undo's work for any size areas, so the amount of undo steps per megabyte is more for small areas than for big ones (a megabyte fits 280 undo steps on a 16x16 area, but only 4 steps on a 128x128 area).]; -docident [unsetjumpwp] []; +docargument [N] [number of megabytes] [integer min 0/max 50/default 5]; +docremark [Undo's work for any size areas, so the amount of undo steps per megabyte is more for small areas than for big ones (a megabyte fits 280 undo steps on a 16x16 area, but only 4 steps on a 128x128 area).]; +docident [unlistdeletedentity] [Removes entities from the list of deleted entities.]; +docargument [W] [which] [[a number], all or last] [0]; +docremark [If is a number, the specified entry from the list of deleted entities gets removed.]; +docremark [If is "all", the whole list of deleted entities gets deleted.]; +docremark [If is "last" the last deleted entity is removed from the list of deleted entities.]; +docremark [Returns the number of entities on the list of deleted entities (even if the parameter was unknown or not specified).]; +docident [unsavededits] [Holds the number of unsaved edits.]; docident [vdelta] [changes the vdelta value of the current selection]; docargument [N] [vdelta value] [] [0]; docremark [Note that unlike all other editing functions, this function doesn't affect a cube, but its top-left vertex (market by the dot in the editing cursor). So to edit a N * M heightfield, you will likely have to edit the vdelta of (N+1) * (M+1) cubes, i.e. you have to select 1 row and 1 column more in the opposite direction of the red dot to affect all the vertices of a heightfield of a given size (try it, it makes sense :)]; docremark [A floor delta offsets vertices to beneath the level set by editheight (and a ceil delta to above). Delta offsets have a precision of a quarter of a unit, however you should use non-unitsize vertices only to touch other such vertices. Default keys are 8 and 9 to decrease/increase the vdelta.]; docident [waterlevel] [Sets the global water level for the map.]; -docargument [H] [the water level] [integer] [0]; +docargument [H] [the water level] [float, -10000="no water" min -128/max 127/default -10000]; docremark [Every cube that has a lower floor than the water level will be rendered with a nice wavy water alpha texture. Water physics will be applied to any entity located below it.]; docremark [Performance notes: water is rendered for a whole square encapsulating all visible water areas in the map (try flying above the map in edit mode to see how). So the most efficient water is a single body of water, or multiple water areas that are mostly not visible from each other. Players can influence how accurate the water is rendered using the "watersubdiv" command (map config).]; -docident [wpclear] []; -docident [wpflood] []; -docident [wpinfo] [makes waypoints visible and either turns on or off the waypoint information display.]; -docargument [Y] [show info?] [0||1] [0]; -docident [wpload] []; -docident [wpsave] []; -docident [wpvisible] []; -docargument [V] [visible] [0||1] [0]; +docident [xmap_delete] [Deletes the named snapshot.]; +docargument [N] [nickname] [] [0]; +docident [xmap_delete_backup] [Deletes the backup xmap.]; +docident [xmap_keep_backup] [Moves the backup xmap to a regular named spot.]; +docargument [N] [nickname] [] [0]; +docident [xmap_list] [Lists all xmaps currently in memory.]; +docident [xmap_rename] [Changes the nickname of the xmap.]; +docargument [O] [old nickname] [] [0]; +docargument [N] [new nickname] [] [0]; +docident [xmap_restore] [Restores the xmap snapshot.]; +docargument [N] [nickname] [] [0]; +docremark [1. If nickname is not given, it restores the last automatic backup snapshot. Automatic snapshots are taken:]; +docremark [a) before a snapshot is restored,]; +docremark [b) before a new map is loaded (if there were unsaved edits on the map) and]; +docremark [c) when the game ends (if there were unsaved edits).]; +docremark [2. If nickname is given, the command restores the named snapshot, it also creates a backup snapshot of the current editing data.]; +docident [xmap_store] [Creates a snapshot and stores it under the given nickname.]; +docargument [N] [nickname] [] [0]; +docremark [Nicknames have to qualify as valid filenames.]; docsection [Menus] +docident [browsefiledesc] [Toggles getting descriptive text from CGZ or DMO files in menudirlist.]; +docargument [B] [] [min 0/max 1/default 1]; 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 [chmenutexture] [Displays a texture on the right side of a menu.]; +docargument [N] [the name of the menu] [] [0]; +docargument [P] [the path to the texture] [] [0]; +docargument [T] [the title of the picture] [] [0]; +docremark [By specifying a title string in the third argument to chmenutexture, a picture is rendered instead of a texture. The title string is displayed instead of the texture resolution. The variable "menupicturesize" holds a size modifier for pictures, similar to "menutexturesize".]; +docident [closecurmenu] [Closes the currently open menu.]; +docremark [If more than one menu is open, only closes the topmost menu on the stack.]; docident [closemenu] [Closes the specified menu if it is open.]; docargument [N] [the name of a previously defined menu] [] [0]; docremark [If it is open multiple times in the stack only the topmost instance will be closed!]; +docident [curmenu] [Returns the name of the currently open menu.]; +docremark [If more than one menu is open, only the name of the topmost menu on the stack is returned.]; docident [delmenu] [Deletes the entire contents (all menu items) of the given menu.]; docargument [N] [the name of a previously defined menu] [] [0]; +docident [hidebigmenuimages] [Hide big images in menus.]; +docargument [N] [0: show, 1: hide] [min 0/max 1/default 0]; +docident [menucanblink] [for toggling on the ability for menutext to have the blinking bit set. The global setting of 'allowblinkingtext' overrides this]; +docargument [T] [0 = Off, Any other integer = On] [Any integer is valid, positive or negative] [0]; +docident [menudirlist] [Create a menu listing of files from a path and perform an action on them when clicked.]; +docargument [P] [the directory path from the assaultcube root] [] [0]; +docargument [E] [file extension] [] [0]; +docargument [A] [action] [] [0]; +docargument [I] [show image from a file] [0 or 1] [0]; +docargument [S] [string - search it in map/demo filenames and descriptions and show only matched files (case insensitive)] [] [0]; +docremark [Use this inside menu definitions, almost always as the only command of that menu.]; +docremark [Compare the usage inside config/menus.cfg]; +docexample [menudirlist "packages/maps" "cgz" "map $arg1"] [will create a list of maps and load them when clicked]; +docident [menufont] [Switches the font in which the menu is displayed]; +docargument [F] [font] [default, mono, serif] [0]; +docident [menuheader] [Adds header and/or footer to the menu.]; +docargument [H] [header] [] [0]; +docargument [F] [footer] [] [0]; docident [menuinit] [Specifies commands to be executed when a menu opens.]; docargument [C] [The code to execute on init] [] [0]; docremark [This command should be placed after newmenu.]; docident [menuinitselection] [Defines the initial selection for a menu.]; docargument [A] [line number] [] [0]; docident [menuitem] [Creates a new menuitem.]; -docargument [N] [The menuitem description.] [] [0]; -docargument [A] [The command to execute on selection of the menuitem.] [] [0]; -docargument [H] [The command to execute upon rolling over the menuitem.] [] [0]; +docargument [T] [the text content in menu line] [] [0]; +docargument [A] [the command to execute on selection of the menuitem] [] [0]; +docargument [H] [the command to execute upon rolling over the menuitem] [] [0]; +docargument [D] [the description of menu item, which is displayed on the menu footer] [] [0]; docremark [Upon activating the menuitem, the associated command will be executed. (See config/menus.cfg for examples). If the command argument is omitted, then it will be set to the same value as the description. If -1 is specified instead of the command to execute, then no command is executed when activating the item. If the rollover option is used, the menuitem will execute that command when selecting (but not activating) the menuitem.]; docremark [(Note: To activate the menu item, select it, and either: Click, press SPACE or press ENTER/Return).]; -docident [menuitemcheckbox] []; +docident [menuitemaltfont] [Displays a menu line with a text which may contain chars from an alternate font.]; +docargument [N] [the name of the alternate font] [default, mono, serif, huddigits, serverquality, bargraphs, radaricons] [0]; +docargument [T] [text content in menu line] [] [0]; +docargument [A] [action] [] [0]; +docargument [H] [hoveraction] [] [0]; +docargument [D] [description displayed on menu footer] [] [0]; +docremark [Chars from the alternate font have to be marked with "\a". Alternate font chars have no width and are just rendered above the following text. Use spaces to counter that.]; +docident [menuitemcheckbox] [Creates a checkbox menu item.]; +docargument [T] [text] [] [0]; +docargument [V] [value] [] [0]; +docargument [A] [action] [] [0]; docident [menuitemimage] []; +docargument [N] [image filename] [] [0]; +docargument [T] [text] [] [0]; +docargument [A] [action] [] [0]; +docargument [H] [hoveraction] [] [0]; docident [menuitemkeyinput] []; +docargument [T] [text] [] [0]; +docargument [B] [bind command] [] [0]; +docident [menuitemmapload] [a menuitem that loads a map, displays the title and the preview or a default image]; +docargument [M] [map] [] [0]; +docargument [T] [text] [] [0]; docident [menuitemslider] []; +docargument [T] [text] [] [0]; +docargument [L] [min] [] [0]; +docargument [U] [max] [] [0]; +docargument [V] [value] [] [0]; +docargument [S] [step] [] [0]; +docargument [D] [display] [] [0]; +docargument [A] [action] [] [0]; docident [menuitemtextinput] []; +docargument [T] [text] [] [0]; +docargument [V] [value] [] [0]; +docargument [A] [action] [] [0]; +docargument [H] [hoveraction] [] [0]; +docargument [M] [maxchars] [] [0]; docident [menuitemvar] [Creates a new menuitem with variable content.]; -docargument [N] [The cubescript to generate the menuitem description.] [] [0]; -docargument [A] [The command to execute on selection of the menuitem.] [] [0]; -docargument [H] [The command to execute upon rolling over the menuitem.] [] [0]; +docargument [N] [the cubescript to generate the menuitem description] [] [0]; +docargument [A] [the command to execute on selection of the menuitem] [] [0]; +docargument [H] [the command to execute upon rolling over the menuitem] [] [0]; docremark [Like 'menuitem', but the menuitem description will be the result of an evaluation, everytime the menu gets displayed.]; 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 [menupicturesize] [Changes the size of pictures displayed in menus.]; +docargument [N] [size factor] [min 0.1f/max 5.0f/default 1.6f]; +docident [menurenderoffset] [Moves a menu away from the middle of the screen.]; +docargument [X] [x-offset] [] [0]; +docargument [Y] [y-offset] [] [0]; +docremark [Values of "100" represent half the screen width and height.]; docident [menuselection] [Selects a line in a menu.]; docargument [A] [menu name] [] [0]; docargument [B] [line number] [] [0]; docident [menuselectionbgcolor] [Defines the background color for the menu selection bar.]; -docargument [R] [red (0..100)] [] [0]; -docargument [G] [green (0..100)] [] [0]; -docargument [B] [blue (0..100)] [] [0]; -docargument [A] [alpha (0..100)] [] [0]; +docargument [R] [red] [0..100] [0]; +docargument [G] [green] [0..100] [0]; +docargument [B] [blue] [0..100] [0]; +docargument [A] [alpha] [0..100] [0]; +docident [menuselectiondescbgcolor] [Defines the background color for the description of selected active menu items (checkbox, slider, text input).]; +docargument [R] [red] [0..100] [0]; +docargument [G] [green] [0..100] [0]; +docargument [B] [blue] [0..100] [0]; +docargument [A] [alpha] [0..100] [0]; +docident [menuselectionpersistent] [Enables persistent selections for the currently displayed menu]; +docremark [When enabled, it restores a previously saved selection.]; +docremark [Probably most efficient inside "menuinit". The position is restored during execution of this command, so the menu entry has to already exist and the alias with the last position has to be read from saved.cfg. In automatically created menus it may be necessary to execute the command with a short delay.]; +docident [menutexturesize] [Changes the size of textures displayed in menus (mostly for testing purposes).]; +docargument [N] [size factor] [min 0.1f/max 5.0f/default 1.0f]; docident [newmenu] [Creates a new menu.]; docargument [N] [The name of the menu] [] [0]; docremark [All menu commands placed after newmenu (i.e. menuitem, menuitemcheckbox, etc) are added into the menu until another "newmenu" command is specified.]; @@ -1375,35 +1710,32 @@ docargument [N] [0 off, 1 on] [min 0/max 1/default 0]; docsection [Heads-Up Display] 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.]; +docident [accuracy] [Sets whether or not to display the accuracy information window.]; +docargument [N] [1: on, 0: off] [min 0/max 1/default 0]; +docremark [Accuracy is displayed for current weapon and only then, if scoreboard is turned on.]; +docident [accuracyinfo] [Shows in the console accuracy of all used weapons.]; +docident [accuracyreset] [Resets accuracy counters.]; +docident [altconsize] [Sets the percent of screen height for text lines on an alternate F11 history display.]; docargument [V] [] [min 0/max 100/default 0]; +docident [blankouthud] [Hides most of elements on the HUD for X frames.]; +docargument [X] [blank out the HUD] [min 0/max 10000/default 0]; +docremark [Used for "clean" screenshot. The parameter is "frames", so for example 1000 will take 20 seconds at 50 fps or second at 1000 fps.]; docident [clearminimap] [Recreates the minimap for the current map.]; -docident [clockdisplay] [Sets the display mode for the HUD clock.]; -docargument [D] [display mode] [min 0/max 2/default 0]; -docremark [The clock shows game-time, it is either off (0) or counts backward (1) or forward (2).]; -docident [cncolumncolor] [colour of CN column in scoreboard]; -docargument [] [] [0 (green)] [0]; -docargument [] [] [1 (blue)] [0]; -docargument [] [] [2 (yellow)] [0]; -docargument [] [] [3 (red)] [0]; -docargument [] [] [4 (gray)] [0]; -docargument [] [] [5 (white, default)] [0]; -docargument [] [] [6 (dark brown)] [0]; -docargument [] [] [7 (dark red)] [0]; -docargument [] [] [8 (purple)] [0]; -docargument [] [] [9 (orange)] [0]; -docargument [N] [color] [min 0/max 9/default 5]; +docident [cncolumncolor] [Colour of CN column in scoreboard.]; +docargument [C] [color] [0 (green), 1 (blue), 2 (yellow), 3 (red), 4 (gray), 5 (white), 6 (dark brown), 7 (dark red), 8 (purple), 9 (orange) min 0/max 9/default 5]; +docident [conalpha] [Sets the transparency of the console.]; +docargument [N] [Alpha value] [min 0/max 255/default 255]; docident [confade] [Sets how many seconds before the console text rolls (disappears) up the screen.]; docargument [V] [time before the text rolls up] [min 0/max 60/default 20]; docident [consize] [Sets how many lines of text the console displays.]; 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 is 50 or red when is 25.]; +docargument [] [turn off all effects] [0] [0]; +docargument [] [turn on all effects (color and size change)] [1 (default)] [0]; +docargument [] [turn on color change/turn off size change] [2] [0]; +docargument [] [turn off color change/turn on size change] [3] [0]; +docargument [B] [Crosshair effects] [min 0/max 3/default 1]; +docremark [When on, the crosshair will go orange when health is 50 or red when is 25. Size change of crosshair occurs when player holds assault rifle and has more than 3 shots in a row.]; 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.]; @@ -1419,10 +1751,11 @@ docident [damageindicatortime] [Sets how long the damage indicator stays on scre docargument [V] [damage indicator display time] [min 1/max 10000/default 1000]; docident [disablehud] [Stores your current HUD configuration in a buffer and disables it entirely.]; docident [enablehud] [Restores your HUD configuration after using disablehud.]; -docident [fullconsize] [Sets the number of text lines on the F11 history display.]; +docident [fullconsize] [Sets the percent of screen height for 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 [gametimedisplay] [Show the game-time clock on the HUD.]; +docargument [D] [off (0), count backward (1), count forward (2)] [min 0/max 2/default 1]; +docremark [The clock can count backward (from time limit to 0s) or forward (from 0s to time limit).]; 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.]; @@ -1442,10 +1775,7 @@ 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] [enable/disable team icons] [min 0/max 1/default 0]; docident [hidevote] [Turns on or off the display of vote icons.]; -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.)]; +docargument [V] [0=on; 1=on, but hide after own vote; 2=off] [min 0/max 2/default 0]; docident [hudextras] [Shows extra gameplay messages on certain events if connected to a server.]; docargument [] [] [0 (off)] [0]; docargument [] [] [1 (show extra messages in the console)] [0]; @@ -1454,11 +1784,6 @@ docargument [] [] [3 (SPAM extra messages in the console and on the HUD)] [0]; docargument [N] [enable/disable extra gameplay messages] [min 0/max 3/default 0]; docident [hudgun] [Turns on or off the display of the current selected gun.]; 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.]; -docargument [N] [Total of stored commands] [min 0/max 10000/default 1000]; -docremark [This value sets how many command lines to store in memory, everytime a command is entered it gets store so it can be recalled using the "/" key along with the arrow keys to scroll back and forth through the list.]; docident [maxrecoil] [.]; docargument [V] [] [min 0/max 1000/default 1000]; docident [minimapres] [Sets the resolution for the minimap.]; @@ -1501,7 +1826,7 @@ docident [sc_score] [Sets the order priority for the column score or disables it docargument [V] [-1: disable, low priority: left, high priority: right] [min -1/max 100/default 4]; docident [showmodedescriptions] [enables or disables the showing of game mode descriptions on the console after map starts.]; docargument [B] [0 off, 1 on] [min 0/max 1/default 1]; -docident [showspeed] [Enables or disables showing the player's horizontal speed.]; +docident [showspeed] [Enables or disables showing the player's horizontal speed (vector).]; docargument [N] [0 off, 1 on] [min 0/max 1/default 0]; docident [showstats] [Turns on/off display of FPS/rendering statistics on the HUD.]; docargument [N] [0: Show no stats, 1: Only show FPS stats, 2: Show all stats] [min 0/max 2/default 1]; @@ -1517,13 +1842,21 @@ docident [swayupmovediv] []; docargument [V] [] [min 1/max 1000/default 200]; docident [swayupspeeddiv] []; docargument [V] [] [min 1/max 1000/default 105]; +docident [votealpha] [Sets the transparency of the vote display.]; +docargument [N] [Alpha value] [min 0/max 255/default 255]; +docident [wallclockformat] [Show the wall clock with time (usually local, not game-time) on the HUD.]; +docremark ["wallclockformat" alias should contain string in strftime format to show the clock with proper time. If the alias is empty, the wall clock is hidden.]; 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] [Icon size] [min 0/max 1000/default 50]; +docident [allowblinkingtext] [for toggling on the ability for any text to have the blinking bit set.]; +docargument [T] [0 = Off, 1 = On] [min 0/max 1/default 0]; 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 [aniso] [Sets the level of anisotropic filtering.]; +docargument [V] [anisotropic filtering] [min 0/max 16/default 0]; docident [ati_mda_bug] []; docargument [V] [] [min 0/max 1/default 0]; docident [bilinear] []; @@ -1539,6 +1872,7 @@ docargument [V] [Bullethole display time] [min 0/max 30000/default 10000]; docident [changegamma] [Smoothly changes your gamma to the specified value.]; docargument [G] [the gamma to change to] [] [0]; docargument [M] [milliseconds between gamma changes] [] [0]; +docremark [Remark: that's optional command, disabled by default, to enable it execute "run opt/survival" or start bot surival mode from menu.]; docexample [changegamma 300 30] [Every 30 milliseconds your gamma is changed by 1 until it reaches its goal of gamma 300.]; docident [colorbits] [Sets the bits per pixel value.]; docargument [] [bits per pixel] [min 0/max 32/default 0]; @@ -1550,26 +1884,14 @@ docident [damagescreenfactor] [if overlay of blood-spat, use which factor?]; docargument [N] [damagescreen factor] [min 1/max 100/default 7]; docident [damagescreenfade] [if overlay of blood-spat, at what speed does it fade?]; docargument [N] [damagescreen fade] [min 0/max 1000/default 125]; -docident [dbgmbatch] []; -docargument [V] [] [min 0/max 1/default 0]; docident [dbgpos] [Displays local player's current x,y,z position in map, showstats 1 must be enabled.]; docargument [V] [display current position] [min 0/max 1/default 0]; -docident [dbgstenc] []; -docargument [V] [] [min 0/max 2/default 0]; -docident [dbgtiles] []; -docargument [V] [] [min 0/max 1/default 0]; -docident [dbgvlight] []; -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 [depthoffset] []; docargument [V] [] [min /max /default 0.005f]; -docident [dyngamma] [Enables or disables the per official map dynamic gamma system.]; -docexample [dyngamma = 0] [Output: disables the system]; -docexample [dyngamma = 1] [Output: enables the system]; docident [dynlight] [Determines whether dynamic shadows and lights are rendered, provided just 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).]; +docargument [R] [0 off, 1 on] [min 0/max 1/default 1]; docident [dynshadow] [Sets the alpha value (transparency) for dynamic shadows.]; docargument [] [the alpha value] [min 0/max 100/default 40]; docident [dynshadowdecay] []; @@ -1579,19 +1901,21 @@ docargument [V] [] [min 0/max 1/default 0]; docident [dynshadowsize] [Sets the display size of the dynamic shadows.]; docargument [] [the size] [min 4/max 8/default 5]; docident [font] [Loads a font texture to use as text within AssaultCube.]; -docargument [NAME] [The font name.] [] [0]; -docargument [PATH] [The path to the font texture.] [] [0]; -docargument [A] [The default width.] [] [0]; -docargument [B] [The default height.] [] [0]; -docargument [C] [Offset (co-ordinate X).] [] [0]; -docargument [D] [Offset (co-ordinate Y).] [] [0]; -docargument [E] [Offset (width).] [] [0]; -docargument [F] [Offset (height).] [] [0]; -docident [fontchar] [Specify a region of an image to be used as a font character]; -docargument [A] [X co-ordinates (from top-left corner).] [] [0]; -docargument [B] [Y co-ordinates (from top-left corner).] [] [0]; -docargument [C] [Width.] [] [0]; -docargument [D] [Height.] [] [0]; +docargument [NAME] [the font name] [] [0]; +docargument [PATH] [the path to the font texture] [] [0]; +docargument [A] [the default width] [] [0]; +docargument [B] [the default height] [] [0]; +docargument [C] [offset (co-ordinate X)] [] [0]; +docargument [D] [offset (co-ordinate Y)] [] [0]; +docargument [E] [offset (width)] [] [0]; +docargument [F] [offset (height)] [] [0]; +docident [fontchar] [Specifies a region of an image to be used as a font character.]; +docargument [A] [X co-ordinates (from top-left corner)] [] [0]; +docargument [B] [Y co-ordinates (from top-left corner)] [] [0]; +docargument [C] [width] [] [0]; +docargument [D] [height] [] [0]; +docident [fontskip] [Specifies, at what char the font definition proceeds.]; +docargument [A] [the ascii code of the first char] [] [0]; docident [fov] [Sets the field of view (fov).]; docargument [N] [the FOV value] [min 75/max 120/default 90]; docident [fovcompat] [Sets the field of view (fov) based on the rules of AC v0.93]; @@ -1600,25 +1924,27 @@ docremark [This command is supplied for backward compatibility.]; docident [fpsrange] [(descripton unavailable)]; docargument [A] [min] [] [0]; docargument [B] [max] [] [0]; -docident [fragmessage] [set the frag message corresponding to a weapon (appearing on the hud or in server logs)]; -docargument [G] [the integer of the gun] [ 0 = knife, etc.] [0]; -docargument [M] [the message you want to appear] [ex : sniped] [0]; -docremark [This command can be read by both client and server, but the server can't read the cfg if it contains anything else than fragmessage or gibmessage calls.]; -docexample [fragmessage 5 sniped // set "sniped" message for frags with sniper.] [It will display "you sniped unarmed" on the hud when you frag unarmed with sniper. In server logs you will get "[127.0.0.1] killer sniped unarmed".]; -docident [fsaa] [Sets the level of fullscreen antialiasing (FSAA).]; -docargument [] [fsaa] [min 0/max 16/default 0]; +docident [fragmessage] [set the frag message corresponding to a weapon (appearing on the hud).]; +docargument [N] [the weapon number or name] [0 (knife), 1 (pistol), 2 (carbine), 3 (shotgun), 4 (subgun), 5 (sniper), 6 (assault), 7 (grenades), 8 (akimbo)] [0]; +docargument [M] [the message you want to appear] [example: sniped] [0]; +docexample [fragmessage sniper sniped] [It will display "you sniped unarmed" on the hud when you frag unarmed with sniper.]; +docident [fsaa] [Sets the level of full-scene antialiasing (FSAA).]; +docargument [V] [full-scene antialiasing] [min -1/max 16/default 0]; +docremark [-1 uses the default settings obtained from the system. 0 disables, 1..16 enables FSAA.]; docident [fullbrightlevel] [Sets the level of brightness to use when using the command "/fullbright 1".]; 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.]; -docident [gamma] [Sets the hardware gamma value.]; +docident [fullscreentoggle] [Toggles fullscreen on or off.]; +docident [gamma] [Sets the temporary (to next map start) 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 [gib] [Enables or disables the gib animation entirely.]; docargument [B] [off OR on] [0 (false), 1 (true) min 0/max 1/default 1]; -docident [gibmessage] [set the gib message corresponding to a weapon (appearing on the hud or in server logs)]; -docremark [This command is identical to fragmessage (above)]; +docident [gibmessage] [set the gib message corresponding to a weapon (appearing on the hud).]; +docargument [N] [the weapon number or name] [0 (knife), 1 (pistol), 2 (carbine), 3 (shotgun), 4 (subgun), 5 (sniper), 6 (assault), 7 (grenades), 8 (akimbo)] [0]; +docargument [M] [the message you want to appear] [example: slashed] [0]; +docremark [This command is identical to fragmessage, please see 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.]; @@ -1632,7 +1958,7 @@ docargument [N] [] [min 0/max 4/default 1]; 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]; +docargument [N] [time to live] [min 0/max 60000/default 7000]; docident [glext] [checks for the searchstring in all loaded extensions]; docargument [E] [extension] [] [0]; docexample [if (glext shadow_funcs) [echo you have shadow functionality] [echo no shadows for you]] []; @@ -1640,15 +1966,21 @@ docident [heartbeat] [Defines the health level at or below which a heartbeat sou docargument [H] [health value] [min 0/max 99/default 0]; docident [hirestextures] [Controls whether textures with a scale higher than 1.0 will be scaled down while loading to increase performance (0) or stay at higher resolution (1).]; docargument [S] [scale down?] [min 0/max 1/default 1]; -docident [hwtexsize] [The maximum texture size (in pixels) supported by the graphics hardware.]; -docargument [V] [max. hardware texture size] [min 1/max 0/default 0]; +docident [hwmaxaniso] [Shows the maximum level of anisotropic filtering supported by the graphics hardware.]; +docident [hwtexsize] [Shows the maximum texture size (in pixels) supported by the graphics hardware.]; 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 [maploaditemlength] [change at what position to truncate the map title string]; docargument [N] [chars] [min 0/max 255/default 46]; +docident [maxroll] [Sets the maximum value the display will roll on strafing.]; +docargument [N] [the roll value] [min 0/max 20/default 0]; +docident [maxrollremote] [Limits the maximum value the display will roll on strafing when spectating other players.]; +docargument [N] [The roll value] [min 0/max 20/default 0]; +docremark [This only comes into effect if the remote client being spectated has a maxroll greater than 0.]; docident [maxtexsize] [The maximum texture (if less than hwtexsize) that will actually be used by the engine, larger textures will be scaled down. 0 removes this limit.]; -docargument [V] [max. texture size] [min 0/max 4096/default 0]; +docargument [V] [maximum texture size] [min 0/max 4096/default 0]; +docident [maxtmus] [Gets the maximum number of supported textures when performing multitexturing.]; docident [mergestrips] []; docargument [V] [] [min 0/max 1/default 1]; docident [mtexplosion] []; @@ -1664,7 +1996,7 @@ docargument [V] [] [min /max /default -3.0f]; docident [popdeadplayers] [make dead players instantly pop out of existence, instead of falling over and sinking into the ground.]; docargument [B] [BOOL] [min 0/max 1/default 0]; docident [reflectclip] []; -docargument [V] [] [min 0/max 100/default 3]; +docargument [V] [] [min 0/max 100/default 1]; docident [reflectscissor] []; docargument [V] [] [min 0/max 1/default 1]; docident [reflectsize] []; @@ -1679,19 +2011,16 @@ docargument [V] [] [min 0/max 30000/default 10000]; docident [scorefont] [Whether a special monospace font should be used to render the text on the scoreboard.]; docargument [M] [normal (0) or monospace (1)] [min 0/max 1/default 0]; docident [scr_h] [Sets the screen height.]; -docargument [] [the screen height] [min 0/max 768/default 10000]; +docargument [H] [the screen height] [min 200/max 10000/default 768]; docident [scr_w] [Sets the screen width.]; -docargument [] [the screen width] [min 0/max 1024/default 10000]; +docargument [W] [the screen width] [min 320/max 10000/default 1024]; docident [screenres] [Changes the screen resolution]; docargument [W] [width] [] [0]; docargument [H] [height] [] [0]; docident [setfont] [Changes the current font.]; -docargument [N] [Font name] [name of the font] [0]; -docident [setgamma] [Sets the current map's default dynamic gamma.]; -docargument [G] [the gamma value] [] [0]; -docremark [The setting will take affect automatically if dyngamma is enabled, upon future loads of that map. This command only works on official maps!]; -docremark [Rather than manually loading each official map and setting it's default gamma with this command, the entire list can be initialized via your autoexec.cfg like so:]; -docexample [checkinit afterinit [ofc_gamma_list = [175 225 150 120 ...]]] [Sets your custom gamma values for the per official map dynamic gamma system. If you are going to use this method, you MUST include values for every existing official map. The list must be alphabetical and be the exact length of the number of currrent official maps. Hint: use "echo $defaultmaps" and "echo (listlen $defaultmaps)".]; +docargument [N] [font name] [default, mono, serif] [0]; +docident [setgamma] [Sets a persistent gamma value for a map.]; +docargument [G] [the gamma value] [30..300, default 100] [0]; docident [shadowcasters] []; docargument [V] [] [min 1/max 0/default 0]; docident [shadowclip] []; @@ -1718,7 +2047,7 @@ docargument [S] [scale selection] [min -1/max 3/default 0]; docident [trilinear] []; docargument [V] [] [min 0/max 1/default 1]; docident [vsync] [Enables or disables vsync.]; -docargument [] [vsync] [min -1/max 1/default -1]; +docargument [V] [vsync] [min -1/max 1/default -1]; docremark [-1 uses the default settings obtained from the system. 0 disables, 1 enables vsync.]; docident [waterreflect] [Turns on/off the reflections in the water surface.]; docargument [V] [enable/disable water reflections] [min 0/max 1/default 1]; @@ -1727,6 +2056,8 @@ 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.]; +docident [waveheight] [Sets the wave height of water, between 0 (completely still, no waves at all) and 1 (very choppy).]; +docargument [F] [wave height (floating-point value)] [min 0/max 1/default 0.3]; docsection [Sound] docident [al_referencedistance] [The distance from the source emitting the sound to the listener.]; docargument [V] [] [min 0/max 1000000/default 400]; @@ -1752,10 +2083,10 @@ docident [gainscale] [Each subsequent played sound's gain-value is scaled by thi docargument [N] [percentage] [min 0/max 100/default 100]; docremark [This lowers the gain of the sounds before they are mixed, this might be useful in cases when the mixer has problems with too high gain values.]; docident [mapsoundrefresh] [Specifies the interval for checking mapsounds.]; -docargument [N] [interval in milliseconds] [min 0/max 1000/default 50]; +docargument [N] [interval in milliseconds] [min 0/max 1000/default 10]; docremark [If set to value 0, the map sounds will be checked in every frame without any interval limitation.]; docident [maxsoundsatonce] []; -docargument [V] [] [min 0/max 100/default 40]; +docargument [V] [] [min 0/max 100/default 32]; docident [music] [Play music in the background.]; docargument [A] [music file name] [] [0]; docargument [B] [playtime] [] [0]; @@ -1765,11 +2096,20 @@ docargument [N] [the volume] [min 0/max 255/default 128]; docident [mutesound] [Mute a specific game sound.]; docargument [N] [ID of the sound to mute] [see config/sounds.cfg, starting at ID 0] [0]; docargument [A] [audible?] [(mute) 0 || 1 (unmute)] [0]; +docident [registermusic] [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.]; +docargument [M] [music file] [] [0]; +docident [registersound] [Registers a sound.]; +docargument [N] [sound name] [string, see config/sounds.cfg] [0]; +docargument [V] [volume] [0..255] [0]; +docargument [L] [loop] [0 (off), 1 (on)] [0]; +docargument [R] [audible radius] [] [0]; +docremark [This command returns the sound number, which is assigned from 0 onwards, and which can be used with "sound" command. If the sound was already registered, its existing index is returned. registersound does not actually load the sound, this is done on first play.]; +docremark [See for example config/sounds.cfg.]; 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.]; +docremark [See config/sounds.cfg for default sounds, and use registersound to register your own. For example, 'sound 0' and 'sound (registersound "player/jump")' both play the standard jump sound.]; docident [soundchannels] [Sets the desired amount of allocated sound channels.]; -docargument [] [number of channels] [min 4/max 1024/default 32]; +docargument [] [number of channels] [min 4/max 1024/default 128]; docremark [AC will try to allocate that number of channels but it is not guaranteed to succeed.]; docident [soundmuted] [Returns 1 if sound A is muted, else 0.]; docargument [A] [sound ID] [See /config/sounds.cfg for valid sound ID's.] [0]; @@ -1782,6 +2122,7 @@ docident [soundschedpriorityscore] []; docargument [V] [] [min 0/max 1000/default 100]; docident [soundschedreserve] []; docargument [V] [] [min 0/max 100/default 2]; +docident [soundtest] [Plays all hardcoded sounds in order.]; docident [soundvol] [Sets the sound volume for all sounds.]; docargument [N] [the volume] [min 0/max 255/default 128]; docident [unmuteallsounds] [Unmutes all previously muted sounds.]; @@ -1832,20 +2173,25 @@ 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 "docs/autogenerated_base_reference.xml" by default. The three arguments can be changed later on in the generated XML document.]; +docident [docwritetodoref] [Writes out an XML documentation reference file containing undocumented identifiers or identifiers marked with "TODO"]; +docargument [i] [Also include aliases? Optional] [1: Include aliases, 0: Don't include. Default: 0] [0]; docsection [Server commands] docident [addfavcategory] [Adds a new category in the serverbrowser favourites.]; docargument [A] [reference designator (keep short and unique)] [] [0]; docremark [Add new categories to your autoexec.cfg, check favourites.cfg for examples.]; docident [autoteam] [Sets automated team assignment.]; -docargument [B] [Enables or disables auto team.] [1 (On), 0 (Off)] [0]; +docargument [B] [Enables or disables auto team] [1 (On), 0 (Off)] [0]; docident [ban] [Temporary ban of the specified player from the server.]; -docargument [CN] [The player to ban] [Client number] [0]; +docargument [C] [The player to ban] [client number] [0]; +docargument [R] [The reason] [at least 4 characters] [0]; docremark [Temporary ban duration is fixed at 20 minutes.]; docident [callvote] [Calls a vote on the server.]; docargument [T] [Vote type] [value] [0]; docargument [A] [First argument] [] [0]; docargument [B] [Second argument] [] [0]; docremark [This command is wrapped by aliases for better usability and is used to action votes such as ban, kick, etc. See config/admin.cfg for actual uses.]; +docident [cleardemo] [Clears specific demo currently in memory on the server.]; +docargument [X] [number in list] [0 (all), 1..] [0]; docident [cleardemos] [Clears all demos currently in memory on the server.]; docident [deleteservermap] [Deletes a map from the current server.]; docargument [A] [map name] [] [0]; @@ -1855,19 +2201,14 @@ docremark [By default, if you are on team CLA or RVSF, this command will force y docident [forceteam] [Calls a vote to force the specified player to switch to the specified team.]; docargument [C] [client number of player] [integer] [0]; docargument [T] [the team to force to] [0-4] [0]; -docremark [Teams are:]; -docremark [0 - CLA]; -docremark [1 - RVSF]; -docremark [2 - Spec-CLA]; -docremark [3 - Spec-RVSF]; -docremark [4 - Spec]; docident [giveadmin] [Gives admin state to the specified player.]; -docargument [CN] [The player to become admin] [Client number] [0]; +docargument [C] [The player to become admin] [client number] [0]; docremark [Requires admin state. The admin will lose his admin state after successfully issuing this command.]; docident [hidefavicons] [Hide favourites icons in serverbrowser.]; docargument [N] [0: show, 1: hide] [min 0/max 1/default 0]; docident [kick] [Kicks the specified player from the server.]; -docargument [CN] [The player to kick] [Client number] [0]; +docargument [C] [The player to kick] [client number] [0]; +docargument [R] [The reason] [at least 4 characters] [0]; docident [listfavcats] [List all registered serverbrowser favourites categories]; docident [mastermode] [Sets the mastermode for the server.]; docargument [N] [The master mode] [0 (Open), 1 (Private), 2 (Match)] [0]; @@ -1921,6 +2262,34 @@ docargument [N] [] [min 0/max 1/default 0]; docremark ['weights' are the sort criteria with the highest priority. Favourites categories can change the weights. Use 'showweights' to debug problems with serverbrowser sorting.]; docident [shuffleteams] [Shuffles the teams. The server will attempt to restore balance, but the result may be less that optimal, and there are certainly better ways to keep teams balanced.]; docsection [Game modes] +docident [bdm] [Starts a map with the mode "Bot Deathmatch"]; +docargument [M] [The name of the map you wish to play] [] [1]; +docargument [T] [The time limit, in minutes (default 10 minutes if T is 0 or not specified)] [1..60] [1]; +docexample [bdm ac_complex] []; +docident [blss] [Starts a map with the mode "Bot Last Swiss Standing"]; +docargument [M] [The name of the map you wish to play] [] [1]; +docargument [T] [The time limit, in minutes (default 10 minutes if T is 0 or not specified)] [1..60] [1]; +docexample [blss ac_complex] []; +docident [bosok] [Starts a map with the mode "Bot One shot, One kill"]; +docargument [M] [The name of the map you wish to play] [] [1]; +docargument [T] [The time limit, in minutes (default 10 minutes if T is 0 or not specified)] [1..60] [1]; +docexample [bosok ac_complex] []; +docident [bpf] [Starts a map with the mode "Bot Pistol Frenzy"]; +docargument [M] [The name of the map you wish to play] [] [1]; +docargument [T] [The time limit, in minutes (default 10 minutes if T is 0 or not specified)] [1..60] [1]; +docexample [bpf ac_complex] []; +docident [btdm] [Starts a map with the mode "Bot Team Deathmatch"]; +docargument [M] [The name of the map you wish to play] [] [1]; +docargument [T] [The time limit, in minutes (default 15 minutes if T is 0 or not specified)] [1..60] [1]; +docexample [btdm ac_complex] []; +docident [btosok] [Starts a map with the mode "Bot Team One shot, One kill"]; +docargument [M] [The name of the map you wish to play] [] [1]; +docargument [T] [The time limit, in minutes (default 15 minutes if T is 0 or not specified)] [1..60] [1]; +docexample [btosok ac_complex] []; +docident [btsurv] [Starts a map with the mode "Bot Team Survivor"]; +docargument [M] [The name of the map you wish to play] [] [1]; +docargument [T] [The time limit, in minutes (default 15 minutes if T is 0 or not specified)] [1..60] [1]; +docexample [btsurv ac_complex] []; docident [coop] [Starts a map with the mode "Co-op edit"]; docargument [M] [The name of the map you wish to edit] [] [1]; docremark [See the co-op edit section in page 4 of the map editing guide for more information.]; @@ -1944,7 +2313,7 @@ docident [ktf] [Starts a map with the mode "Keep the Flag"]; docargument [M] [The name of the map you wish to play] [] [1]; docargument [T] [The time limit, in minutes (default 10 minutes if T is 0 or not specified)] [1..60] [1]; docexample [ktf ac_mines] []; -docident [lms] [Starts a map with the mode "Last Man Standing"]; +docident [lms] [Starts a map with the mode "Survivor". Some players prefer the name "Last Man Standing" for this mode.]; docargument [M] [The name of the map you wish to play] [] [1]; docargument [T] [The time limit, in minutes (default 10 minutes if T is 0 or not specified)] [1..60] [1]; docexample [lms ac_complex] []; @@ -1969,6 +2338,12 @@ docargument [] [Bot One shot, One kill] [12] [0]; docargument [] [Hunt the Flag] [13] [0]; docargument [] [Team keep the flag] [14] [0]; docargument [] [Keep the flag] [15] [0]; +docargument [] [Team Pistol Frenzy] [16] [0]; +docargument [] [Team Last Swiss Standing] [17] [0]; +docargument [] [Bot Pistol Frenzy] [18] [0]; +docargument [] [Bot Last Swiss Standing] [19] [0]; +docargument [] [Bot Team Survivor] [20] [0]; +docargument [] [Bot Team One shot, One kill] [21] [0]; docremark [You will need to define mode before loading the map or it will stay as the last mode played.]; docremark [There are many aliases for you to use instead of remembering the numeric mapping.]; docexample [mode 7; map ac_complex; echo "Bot Team Deathmatch on ac_complex"] []; @@ -1982,6 +2357,15 @@ docident [pf] [Starts a map with the mode "Pistol Frenzy"]; docargument [M] [The name of the map you wish to play] [] [1]; docargument [T] [The time limit, in minutes (default 10 minutes if T is 0 or not specified)] [1..60] [1]; docexample [pf ac_complex] []; +docident [surv] [Starts a map with the mode "Survivor"]; +docargument [M] [The name of the map you wish to play] [] [1]; +docargument [T] [The time limit, in minutes (default 10 minutes if T is 0 or not specified)] [1..60] [1]; +docexample [surv ac_complex] []; +docident [survival] [Prepares a round of bot survival mode on the specified map.]; +docargument [M] [the map to use] [] [0]; +docargument [D] [the difficulty] [0 = easy, 1 = intermediate, 2 = hard, 3 = impossible] [0]; +docremark [All official maps are compatible with survival, if you want to play survival on a custom map, prior edits/additions to the script are necessary, such as adding a zone for that specific map.]; +docremark [Remark: that's optional command, disabled by default, to enable it execute "run opt/survival" or start bot surival mode from menu.]; docident [tdm] [Starts a map with the mode "Team Deathmatch"]; docargument [M] [The name of the map you wish to play] [] [1]; docargument [T] [The time limit, in minutes (default 15 minutes if T is 0 or not specified)] [1..60] [1]; @@ -1990,14 +2374,22 @@ docident [tktf] [Starts a map with the mode "Team Keep the Flag"]; docargument [M] [The name of the map you wish to play] [] [1]; docargument [T] [The time limit, in minutes (default 15 minutes if T is 0 or not specified)] [1..60] [1]; docexample [tktf ac_mines] []; -docident [tosok] [Starts a map with the mode "Team One Shot, One Kill"]; +docident [tlss] [Starts a map with the mode "Team Last Swiss Standing"]; +docargument [M] [The name of the map you wish to play] [] [1]; +docargument [T] [The time limit, in minutes (default 15 minutes if T is 0 or not specified)] [1..60] [1]; +docexample [tlss ac_complex] []; +docident [tosok] [Starts a map with the mode "Team One shot, One kill"]; docargument [M] [The name of the map you wish to play] [] [1]; docargument [T] [The time limit, in minutes (default 15 minutes if T is 0 or not specified)] [1..60] [1]; docexample [tosok ac_complex] []; -docident [ts] [Starts a map with the mode "Team Survivor"]; +docident [tpf] [Starts a map with the mode "Team Pistol Frenzy"]; docargument [M] [The name of the map you wish to play] [] [1]; docargument [T] [The time limit, in minutes (default 15 minutes if T is 0 or not specified)] [1..60] [1]; -docexample [ts ac_complex] []; +docexample [tpf ac_complex] []; +docident [tsurv] [Starts a map with the mode "Team Survivor"]; +docargument [M] [The name of the map you wish to play] [] [1]; +docargument [T] [The time limit, in minutes (default 15 minutes if T is 0 or not specified)] [1..60] [1]; +docexample [tsurv ac_complex] []; docident [vip] [Starts a map with the mode "Hunt the Flag". Some players prefer the name "VIP" for this mode.]; docargument [M] [The name of the map you wish to play] [] [1]; docargument [T] [The time limit, in minutes (default 15 minutes if T is 0 or not specified)] [1..60] [1]; @@ -2008,18 +2400,20 @@ docargument [N] [The fog distance] [64...1024, default is 180] [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. It is also good for aesthetic features of maps especially when combined with "fogcolour".]; docident [fogcolour] [Sets the fog and clearing colour.]; docargument [C] [The colour] [Hexadecimal colour, default is 0x8099B3] [0]; -docident [isolatecontext] [Isolates the given context. This disables access from this context to identifiers located in other contexts, also it removes all aliases created in this context once the running context changes]; -docargument [C] [the context] [] [0]; +docident [getnotexture] [Returns the current "notexture" path (set by loadnotexture).]; +docexample [echo (getnotexture)] []; docident [loadnotexture] [Binds a texture to be used if a slot couldn't be loaded with a given textures path.]; docargument [F] [file name of the texture to bind] [string] [0]; docremark [Binds the texture indicated in the filename to the texture slot of any textures that aren't found. The path is given exactly as with the texture-command, if it is omitted (or can't be loaded) the default is used. The default is located in packages/misc/notexture.jpg (not in packages/textures - where custom ones must reside!)]; docexample [loadnotexture // Reset to default] []; docexample [loadnotexture "makke/black.jpg" // Any missing texture will show up black] []; docident [loadsky] [Loads a skymap for a map.]; -docargument [P] [path to the six skymap textures] [string] [0]; +docargument [P] [path to skymap textures] [string] [0]; docremark [The available skymaps reside in packages/textures/skymaps/..]; -docremark [To select a skymap you need to use the full path from "packages/" but only up to the underscore "_" in the filename.]; -docexample [loadsky "textures/skymaps/makke/mountain"] []; +docremark [The skymap name in the argument is required to start with "textures/skymaps/", but that part of the path can be omitted, and it should be used only up to the underscore "_" in the filename.]; +docremark [You can get the current skymap name with the $loadsky variable.]; +docexample [loadsky makke/mountain] []; +docexample [loadsky textures/skymaps/makke/mountain] []; docident [mapmodel] [Registers a mapmodel that can be placed in maps.]; docargument [R] [The square radius of the bounding box.] [Integer] [0]; docargument [H] [The height of the bounding box.] [Integer] [0]; @@ -2029,12 +2423,14 @@ docargument [N] [The name of the map model] [string] [0]; docremark [A mapmodel registered with this command can be placed in a map using the 'newent mapmodel' command. The bounding box is an invisible force surrounding the model, allowing players to collide against it, instead of walking through the mapmodel. For more information about this command, read mapediting5.xml.]; docremark [Example: mapmodel 4 2 4 0 "modelname"]; docremark [This mapmodel has a bounding box of 8x8x2 in size (X/Y/Z) and by default hovers 4 units above ground.]; +docremark [It also returns the number of the created slot, example: echo (mapmodel ...)]; docident [mapmodelreset] [Resets the mapmodel slots/indices to 0 for the subsequent "mapmodel" commands.]; docremark [Each subsequent mapmodel command increases it again. See config/default_map_settings.cfg for an example.]; docident [mapsound] [Defines a mapsound.]; -docargument [N] [Path to the sound file] [] [0]; -docargument [M] [Maximum simultaneous sounds] [default -1 (unlimited)] [0]; +docargument [P] [Path to the sound file] [] [0]; +docargument [M] [Maximum simultaneous sounds/maxuses] [default -1 (unlimited)] [0]; docremark [Registers the sound as a map-specific sound. These map-specific sounds may currently only be used with "sound" entities within a map. The first map sound registered in a map has slot/index number 0 and increases afterwards.]; +docremark [It also returns the number of the created slot, example: echo (mapsound ...)]; docident [mapsoundreset] [Resets the mapsound slots/indices to 0 for the subsequent "mapsound" commands.]; docremark [Each subsequent mapsound command increases it again. See config/default_map_settings.cfg for an example.]; docident [md2anim] []; @@ -2072,8 +2468,13 @@ docargument [M] [model] [] [0]; docident [md3skin] []; docargument [N] [object name] [] [0]; docargument [S] [skin texture] [] [0]; +docident [mdlalphablend] []; +docargument [A] [alphablend] [] [0]; docident [mdlalphatest] []; docargument [A] [alphatest] [] [0]; +docident [mdlattribute] [Adds a value for a specified attribute to the model.]; +docargument [A] [attribute] [keywords, desc, defaults, usage, author, license, distribution, version] [0]; +docargument [V] [value] [] [0]; docident [mdlcachelimit] []; docargument [L] [cachelimit] [] [0]; docident [mdlcullface] []; @@ -2090,10 +2491,6 @@ docident [mdltranslucent] []; docargument [T] [translucency] [0..100..N*100] [0]; docident [mdlvertexlight] []; docargument [V] [vertexligh] [0||1] [0]; -docident [scriptcontext] []; -docargument [C] [context] [] [0]; -docargument [N] [idname] [] [0]; -docident [sealcontexts] [secure this configuration for the rest of the game]; docident [shadowyaw] [Shadow yaw specifies the angle at which shadow stencils are drawn on a map.]; docargument [D] [The angle in degrees to rotate the stencil shadows] [0...360, default is 45] [0]; 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).]; @@ -2103,6 +2500,7 @@ docargument [S] [Scale of the texture to load (should be a power of two).] [Floa 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.]; docremark [The texture is rendered at the given scale. At scale 1.0 (or if scale is 0), 32x32 texels cover one cube. At scale 2.0, which is the current maximum, it's 64x64.]; +docremark [It also returns the number of the created slot, example: echo (texture ...)]; docident [texturereset] [Sets the texture slots/indicies to 0 for the subsequent "texture" commands.]; docremark [Each subsequent texture command increases it again. See config/default_map_settings.cfg for an example.]; docident [watercolour] [Determines the water colour in a map.]; @@ -2110,20 +2508,71 @@ docargument [R] [Red colour intensity] [Between 1 and 255] [0]; docargument [G] [Green colour intensity] [Between 1 and 255] [0]; docargument [B] [Blue colour intensity] [Between 1 and 255] [0]; docremark [You must define all 3 values, otherwise this command may not work correctly (use "1" as a placeholder if needed).]; -docident [waveheight] [Sets the wave height of water, between 0 (completely still, no waves at all) and 1 (very choppy).]; -docargument [F] [wave height (floating-point value)] [min 0/max 1/default 0.3]; +docsection [Bot mode] +docident [addbot] [add a bot for a given team with a given skill calling him a given name.]; +docargument [T] [team] [RVSF or CLA] [0]; +docargument [S] [skill] [best, good, medium, worse OR bad] [0]; +docargument [N] [name] [name for the bot] [0]; +docremark [This command only works for single player modes.]; +docexample [addbot RVSF medium Robbie] [Will add a bot named Robbie with a medium skill level to the RVSF team.]; +docident [addnbot] [will add a given count of bots for the given team with the given skill and select random names for them.]; +docargument [C] [count] [how many bots to add] [0]; +docargument [T] [team] [RVSF or CLA] [0]; +docargument [S] [skill] [best, good, medium, worse OR bad] [0]; +docremark [This command only works for single player modes.]; +docremark [The name of the bots will be selected randomly.]; +docexample [addnbot 2 CLA bad] [Will add 2 bots with a bad skill level to the CLA team.]; +docident [addpath1way1] []; +docident [addpath1way2] []; +docident [addpath2way1] []; +docident [addpath2way2] []; +docident [addwp] [Adds a bot waypoint at the current position.]; +docargument [A] [connect automatically] [0 or 1] [0]; +docident [autowp] [Automatically place waypoints.]; +docident [botskill] [changes the skill level for the given bot.]; +docargument [N] [botname] [the name of the bot] [0]; +docargument [S] [botskill] [best, good, medium, worse OR bad] [0]; +docexample [botskill Robbie best] [Changes the previous bot skill level of the bot named Robbie to a 'best' skill level.]; +docident [botskillall] [changes the skill level for all bots.]; +docargument [S] [botskill] [best, good, medium, worse OR bad] [0]; +docexample [botskillall worse] [Changes the previous bot skill level for all bots to a 'worse' skill level.]; +docident [botsshoot] [Enables or disables the ability of the bots to fire their weapons]; +docargument [T] [shooting bots?] [0||1] [0]; +docexample [botsshoot 0] [Bots won't shoot.]; +docident [delpath1way1] []; +docident [delpath1way2] []; +docident [delpath2way1] []; +docident [delpath2way2] []; +docident [delwp] [Deletes the selected waypoint.]; +docident [idlebots] [Enables or disables the processing of the bots artificial intelligence]; +docargument [T] [off OR on] [0||1] [0]; +docexample [idlebots 1] [Will make the bots stand still.]; +docexample [idlebots 0] [Will enable the bots to move and shoot.]; +docident [kickallbots] [Kicks all bots out of the current game.]; +docargument [] [this command does not take any arguments] [none] [0]; +docident [kickbot] [Kicks the bot with the given name out of the current game.]; +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 [setjumpwp] []; +docident [setwptriggernr] [Assigns a number to the nearest waypoint. This is only used for trigger waypoints, so that the bots go to triggers in the right order. If you don't do this bots will search for every trigger, even when they are not reachable yet.]; +docargument [N] [number] [] [0]; +docident [setwpyaw] [takes the current player yaw for the current waypoint]; +docident [togglebotview] [When used you will see what the bot sees. Type it again (with or without name) to return to the game(you will respawn).]; +docargument [N] [botname] [the name of the bot] [0]; +docident [unsetjumpwp] []; +docident [wpclear] []; +docident [wpflood] []; +docident [wpinfo] [makes waypoints visible and either turns on or off the waypoint information display.]; +docargument [Y] [show info?] [0||1] [0]; +docident [wpload] []; +docident [wpsave] []; +docident [wpvisible] []; +docargument [V] [visible] [0||1] [0]; +docident [xhairwpsel] [Determines if bot waypoints should be selected/placed using the crosshair or by the nearest location to your player.]; +docargument [V] [Note: This is turned on by default.] [min 0/max 1/default 1]; docsection [TODO] -docident [addzip] [TODO: Description]; -docargument [A] [TODO] [] [0]; -docargument [B] [TODO] [] [0]; -docargument [C] [TODO] [] [0]; -docident [allowblinkingtext] [for toggling on the ability for any text to have the blinking bit set.]; -docargument [T] [TOGGLE] [] [0]; -docident [applydialog] [do you really want to quit?]; -docargument [N] [TODO] [min 0/max 1/default 1]; docident [autoscopesens] [TODO]; docargument [N] [TODO] [min 0/max 1/default 0]; -docident [delalias] [deletes the passed alias.]; docident [demonameformat] [set the formatstring for demo filenames - default: TODO (when stable)]; docargument [S] [STRING] [] [0]; docremark [we use the following internal mapping of formatchars:]; @@ -2136,43 +2585,12 @@ docremark [%w : timestamp "when"]; docident [demotimeformat] [set the formatstring for demo timestamp - default: TODO (when stable)]; docargument [S] [STRING] [] [0]; docremark [same as strftime() - see http://www.cplusplus.com/reference/clibrary/ctime/strftime/ for details]; -docident [demotimelocal] [use localtime (1) or GMT (0)?]; -docargument [B] [BOOL] [min 0/max 1/default 0]; -docident [fontskip] [At what char does the definition proceed?]; -docargument [A] [TODO] [] [0]; -docident [getdemonameformat] [returns the currently used formatstring for demo filenames]; -docident [getdemotimeformat] [returns the currently used formatstring for demo timestamp]; -docident [gettext] [An alias used for i18n. Translateable text should be marked [(_ "this is the EN-us variant of the text")].]; -docargument [M] [I18Nmessage] [] [0]; -docident [interms] [TODO]; -docargument [N] [TODO] [min 0/max 1/default 0]; -docident [mapdimsfactor] [TODO]; -docargument [N] [TODO] [min 0/max 4/default 2]; -docident [maxrollremote] [TODO]; -docargument [N] [TODO] [min 0/max 20/default 0]; docident [mdldlist] [TODO]; docargument [N] [TODO] [min 0/max 1/default 1]; -docident [menucanblink] [for toggling on the ability for menutext to have the blinking bit set. The global setting of 'allowblinkingtext' overrides this]; -docargument [T] [0 || !=0] [] [0]; -docident [menufont] [switch the font in which the menu is displayed]; -docargument [F] [FONT] [] [0]; -docident [menuitemmapload] [a menuitem that loads a map, displays the title and the preview or a default image]; -docargument [M] [MAP] [] [0]; -docargument [T] [TEXT] [] [0]; -docident [mfilter] [TODO]; -docargument [N] [TODO] [min 0,0/max 6,0/default 0,0]; -docident [mouseaccel] [TODO]; -docargument [N] [TODO] [min 0,0/max 1000,0/default 0,0]; docident [musicpreload] [TODO: Description]; docargument [A] [TODO] [] [0]; -docident [quicknadethrow] [TODO: Description]; -docident [removezip] [TODO: Description]; -docargument [A] [TODO] [] [0]; -docident [scopesensscale] [TODO]; -docargument [N] [TODO] [min 0,001/max 1000,0/default 0,5]; -docident [sensitivityscale] [TODO]; -docargument [N] [TODO] [min 0,001/max 1000,0/default 1,0]; -docident [setburst] [TODO: Description]; +docident [scopesensfeel] [TODO]; +docargument [N] [TODO] [min 0/max 1/default 0]; docident [setedithide] [Hides the list of entity types you set. Pass 1 for light, 2 for spawn, or use "playerstart".]; docargument [L] [list of types to hide] [] [0]; docremark [Pass light or 1, playerstart or 2. Call [setedithide 1 10] to just hide all lights and mapmodels.]; @@ -2184,8 +2602,4 @@ docargument [T] [type to show exclusively] [] [0]; docremark [Just run [seteditshow model] and see just the model entities.]; docremark [The other entity types are ignored as closestentity too.]; 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 [testvel] [TODO]; -docargument [N] [TODO] [min 0/max 1/default 0];