From 87555d774aaf2ea936427f23de0087b2f7b2b29b Mon Sep 17 00:00:00 2001 From: aurhat Date: Wed, 19 Jul 2017 21:11:59 +0200 Subject: [PATCH] Update docs Compatible with tree in assaultcube.github.io for #68e4c1b commit. --- config/docs.cfg | 868 +++++++++++++++++++++++++++++++----------------- 1 file changed, 571 insertions(+), 297 deletions(-) diff --git a/config/docs.cfg b/config/docs.cfg index fa6474e1..87b1a5da 100644 --- a/config/docs.cfg +++ b/config/docs.cfg @@ -46,18 +46,6 @@ docident [+] [Performs an addition 2 or more numbers.]; docargument [A] [the first summand] [] [0]; docargument [B] [the summand(s)] [] [0]; docremark [Example: echo the sum of x and y is (+ $x $y)]; -docident [++] [Increments an alias by 1.]; -docargument [A] [the alias name] [] [0]; -docexample [i = 0; ++ i; echo $i] [Output: 1]; -docref [--]; -docref [++f]; -docref [--f]; -docident [++f] [Increments an alias by floating-point 1.]; -docargument [A] [the alias name] [] [0]; -docexample [i = 2.14; ++f i; echo $i] [Output: 3.14]; -docref [--f]; -docref [++]; -docref [--]; docident [+=] [Adds a value to an alias.]; docargument [A] [the alias to add to] [] [0]; docargument [B] [value to be added] [] [0]; @@ -72,18 +60,6 @@ docargument [B] [the summand(s)] [float] [0]; docident [-] [Performs a subtraction.]; docargument [A] [the minuend] [] [0]; docargument [B] [the subtrahend] [] [0]; -docident [--] [Decrements an alias by 1.]; -docargument [A] [the alias name] [] [0]; -docexample [i = 0; -- i; echo $i] [Output: -1]; -docref [++]; -docref [--f]; -docref [++f]; -docident [--f] [Decrements an alias by floating-point 1.]; -docargument [A] [the alias name] [] [0]; -docexample [i = 4.14; --f i; echo $i] [Output: 3.14]; -docref [++f]; -docref [--]; -docref [++]; docident [-=] [Subtracts a value from an alias.]; docargument [A] [the alias to subtract from] [] [0]; docargument [B] [value to be subtracted] [] [0]; @@ -150,7 +126,7 @@ 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!]; docref [add2alias]; docref [add2bind]; -docident [addpunct] [Injects CubeScript punctuation.]; +docident [addpunct] [Injects cubescript punctuation.]; docargument [S] [a string] [] [0]; docargument [N] [ID or name] [0 (quotes), 1 (brackets), 2 (parenthesis), 3 (_$_), 4 (quote), 5 (percent)] [0]; docexample [echo (addpunct hello)] [Output: "hello"]; @@ -162,7 +138,12 @@ docident [alias] [Binds a name to commands.]; docargument [N] [the name of the alias] [string, must not contain '$'] [0]; docargument [A] [the commands] [string] [0]; docexample [alias myalias [ echo "hello world"; alias myalias [ echo "I already said hello" ] ]] [It is possible to re-bind an alias, even during its evaluation.]; -docexample [test = [ echo "successful" ]] [There is also the shorthand version of defining an alias via the "="-sign.]; +docexample [test = [ echo "successful" ]] [There is also the shorthand version of defining an alias via the "=" sign.]; +docref [const]; +docref [tempalias]; +docref [isconst]; +docref [checkalias]; +docref [persistidents]; docident [aliasinit] [Initializes a group of aliases using checkinit.]; docargument [L] [the list of aliases to check for] [] [0]; docargument [B] [the block of code to ensure the aliases contain] [] [0]; @@ -173,6 +154,7 @@ docref [check2initlist]; docident [at] [Grabs a word out of a string.]; docargument [S] [the string] [] [0]; docargument [N] [the index of the word] [] [0]; +docremark [Negative index number returns "".]; 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]; @@ -180,7 +162,7 @@ docref [continue]; docref [loop]; docref [while]; docident [ceil] [Upper value of a float number.]; -docargument [F] [The float number to get the ceil from] [] [0]; +docargument [F] [the float number to get the ceil from] [] [0]; docident [check2init] [Defines an alias only if it does not already exist.]; docargument [A] [alias name] [] [0]; docargument [V] [alias value] [] [0]; @@ -222,17 +204,20 @@ docexample [alias a "Cube"; echo (concatword $a "Script")] [output: CubeScript]; docident [const] [Set an alias as a constant.]; docargument [N] [the name of the alias] [string, must not contain '$'] [0]; docargument [A] [the value] [string] [0]; -docremark [A constant cannot be redefined : its value cannot be changed.]; -docremark [To get rid of a constant, use delalias]; +docremark [A constant cannot be redefined in the same AC session: its value cannot be changed. To get rid of a constant, use "delalias".]; +docremark [Constant alias is temporary that will not be written to saved.cfg, and thus will not persist after quitting.]; docexample [myalias = myvalue; const myalias;] [Set "myalias" value to "myvalue" then "lock" it as a constant.]; docexample [const myalias myvalue;] [You can directly set a value for your alias when you define it as a constant.]; docexample [const myalias myvalue; myalias = anothervalue;] [Assigning a value to a const will throw you an error. Output: myalias is already defined as a constant]; +docref [alias]; +docref [tempalias]; +docref [isconst]; docident [continue] [Skip current loop iteration.]; docexample [loop i 5 [ if (= $i 2) [ continue ]; echo $i]] [output: 0 1 3 4]; docref [break]; docref [loop]; docref [while]; -docident [delalias] [deletes the passed alias.]; +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]; @@ -248,10 +233,18 @@ 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]; +docident [editalias] [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.]; +docremark [If the alias doesn't exist, it is created.]; +docexample [alias test "Hello World"; editalias test] [Result: edit test: Hello World]; +docref [editsvar]; +docref [inputcommand]; +docident [editsvar] [Interactively edits an existing alias in the console buffer.]; +docargument [A] [alias to edit] [the alias name, without $] [0]; +docremark [This takes the current value of the existing alias, and inserts it into the command line / text entry box.]; docexample [alias test "Hello World"; editsvar test] [Result: edit test: Hello World]; +docref [editalias]; docref [inputcommand]; docident [enumalias] [Lists all persistent aliases that start with prefix.]; docremark [Returns a table with two entries per alias: 1) full name and 2) name without prefix.]; @@ -259,14 +252,14 @@ docref [alias]; 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.]; +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 [findlist] [Searches a list for a specified value.]; docargument [L] [the list] [] [0]; docargument [I] [the item to find] [] [0]; docident [floor] [Floor value of a float number.]; -docargument [F] [The float number to get the floor from] [] [0]; +docargument [F] [the float number to get the floor from] [] [0]; docident [forceinit] [Forcibly sets a list of aliases to a specified value.]; docargument [L] [list of alias names] [] [0]; docargument [V] [alias value] [] [0]; @@ -275,7 +268,17 @@ docexample [forceinit [alias1 alias2 alias3 alias4 alias5] 0] []; docident [format] [Replaces "%" format specifiers in the string by the values specified in subsequent arguments.]; docargument [F] [format] [use %1..%9 for the values] [0]; docargument [V] [value(s)] [] [0]; +docremark [In addition, it allows access to more than nine parameters. Parameter numbers of 10 and higher have to be prefixed with an additional zero. For example "%010" accesses parameter number ten.]; 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!]; +docref [format2]; +docident [format2] [Replaces "%" format specifiers in the string by the values specified in subsequent arguments.]; +docargument [F] [format] [use %1..%9 for the values] [0]; +docargument [V] [value(s)] [] [0]; +docremark [Like "format" command, but all parameters are treated as lists and are exploded first.]; +docremark [In addition, it allows access to more than nine parameters. Parameter numbers of 10 and higher have to be prefixed with an additional zero. For example "%010" accesses parameter number ten.]; +docexample [echo (format "_%1_%2_%3_%4_%5_" "A B C" D E F)] [output: _A B C_D_E_F__]; +docexample [echo (format2 "_%1_%2_%3_%4_%5_" "A B C" D E F)] [output: _A_B_C_D_E_]; +docref [format]; docident [getalias] [Returns the value of the alias.]; docargument [N] [alias name] [] [0]; docref [storesets]; @@ -305,6 +308,8 @@ docident [inputcommand] [Makes an input perform a certain command.]; docargument [I] [input] [] [0]; docargument [C] [command] [] [0]; docargument [P] [prompt] [] [0]; +docargument [N] [nopersist] [] [0]; +docremark [It opens a custom console buffer with custom prompt, initial buffer text and execution script (which gets the input buffer content in alias cmdbuf). If "nopersist" is not zero, the command will not be stored in console history.]; docref [complete]; docref [listcomplete]; docref [saycommand]; @@ -316,8 +321,9 @@ docexample [const hello ""; echo (isconst hello)] [Output: 1]; docexample [hello = value; echo (isconst hello)] [Output: 0]; docref [const]; docident [isolatecontext] [Isolates the given context.]; -docargument [C] [the context] [] [0]; +docargument [C] [context (integer or name)] [CORE (0), CFG (1), PROMPT (2), MAPCFG (3), MDLCFG(4)] [0]; docremark [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.]; +docref [scriptcontext]; docref [sealcontexts]; docident [l0] [Leading zeros for the number V to make it W chars wide.]; docargument [W] [width] [] [0]; @@ -374,13 +380,21 @@ docargument [B] [the divisor] [] [0]; docexample [echo (modf 7.5 12.5)] [Output: 7.5]; docexample [echo (modf 17.5 12.5)] [Output: 5.0]; docident [numargs] [The number of arguments passed to the current alias.]; -docargument [V] [numargs] [ read-only]; +docargument [] [numargs] [ read-only]; docident [persistidents] [Controls whether aliases defined afterwards will be saved (1) or not (0).]; -docargument [B] [control option] [1...persistent, 0...not persistent] [0]; -docremark [This option is useful to keep saved.cfg free from unneeded clutter.]; -docremark [Note: in map and model configs, this option is always disabled.]; +docargument [B] [control option] [1: persistent, 0: not persistent] [0]; +docremark [Rules:]; +docremark [* aliases created by "const" and "tempalias" are never persistent;]; +docremark [* aliases created or altered by "alias" or "=" become persistent, if the "persistidents" flag is set during that operation;]; +docremark [* "persistidents" is false during the execution of almost all config files during game start - those files can create aliases with default values which will not be persistent (until changed later while the flag is set);]; +docremark [* before saved.cfg is executed, the flag is set and stays set all throughout the game - which means, that all changes (for example from menus or in console) will change the altered alias to "persistent";]; +docremark [* exceptions for map or model config files are unnecessary, since those run restricted and can't create aliases anyway;]; +docremark [* exceptions are necessary for "late run" config files like those in config/opt/ folder.]; +docremark [This command may be used to manually set or clear the flag. It also returns the current state of the flag. If used in a config file, the flag is restored to its original value when the file ends execution.]; +docremark [In short: only late-run config files (meaning: run after saved.cfg was restored) may need to manually set/reset the flag. Use "const" and "tempalias" where appropriate and clear "persistidents" before creating an alias with a not-to-save default value that may be changed and made persistent later.]; docexample [persistidents 0; foo = [ echo "bar"]] [foo will not be saved and has to be redefined when restarting AC.]; docexample [persistidents 1; bar = [ echo "foo"]] [bar will be saved and persistent across sessions.]; +docref [alias]; 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.]; @@ -395,22 +409,21 @@ docargument [A] [action] [] [0]; docexample [p = 1; push p 2; echo $p] [Output: 2]; docref [pop]; docident [resetsleeps] [Resets all current "sleep".]; -docident [result] [Sets the result value of a CubeScript block.]; +docident [result] [Sets the result value of a cubescript block.]; docargument [R] [the result] [] [0]; docref [execute]; -docref [return]; -docident [return] [Sets the result value of a CubeScript block.]; -docargument [R] [the result] [] [0]; -docref [execute]; -docref [result]; docident [rnd] [Random value.]; -docargument [A] [The upper limit of the random value] [] [0]; +docargument [A] [the upper limit of the random value] [] [0]; docident [round] [Rounds the given float.]; -docargument [F] [The float number to round] [] [0]; +docargument [F] [the float number to round] [] [0]; docident [scriptcontext] []; -docargument [C] [context] [] [0]; -docargument [N] [idname] [] [0]; +docargument [C] [context (integer or name)] [CORE (0), CFG (1), PROMPT (2), MAPCFG (3), MDLCFG(4)] [0]; +docargument [N] [id name] [] [0]; +docref [isolatecontext]; +docref [sealcontexts]; docident [sealcontexts] [Secures this configuration for the rest of the game.]; +docref [scriptcontext]; +docref [isolatecontext]; docident [sleep] [Executes a command after specified time period.]; docargument [N] [the amount of milliseconds] [] [0]; docargument [C] [the command to execute] [] [0]; @@ -430,54 +443,43 @@ docargument [B] [the second string] [] [0]; docexample [if (strcmp yes yes) [echo the two strings are equal] [echo the two strings are not equal]] [Output: the two strings are equal]; docref [strstr]; docident [strlen] [Returns the length (in characters, including whitespace) of string S.]; -docargument [S] [STRING] [] [0]; +docargument [S] [string] [] [0]; docexample [echo (strlen "Hello world!")] [Output: 12]; docref [substr]; -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 (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] []; -docexample [echo (strpos "hello world" "l" 2) 9] []; docident [strreplace] [Returns a string, with a portion of it replaced with a new sub-string.]; docargument [S] [the original string to modify] [] [0]; docargument [T] [the target sub-string to replace] [] [0]; docargument [N] [the new sub-string to replace the target] [] [0]; docexample [echo (strreplace "Hello cruel world" cruel "")] [Output: Hello world]; -docref [strpos]; docref [substr]; docident [strstr] [Determines if string B was found in string A.]; docargument [A] [the first string] [] [0]; docargument [B] [the second string] [] [0]; +docremark [It returns position of string B in string A (counting from 1) or zero, if not found.]; docexample [if (strstr "Hello world!" Hello) [echo found Hello in Hello world!] [echo did not find Hello in Hello world!]] [Output: found Hello in Hello world!]; docref [strcmp]; docident [substr] [Copies a substring out of the original.]; docargument [S] [the original string] [] [0]; docargument [A] [start position] [] [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] []; -docexample [echo (substr abcdefgh 2) cdefgh] []; +docargument [L] [substring length] [] [0]; +docremark [Character indexes begins at 0. If "start position" is negative, the reference is the end of the string. It also counts negative length from total length, if "substring length" parameter is negative.]; +docexample [echo (substr abcdefgh 2 5)] [Output: cdefg]; +docexample [echo (substr abcdefgh -3 2)] [Output: fg]; +docexample [echo (substr abcdefgh 2)] [Output: cdefgh]; +docexample [echo (substr abcdefgh 1 -2)] [Output: bcdefg]; docref [strlen]; -docref [strpos]; docref [strreplace]; docref [parsestring]; -docident [swapelements] [Returns a modified list swapping the positions of 2 elements.]; -docargument [L] [list] [] [0]; -docargument [S] [positions of 2 elements in the list to swapping] [] [0]; -docexample [echo (swapelements [0 1 2 3] [0 3])] [Output: 3 1 2 0]; docident [switch] [Takes an integer argument to determine what block of code to execute.]; 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)]; +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]; +docargument [C] [cubescript command(s)] [] [0]; docref [alias]; +docref [const]; 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]; @@ -529,9 +531,6 @@ docexample [addpckserver http://packages.ac-akimbo.net] []; docref [resetpckservers]; docref [autodownload]; docref [getpckserver]; -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.)]; @@ -543,6 +542,7 @@ docref [zipmodlist]; docref [zipmodgetdesc]; docref [zipmodgetfiles]; docref [zipmodgetrevision]; +docident [afterinit] [If defined, this will be executed after saved.cfg is loaded.]; 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]; docref [hudecho]; @@ -552,6 +552,7 @@ docident [autodownload] [Determines if the game should try to download missing p 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 [autoexec] [If defined, this will be executed after autoexec.cfg is loaded.]; 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.]; @@ -562,7 +563,6 @@ docident [cleanshot] [Takes a "clean" screenshot with no HUD items.]; docremark [Your current HUD configuration is stored into a buffer, and is re-enabled afterwards.]; docref [screenshot]; docref [blankouthud]; -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));]; @@ -581,15 +581,17 @@ docref [saycommand]; docref [listcomplete]; 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]; +docargument [] [the connection state] [1 (connected), 0 (disconnected) read-only]; 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]; +docargument [] [console state] [0: closed, 1: open in an alternate size, 2: open regularly read-only]; docref [altconsize]; docref [toggleconsole]; 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)]; +dockey [KP_MINUS] [- on the keypad] [scrolls backwards the console (conskip 5)]; +dockey [KP_PLUS] [+ on the keypad] [scrolls forwards the console (conskip -5)]; +dockey [KP_MULTIPLY] [* on the keypad] [resets the console (conskip -1000)]; +dockey [HASH|BACKSLASH+MOUSE4|MOUSE5] ['# or \' + mouse scroll] [scrolls the console]; docident [datestring] [Representation of date.]; docremark [Format: Www Mmm dd hh:mm:ss yyyy]; docremark [Use timestamp to create your own formatting.]; @@ -614,6 +616,11 @@ docref [demonameformat]; docident [echo] [Outputs text to the console.]; docargument [L] [List of strings] [] [0]; docref [hudecho]; +docident [enumfiles] [Lists files in a directory.]; +docargument [P] [path to directory] [] [0]; +docargument [E] [extension] [] [0]; +docremark [If extension is specified, only files of that extension are listed.]; +docremark [If the extension is "dir", only directories are listed.]; docident [exec] [Executes all commands in a specified config file.]; docargument [C] [the config file] [] [0]; docremark [It also allows to pass arguments to and deliver results from script files - when a script file is executed, any additional arguments are passed as execarg1..execargX to the script. The number of arguments is in execnumargs and if the script in the file sets the value of execresult, the exec command returns that value.]; @@ -644,7 +651,6 @@ docref [screenshottype]; docident [groupvariables] [Controls how many variables (with similar names) are grouped together on one line in saved.cfg.]; docargument [N] [Variables per line] [min 0/max 10/default 4]; docremark [This only pertains to commented variables in saved.cfg caused by omitunchangeddefaults being 0.]; -docremark [This only pertains to commented variables in saved.cfg caused by omitunchangeddefaults being 0.]; docref [omitunchangeddefaults]; docident [history] [Executes the specified command in the command line history.]; docargument [N] [the N'th command from the history] [] [0]; @@ -712,10 +718,12 @@ docident [saycommand] [Puts a prompt on screen.]; docargument [S...] [the text to display in the prompt] [] [1]; docremark [This puts a prompt on screen that you can type into, and will capture all keystrokes until you press return (or ESC to cancel). If what you typed started with a "/", the rest of it will be executed as a command, otherwise its something you "say" to all players.]; dockey [T] [] [opens empty prompt]; -dockey [BACKQUOTE] [`] [opens a command prompt /]; -dockey [TAB] [] [autocompletes commands/variables/aliases]; -dockey [UP] [] [browse command history forwards]; -dockey [DOWN] [] [browse command history backwards]; +dockey [BACKQUOTE|SLASH|CARET] [` or / or ^] [opens a command prompt /]; +dockey [Y] [] [opens a command prompt % (for team chat)]; +dockey [TAB] [Tab] [autocompletes forwards commands/variables/aliases]; +dockey [LSHIFT+TAB] [left Shift + Tab] [autocompletes backwards commands/variables/aliases]; +dockey [UP] [Up Arrow] [browse forwards command history]; +dockey [DOWN] [Down Arrow] [browse backwards command history]; docref [complete]; docref [listcomplete]; docref [inputcommand]; @@ -756,11 +764,6 @@ docexample [echo (at (timestamp) 0) (at (timestamp) 2) (at (timestamp) 1) "2063 docident [timestring] [The current time in (H)H:MM:SS format.]; docexample [echo (timestring) "12:34:56"] []; docexample [echo (timestring) "1:02:03"] []; -docident [tsswap] [Swaps vertices of model triangles.]; -docargument [V] [] [min 0/max 1/default 1]; -docident [updatefrommaster] [Contacts the masterserver and adds any new servers to the server list.]; -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.2.0.2 is represented as value 1202.]; docident [writecfg] [Writes current configuration to config/saved.cfg - automatic on quit.]; @@ -807,10 +810,6 @@ docargument [N] [the name of the zip mod] [] [0]; docref [addzipmod]; docref [zipmodclear]; docsection [Gameplay] -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]; -docref [akimboendaction]; docident [akimboendaction] [Sets the behavior of weapon switching upon akimbo expiration.]; docargument [] [] [0 (switch to knife)] [0]; docargument [] [] [1 (stay with pistol)] [0]; @@ -818,13 +817,13 @@ docargument [] [] [2 (switch to grenades)] [0]; docargument [] [] [3 (switch to primary)] [0]; 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.]; -docref [akimboautoswitch]; docident [attack] [Fires the current weapon.]; -docremark [default: left mouse button]; +dockey [MOUSE1] [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]; +docargument [B] [the autoreload state] [0: off, 1: on min 0/max 1/default 1]; +docref [reload]; docident [backward] [Moves the player backward.]; -docremark [default keys: S and Down Arrow]; +dockey [S|DOWN] [S or Down Arrow] []; docident [benchme] [Moves from active team to spectator during match.]; docident [burstshots] [Sets 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]; @@ -865,7 +864,7 @@ docref [connect]; docref [disconnect]; docref [reconnect]; docident [crouch] [Triggers a crouch.]; -docremark [default keys: left shift.]; +dockey [LSHIFT] [left Shift] []; docident [curautoteam] [Returns the server's current autoteam state.]; docident [curdemofile] [Returns the name of played demo.]; docref [demo]; @@ -933,12 +932,13 @@ docremark [Note that the coordinates must be specified as integers, not as float docref [resetzones]; docref [survival]; docident [dropflag] [Drops the taken flag.]; +dockey [BACKSPACE] [Backspace] []; docident [findcn] [Finds client number (cn) of player with given name.]; docargument [N] [player name] [] [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 [forward] [Moves the player forward.]; -docremark [default keys: W and Up Arrow]; +dockey [W|UP] [W or Up Arrow] []; docident [fragmessage] [Sets 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]; @@ -947,7 +947,7 @@ docref [gibmessage]; docref [weapon]; 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 :)]; +docremark [This does not work in multiplayer.]; docident [gametimecurrent] [Returns the time (in milliseconds) of the currently played game. READ ONLY]; docexample [showtime = [ if (> $lastgametimeupdate 0) [ gmr = (- $gametimemaximum (+ $gametimecurrent (- (millis) $lastgametimeupdate))) gsr = (div $gmr 1000) gts = (mod $gsr 60) if (< $gts 10) [ gts = (concatword 0 $gts) ] [ ] gtm = (div $gsr 60) if (< $gtm 10) [ gtm = (concatword 0 $gtm) ] [ ] echo (concatword $gtm : $gts) remaining ] [ echo gametime not updated yet ] ]] []; docref [minutesremaining]; @@ -964,9 +964,11 @@ docref [minutesremaining]; docref [gametimecurrent]; docref [lastgametimeupdate]; docref [millis]; -docident [getdemo] []; +docident [getdemo] [Gets the recorded demo from a game on the server.]; docargument [X] [number in list] [] [0]; docargument [P] [subpath] [] [0]; +docremark [If F10 is pressed earlier than two minutes into the game, the last game will be downloaded.]; +docremark [If F10 is pressed later than two minutes into the game, the current game is scheduled to be automatically downloaded when it ends.]; docref [listdemos]; docident [getmap] [Retrieves the last map that was sent to the server using 'sendmap'.]; docargument [S] [the name of the map] [] [0]; @@ -984,10 +986,12 @@ docargument [M] [the message you want to appear] [example: slashed] [0]; docremark [This command is identical to fragmessage, please see it.]; docref [fragmessage]; docref [weapon]; -docident [gndtoggle] [Toggles between your primary weapon and grenades. (must be bound to a key)]; +docident [gndtoggle] [Toggles between your primary weapon and grenades (must be bound to a key).]; docref [sndtoggle]; docref [knftoggle]; -docident [grenades] [Switches to grenades (if available). (must be bound to a key)]; +docident [grenades] [Switches to grenades, if available (must be bound to a key).]; +docremark [See also "quicknadethrow" command.]; +dockey [3] [] [switches to grenades]; docref [primary]; docref [secondary]; docref [melee]; @@ -1021,8 +1025,8 @@ docexample [echo (isclient 0)] [Example output: 1]; docexample [echo (isclient 32)] [Example output: 0]; docref [curplayers]; docident [jump] [Triggers a jump.]; -docremark [default keys: space and right ctrl.]; -docident [knftoggle] [Toggles between your primary weapon and knife. (must be bound to a key)]; +dockey [SPACE|RCTRL] [Space or right Ctrl] []; +docident [knftoggle] [Toggles between your primary weapon and knife (must be bound to a key).]; docref [sndtoggle]; docref [gndtoggle]; docident [lanconnect] [Tries to connect to a LAN server.]; @@ -1036,19 +1040,21 @@ docremark [If you haven't recieved any private messages, 'lastpm' is -1]; docref [pm]; docref [quickanswer]; docident [left] [Moves the player left.]; -docremark [default keys: A and Left Arrow]; +dockey [A|LEFT] [A or Left Arrow] []; docident [listdemos] [Get the game demos listing from the server we are currently connected.]; docref [getdemo]; +docref [cleardemo]; docident [listignored] [Print a list of all players that you are currently ignoring.]; docident [listmuted] [Prints a list of all players that you have muted.]; docident [loadcrosshair] [Loads a crosshair for given type.]; -docargument [T] [type] [default, teammate, scope, edit, knife, pistol, carbine, shotgun, subgun, sniper, assault, grenade, akimbo] [0]; +docargument [T] [type] [default, teammate, scope, edit, knife, pistol, carbine, shotgun, subgun, sniper, assault, grenade, akimbo, reset] [0]; docargument [I] [image] [] [0]; docexample [loadcrosshair red_dot.png] [Loads the red_dot.png crosshair for all weapons.]; 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.]; +docexample [loadcrosshair reset] [Loads all default crosshairs (including teammate and scope).]; docident [loadmap] [Loads a map directly in the current gamemode (singleplayer only).]; docargument [M] [map name] [] [0]; docref [map]; @@ -1094,7 +1100,9 @@ docref [mapstartalways]; docref [onNewMap]; docident [me] [Action chat message.]; docargument [...] [...] [] [1]; -docident [melee] [Switches to knife. (must be bound to a key)]; +docident [melee] [Switches to knife (must be bound to a key).]; +dockey [4] [] [switches to knife]; +dockey [MOUSE3] [middle mouse button] [switches to knife and attacks (if the key is held)]; docref [primary]; docref [secondary]; docref [grenades]; @@ -1183,8 +1191,9 @@ docref [onChangeVote]; docident [onWeaponSwitch] [If defined, this will be executed each time you switch to a different weapon.]; 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.]; +docident [paused] [Determines if the singleplayer game should be paused.]; docargument [B] [pause game] [min 0/max 1/default 0]; +dockey [PAUSE] [Pause] []; docident [pm] [Sends a private message to a specified client.]; docargument [C] [Client number] [] [0]; docargument [L] [List of strings] [] [0]; @@ -1198,7 +1207,8 @@ docref [curweapon]; docref [weapon]; docref [magcontent]; docref [magreserve]; -docident [primary] [Switches to your current primary weapon. (must be bound to a key)]; +docident [primary] [Switches to your current primary weapon (must be bound to a key).]; +dockey [1] [] []; docref [secondary]; docref [melee]; docref [grenades]; @@ -1211,10 +1221,13 @@ docref [start_intermission]; docref [pstat_score]; docref [weapon]; docident [quickanswer] [Easily respond the last client who sent you a private message.]; +dockey [N] [] []; docref [pm]; docref [lastpm]; -docident [quicknadethrow] [Switches to grenades (if available). (must be bound to a key)]; -docremark [If grenades are already selected, throw a grenade and switch back to previous weapon.]; +docident [quicknadethrow] [Switches to grenades, if available (must be bound to a key).]; +docremark [If grenades are already selected or the key is held, it throws a grenade and switches back to previous weapon.]; +dockey [G] [] [for all weapons]; +dockey [MOUSE2] [right mouse button] [for all weapons besides sniper rifle]; docref [grenades]; docident [reconnect] [Disconnects then reconnects you to the current server.]; docargument [P] [the server password] [] [0]; @@ -1223,6 +1236,8 @@ docref [connect]; docref [connectadmin]; docident [reload] [Reloads the weapon.]; docargument [A] [] [value] [0]; +dockey [R] [] []; +docref [autoreload]; docident [resetzones] [Reset all drawn zones.]; docref [drawzone]; docref [survival]; @@ -1232,14 +1247,15 @@ docremark [Note: you can use a negative value to forward.]; docref [demo]; docref [setmr]; docident [right] [Moves the player right.]; -docremark [default keys: D and Right Arrow]; +dockey [D|RIGHT] [D or 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.]; docident [scopefov] [Determines the FOV when scoping.]; docargument [V] [] [min 5/max 60/default 50]; docref [fov]; -docident [secondary] [Switches to your secondary weapon. (must be bound to a key)]; +docident [secondary] [Switches to your secondary weapon (must be bound to a key).]; +dockey [2] [] []; docref [primary]; docref [melee]; docref [grenades]; @@ -1252,14 +1268,15 @@ docargument [M] [the minutes remaining to skip to] [] [0]; docref [demo]; docref [rewind]; docident [setscope] [Displays a scope for the sniper-rifle.]; -docargument [Y] [scope on?] [0||1] [0]; +docargument [Y] [scope on?] [0 or 1] [0]; docremark [It is used in the zoom-script (config/scripts.cfg: "const zoom").]; +dockey [MOUSE2] [right mouse button] []; docident [shiftweapon] [Shifts your selected weapon by a given delta.]; docargument [D] [delta] [-N..-1,+1..N] [0]; docremark [By default the mouse-wheel shifts one up or down according to your scroll direction.]; dockey [MOUSE4] [] [cycle one up]; dockey [MOUSE5] [] [cycle one down]; -docident [sndtoggle] [Toggles between your primary weapon and secondary weapon. (must be bound to a key)]; +docident [sndtoggle] [Toggles between your primary weapon and secondary weapon (must be bound to a key).]; docref [knftoggle]; docref [gndtoggle]; docident [spectate] [Toggles spectator mode.]; @@ -1318,7 +1335,7 @@ 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. (must be bound to a key)]; +docident [weapon] [Changes the weapon (must be bound 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.]; @@ -1418,6 +1435,8 @@ docref [bind]; docref [onrelease]; 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 [modkeypressed] [Indicates if a CTRL key is pressed.]; +docargument [] [state of the CTRL key] [0: unpressed, 1: pressed read-only]; docident [mouseaccel] [Sets the mouse acceleration.]; docargument [N] [acceleration factor] [min 0.0/max 1000.0/default 0.0]; docref [sensitivity]; @@ -1551,18 +1570,23 @@ docref [addtodoentity]; docref [enumtodoentities]; docident [clearvantagepoint] [Clears a set parameters of vantage point.]; docref [setvantagepoint]; +docref [getvantagepoint]; docref [gotovantagepoint]; docident [closestenttype] [Restricts 'closest entity' display to one entity type.]; -docargument [A] [entity type] [] [0]; +docargument [A] [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 returns the current value and not change the value if the argument is "-".]; 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.]; dockey [C] [] []; docref [paste]; +docref [copyent]; docident [copyent] [Copies the current closest entity into a buffer.]; -docremark [Only works while in edit mode.]; +docremark [It also works with the menu list of copied entities. It works only while in edit mode.]; +dockey [MINUS] [- (minus)] []; docref [pasteent]; +docref [copy]; docident [corner] [Makes the current selection into a "corner".]; docremark [Currently there is only one type of corner (a 45 degree one), only works on a single unit (cube) at a time. It can be positioned either next to 2 solid walls or in the middle of 2 higher floorlevels and 2 lower ones forming a diagonal (and similar with ceiling).]; docremark [In both cases, the corner will orient itself automatically depending on its neighbours, behaviour with other configurations than the 2 above is unspecified. Since the latter configuration generates possibly 2 floor and 2 ceiling levels, up to 4 textures are used: for example for the 2 floors the higher one will of the cube itself, and the lower one of a neighbouring low cube. You can make bigger corners at once by issuing "corner" on grid aligned 2x2/4x4/8x8 selections, with equal size solid blocks next to them.]; @@ -1619,8 +1643,9 @@ docref [textureslotusagelist]; docref [textureslotbyname]; docref [edittextureslot]; docref [edittexturestack]; -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 [editaxis] [Returns a value for the main axis of player orientation.]; +docargument [] [main axis of player orientation] [11 (X), 12 (Y), 13 (Z), 111 (-X), 112 (-Y), 113 (-Z) read-only]; +docremark ["100" is added if the player is looking in the negative direction of the axis.]; docident [editentity] [Edits a map entity.]; docargument [N] [entity index/number] [] [0]; docargument [A] [list of attributes] [] [0]; @@ -1634,9 +1659,21 @@ docref [deleteentity]; 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.]; +dockey [LEFTBRACKET] [[] [moves downwards the selection in the floor]; +dockey [RIGHTBRACKET] []] [moves upwards the selection in the floor]; +dockey [O] [] [moves downwards the selection in the ceiling]; +dockey [P] [] [moves upwards the selection in the ceiling]; +docident [edithideentmask] [Integer variable containing a bitmask of hidden entity types.]; +docident [editinfopanelmillis] [Update the edit info panel every N milliseconds.]; +docargument [N] [milliseconds] [integer min 5/max 2000/default 80]; +docref [updateeditinfopanel]; +docref [hideeditinfopanel]; docident [editing] [A variable indicating if the game is in editmode.]; -docargument [B] [editmode] [1 (true), 0 (false) read-only]; +docargument [] [editmode in singleplayer] [1 (true), 0 (false) read-only]; +docref [editing_sp]; +docident [editing_sp] [A variable indicating if the game is in singleplayer editmode.]; +docargument [] [editmode] [1 (true), 0 (false) read-only]; +docref [editing]; docident [editmapmodelslot] [Edits the parameters of a mapmodel slot.]; docargument [N] [mapmodel slot number] [integer] [0]; docargument [R] [radius] [integer] [0]; @@ -1645,7 +1682,7 @@ 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 [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 (also in non-edit mode). 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"]; @@ -1661,7 +1698,7 @@ docident [editmapsoundslot] [Edits path/name and maxuses parameters of a mapsoun 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 [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 (also in non-edit mode). Therefore the command can be used to get and set parameters.]; docremark [If anything is changed, automapconfig is enabled.]; docref [mapsound]; docref [mapsoundslotbyname]; @@ -1670,40 +1707,55 @@ docref [deletemapsoundslot]; docref [mapsoundchanged]; docident [editmeta] [First modifier key for editing mode.]; docremark [Go to references mentioned below to see the use.]; -dockey [LCTRL] [left Ctrl] [first modifier key for editing mode]; +dockey [LCTRL] [left Ctrl] []; docref [addselection]; docref [entproperty]; docref [undelent]; docref [editmetakeydown]; +docref [editmeta2]; docident [editmeta2] [Second modifier key for editing mode.]; docremark [Go to references mentioned below to see the use.]; -dockey [LCTRL] [left Shift] [second modifier key for editing mode]; +dockey [LCTRL] [left Shift] []; docref [entproperty]; docref [undelent]; docref [editmeta2down]; +docref [editmeta]; docident [editmeta2down] [Indicates if second editmeta key is pressed.]; -docargument [N] [state of the second editmeta key] [0: unpressed, 1: pressed read-only]; +docargument [] [state of the second editmeta key] [0: unpressed, 1: pressed read-only]; docref [editmeta2]; docident [editmetakeydown] [Indicates if editmeta key is pressed.]; -docargument [N] [state of the first editmeta key] [0: unpressed, 1: pressed read-only]; +docargument [] [state of the first editmeta key] [0: unpressed, 1: pressed read-only]; docref [editmeta]; docident [edittag] []; docargument [T] [tag] [integer value] [0]; docident [edittagclip] [Sets tag clip type of all selected cubes.]; docargument [T] [type] [0 (none), 64 (clip), 128 (plclip)] [0]; docremark [Type can be numeric or a keyword.]; +dockey [KP1] [1 on the keypad] [sets a tag clip: none]; +dockey [KP2] [2 on the keypad] [sets a tag clip: clip]; +dockey [KP3] [3 on the keypad] [sets a tag clip: plclip]; docref [transformclipentities]; docident [edittex] [Changes the texture on current selection by browsing through a list of textures directly shown on the cubes.]; docargument [T] [an integer denoting the type] [0 (floor), 1 (lower or wall), 2 (ceiling), 3 (upper wall)] [0]; 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 [Default keys are the six keys above the cursor keys, which each 2 of them cycle one type (and numpad 7/4 for upper-wall).]; 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.]; +dockey [INSERT] [Insert] [browses forward through floor textures]; +dockey [DELETE] [Delete] [browses backward through floor textures]; +dockey [HOME] [Home] [browses forward through wall textures]; +dockey [END] [End] [browses backward through wall textures]; +dockey [PAGEUP] [Page Up] [browses forward through ceiling textures]; +dockey [PAGEDOWN] [Page Down] [browses backward through ceiling textures]; +dockey [KP4] [7 on the keypad] [browses forward through upper-wall textures]; +dockey [KP7] [4 on the keypad] [browses backward through upper-wall textures]; +dockey [X+MOUSE4|MOUSE5] [X + mouse scroll] [scrolls wall and upper-wall textures]; +dockey [Z+MOUSE4|MOUSE5] [Z + mouse scroll] [scrolls floor or ceiling textures]; docref [hudtexttl]; 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 [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 (also in non-edit mode). 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"]; @@ -1748,8 +1800,9 @@ 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 [Keys 1..7, in combination with the scrollwheel, can be used to alter the new entity attributes (attr1 - attr7). Key "M", in combination with the scrollwheel, can be used to move the entity. 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.]; +docremark [If 100 is added to the attribute index parameter, the sign of the increment value is changed.]; docref [getclosestent]; docref [getentattr]; docref [getenttype]; @@ -1778,7 +1831,8 @@ docref [cleartodoentities]; docref [xmap_list]; 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 .]; +dockey [COMMA] [,] [equalizes the selection on the floor]; +dockey [PERIOD] [.] [equalizes the selection on the ceiling]; docident [expandselection] [Increases 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.]; @@ -1789,10 +1843,11 @@ docident [extractconfigfile] [Writes an embedded config file to a separate file docref [automapconfig]; docref [embedconfigfile]; 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]; +docargument [] [flrceil] [0 (floor), 2 (ceiling) read-only]; 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.]; +dockey [F7] [] [toggles fullbright]; 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 [getautomapconfig] [Returns "1" if automapconfig is already enabled, "0" otherwise.]; @@ -1863,10 +1918,21 @@ docremark ["package dir #x": texture file was found in a mod directory.]; docremark [""]; docref [texture]; docref [gettexturelist]; +docident [getvantagepoint] [Returns string with coordinates of vantage point or empty string, if none is set.]; +docref [setvantagepoint]; +docref [gotovantagepoint]; +docref [clearvantagepoint]; docident [getwatercolour] [Returns a string with the four components of the water colour: red, green, blue and alpha.]; docexample [echo (getwatercolor)] [Output: 20 25 20 178]; docref [watercolour]; docref [setwatercolour]; +docident [getxmaplist] [Returns a list of all regular xmaps in memory, or, if 'what' is "bak", the details of a stored backup xmap.]; +docargument [w] [what] [bak] [0]; +docremark [Each xmap is listed with nickname and description.]; +docref [xmap_list]; +docident [gonextplayerstart] [Visit next or previous player spawn entity.]; +docargument [N] [direction] [none or 1: next, -1: previous] [0]; +docref [nextplayerstart]; 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.]; @@ -1881,15 +1947,25 @@ docremark [Returns x, y, z, yaw and pitch. Sets x, y, z, yaw and pitch, if the p 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.]; +docremark [It returns 1, if the map actually has a vantage point set.]; docref [setvantagepoint]; +docref [getvantagepoint]; docref [clearvantagepoint]; 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 [It 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".]; 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.]; +dockey [H] [] [makes the selection on the floor a heightfield]; +dockey [I] [] [makes the selection on the ceiling a heightfield]; docref [vdelta]; +docident [hideeditinfopanel] [Hide the edit info panel.]; +docargument [N] [0: show, 1: hide] [min 0/max 1/default 0]; +docref [updateeditinfopanel]; +docref [editinfopanelmillis]; +docident [hideeditslotinfo] [Hide the closest entity filename info.]; +docargument [N] [0: show info always, 1: only show "unassigned slot" if necessary, 2: never show info] [min 0/max 2/default 0]; 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.]; @@ -1929,6 +2005,7 @@ docref [embedconfigfile]; 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.]; docref [mapmodel]; +docref [mapmodelregistryclear]; docident [mapareacheck] [Calculates some key values to determine map geometry viability.]; docargument [W] [what] [vdelta, steepest, total, pprest, pp (default)] [0]; docremark [It returns different sets of statistics, depending on the keyword "what":]; @@ -1937,6 +2014,12 @@ docremark ["steepest" - returns the coordinates of the steepest heightfield cube docremark ["total" - returns the number of non-solid cubes on the map.]; docremark ["pprest" - returns the number of cubes _not_ visible from one of the probe positions.]; docremark ["pp" (default) - returns a table of all (currently 64) probe points of the map. Each probe point is listed with: x-coordinate, y-coordinate, floor height, area visible, volume of visible area, average height in visible area.]; +docident [mapartist] [Adds artist info to a map.]; +docargument [N] [Prints the map artist player ID] [print] [0]; +docargument [] [Sets the map artist player ID to the player currently logged in] [set] [0]; +docargument [] [Returns the current map artist player ID] [get] [0]; +docargument [] [Erases an existing map artist record in the current map] [clear] [0]; +docref [modeinfo]; 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.]; @@ -1968,6 +2051,14 @@ docref [mapmodel]; docref [getmapmodelattributes]; docref [listallmapmodelattributes]; docref [mdlattribute]; +docref [mapmodelregisterclear]; +docident [mapmodelregistryclear] [Deletes all loaded mapmodel attributes.]; +docref [mapmodel]; +docref [mapmodelregister]; +docref [getmapmodelattributes]; +docref [listallmapmodelattributes]; +docref [mdlattribute]; +docref [loadallmapmodels]; 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]; @@ -2057,9 +2148,13 @@ docref [mapsound]; docref [mapsoundslotbyname]; docref [editmapsoundslot]; docref [deletemapsoundslot]; -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]; -docref [showmapstats]; +docident [modeinfo] [Adds modeinfo info to a map.]; +docargument [N] [Lists current modeinfo entries] [list] [0]; +docargument [] [Returns list of current modeinfo entries] [get] [0]; +docargument [] [Erases current list of modeinfo entries] [clear] [0]; +docargument [] [Specifies flags for a list of modes] [ ] [0]; +docremark [See possibilities of mode list and flags (keywords) in config/maprot.cfg file. To use flags for all modes you can use "all" value instead of mode list.]; +docref [mapartist]; docident [movemap] [Moves the whole map (including all entities) in the specified direction.]; docargument [dX] [x-offset] [] [0]; docargument [dY] [y-offset] [] [0]; @@ -2071,6 +2166,7 @@ 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).]; +docref [newent7]; 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.]; @@ -2121,6 +2217,18 @@ 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 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.]; docref [mapsound]; +docident [newent7] [Adds a new entity, works like newent, but can set all seven attributes directly.]; +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]; +docargument [attr5] [see newent 'type'] [] [0]; +docargument [attr6] [see newent 'type'] [] [0]; +docargument [attr7] [see newent 'type'] [] [0]; +docremark [It does not automatically put the camera yaw angle into mapmodel and flag entities.]; +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).]; +docref [newent]; 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.]; @@ -2130,7 +2238,8 @@ docref [mapshrink]; docident [nextclosestent] [Chooses 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]; +docargument [N] [team number] [0: CLA, 1: RVSF, 100: FFA] [0]; +docref [gonextplayerstart]; 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] [This alias will automatically be executed when a new map is created via the "newmap" command.]; @@ -2143,13 +2252,21 @@ docremark [To paste a selection back requires a same size selection at the desti dockey [V] [] []; docref [copy]; docident [pasteent] [Pastes a previously copied entity.]; -docremark [Only works while in edit mode.]; +docremark [It also works with the menu list of copied entities. It works only while in edit mode.]; docref [copyent]; docident [perlin] [Generates a perlin noise landscape in the current selection.]; docargument [S] [the scale, frequency of the features] [default is 10] [0]; 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 [pointatent] [Enables or disables pointing at entity sparklies.]; +docargument [V] [value] [0: disable pointing, 1: enable pointing] [0]; +docremark [If an entity is pointed at during disabling, it is pinned.]; +docref [pointatentmaxangle]; +docref [toggleclosestentpin]; +docident [pointatentmaxangle] [Specifies the required precision for pointing at entities sparklies.]; +docargument [N] [0: not changed, 1: changed] [float min 0.01/max 180.0/default 2.0]; +docref [pointatent]; docident [preserveundosonsave] [Determines if undo data should be preserved on using "savemap" command.]; docargument [N] [0: don't preserve undos, 1: preserve undos] [min 0/max 1/default 0]; docremark [Undo data can be saved only in edit mode.]; @@ -2260,30 +2377,14 @@ docref [select]; docref [selx]; docref [sely]; docref [selxs]; -docident [setedithide] [Hides the list of entity types you set. Pass 1 for light, 2 for spawn, or use "playerstart".]; -docargument [L] [list of entity types or numbers to hide] [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 [Pass light or 1, playerstart or 2. Call "setedithide [1 10]" to just hide all lights and mapmodels.]; -docremark [Or "setedithide [3 4 5 6 7 8 9 12 13]" for all the clips, ammo, nades, health, helmet, armour, akimbo, ladder, and flag.]; -docremark [Reversly just use [1 2 10 11 13 14 15 16] to hide light, spawn, mapmodel, ladder, sound, clip, plclip.]; -docremark [Only shown entity types are potential 'closest entity'.]; -docremark ["setedithide" without any arguments restores visibility of all entities.]; -docref [seteditshow]; -docref [showedithide]; -docident [seteditshow] [Hides all but the single entity type you give. Pass 1 for light, 2 for spawn, or use [playerstart].]; -docargument [T] [the entity type or number to show exclusively] [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 [Just run "seteditshow mapmodel" and see just the mapmodel entities.]; -docremark [The other entity types are ignored as closestentity too.]; -docremark [Other call forms may use the numerical item type.]; -docremark ["seteditshow" without any argument hides all entities.]; -docref [setedithide]; -docref [showedithide]; docident [settex] [Sets 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 [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 [The vantage point is supposed to be a distinctive view on a map - like the angle from which the preview picture was taken. It is allowed to use when editing or spectating in singleplayer mode.]; docremark [A map can only have one vantage point.]; docref [gotovantagepoint]; +docref [getvantagepoint]; docref [clearvantagepoint]; docident [setwatercolour] [Allows setting the components of the water colour independently.]; docargument [W] [what] [red (0), green (1), blue (2), alpha (3)] [0]; @@ -2294,11 +2395,9 @@ docref [watercolour]; docref [getwatercolour]; docident [showclips] [Show clips/plclips/mapmodel clips in edit mode.]; docargument [N] [-] [min 0/max 1/default 1]; -docident [showedithide] [Shows the settings for hidden entities (sparklies).]; -docref [setedithide]; -docref [seteditshow]; 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.]; +dockey [F8] [] []; docref [showmip]; docident [showgrid] [Show editing cursor grid.]; docargument [N] [-] [min 0/max 1/default 1]; @@ -2307,8 +2406,9 @@ docargument [N] [-] [min 0/max 1/default 0]; 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 [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.]; +dockey [F6] [] []; docref [calcmipstats]; docref [showfocuscubedetails]; docident [showmodelclipping] [Show mapmodel clipping during edit mode.]; @@ -2331,7 +2431,9 @@ docremark [The selection must be a heightfield before this command can be used. docref [enlargearchslopeselections]; 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.]; +docremark [This operation retains floor/ceiling heights/textures while swapping between the two.]; +dockey [F] [] [makes the selection a solid]; +dockey [G] [] [makes the selection a space/non-heightfield]; docident [sortmapmodelslots] [Sorts all mapmoodel slots alphabetically and merges identical slots.]; docargument [nosort] [do not sort the list alphabetically] [] [0]; docargument [nomerge] [do not merge any slots] [] [0]; @@ -2399,10 +2501,11 @@ docref [deletetextureslot]; docref [edittexturestack]; 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.]; -dockey [MOUSE3] [middle mouse button] [toggles the pin on the closest entity]; +dockey [MOUSE3] [middle mouse button] []; docref [getclosestent]; 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.]; +dockey [F5] [] []; docident [transformclipentities] [Transforms all full height clip entities to tag clips.]; docref [edittagclip]; docident [undelent] [Restores deleted entity.]; @@ -2446,10 +2549,20 @@ docref [getdeletedentities]; docref [undelent]; docref [deleteentity]; docident [unsavededits] [Holds the number of unsaved edits.]; +docident [updateeditinfopanel] [A cubescript hook to provide additional information about the current edit situation.]; +docremark [For example it provides additional information about the closest entity.]; +docremark [The returned text is rendered on the right side of the screen.]; +docremark [Default for "updateeditinfopanel" is "explainclosestentity" script which provides detailed info about the closest entity.]; +docref [editinfopanelmillis]; +docref [hideeditinfopanel]; 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.]; +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.]; +docremark [This only works if the cube is a heightfield.]; +dockey [8] [] [manipulates downwards the corner of the current selection]; +dockey [9] [] [manipulates upwards the corner of the current selection]; +docref [heightfield]; docident [waterlevel] [Sets the global water level for the map.]; 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.]; @@ -2470,6 +2583,7 @@ docref [xmap_delete]; docref [xmap_delete_backup]; docref [xmap_keep_backup]; docref [xmap_rename]; +docref [getxmaplist]; docref [enumtodoentities]; docident [xmap_rename] [Changes the nickname of the xmap.]; docargument [O] [old nickname] [] [0]; @@ -2493,13 +2607,6 @@ docsection [Menus] docident [browsefiledesc] [Toggles getting descriptive text from CGZ or DMO files in menudirlist.]; docargument [B] [] [min 0/max 1/default 1]; docref [menudirlist]; -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]; -docref [menumdl]; 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]; @@ -2531,9 +2638,6 @@ docref [showmenu]; docref [closemenu]; docident [hidebigmenuimages] [Hide big images in menus.]; docargument [N] [0: show, 1: hide] [min 0/max 1/default 0]; -docident [maploaditemlength] [Changes at what position to truncate the map title string.]; -docargument [N] [chars] [min 0/max 255/default 46]; -docref [menuitemmapload]; docident [menucanblink] [Toggles the ability for menutext to have the blinking bit set.]; docargument [T] [0 = Off, any other integer = On] [Any integer is valid, positive or negative] [0]; docremark [The global setting of 'allowblinkingtext' overrides this.]; @@ -2548,15 +2652,24 @@ docremark [Use this inside menu definitions, almost always as the only command o 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]; docref [newmenu]; +docref [menudirlistsub]; docref [browsefiledesc]; -docident [menufont] [Switches the font in which the menu is displayed.]; +docident [menudirlistsub] [Adds subdirectory entries to a menu with a files list.]; +docargument [A] [action, executed, when the menu entry is chosen] [] [0]; +docargument [D] [if it is 1, an entry '..' is added (parent directory)] [] [0]; +docremark [It has to come after the menudirlist command.]; +docref [menudirlist]; +docident [menufont] [Sets the font for a specific menu.]; +docargument [N] [menu name] [] [0]; docargument [F] [font] [default, mono, serif] [0]; +docremark [If menu is "", the currently initialised menu is used.]; +docexample [menufont score mono] [sets the font on the scoreboard]; docref [font]; 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]; +docargument [C] [the code to execute on init] [] [0]; docremark [This command should be placed after newmenu.]; docref [newmenu]; docident [menuinitselection] [Defines the initial selection for a menu.]; @@ -2566,9 +2679,11 @@ 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).]; +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 ['\n' in menuitem synchronizes further text with slider width (tab-like function).]; +docremark [(Note: to activate the menu item, select it, and either: Click, press SPACE or press ENTER/Return).]; docref [newmenu]; +docref [getigraph]; 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]; @@ -2581,34 +2696,48 @@ docident [menuitemcheckbox] [Creates a checkbox menu item.]; docargument [T] [text] [] [0]; docargument [V] [value] [] [0]; docargument [A] [action] [] [0]; -docident [menuitemeditkeyinput] [Menuitem which displays "text" and all keys, that bind "bindcmd"- in edit mode.]; +docargument [P] [position] [0..100] [0]; +docremark [Optional fourth parameter "position" in the range from 0 o 100, default 0, which moves the position of the checkbox over the width of a text input or slider, with 100 being left and 0 being right.]; +docident [menuitemeditkeyinput] [Menuitem which displays "text" and all keys, that bind "bindcmd" - in edit mode.]; docargument [T] [text] [] [0]; docargument [B] [bind command] [] [0]; docref [menuitemkeyinput]; docref [menuitemspectkeyinput]; +docident [menuitemgreyedout] [Menu items added after this command are greyed out (1) or not (0).]; +docargument [V] [value] [0: off 1: on] [0]; +docremark [Greyed out menu items are grey and can't be operated.]; docident [menuitemimage] []; docargument [N] [image filename] [] [0]; docargument [T] [text] [] [0]; docargument [A] [action] [] [0]; docargument [H] [hoveraction] [] [0]; -docident [menuitemkeyinput] [Menuitem which displays "text" and all keys, that bind "bindcmd"- in game mode.]; +docident [menuitemkeyinput] [Menuitem which displays "text" and all keys, that bind "bindcmd" - in game mode.]; docargument [T] [text] [] [0]; docargument [B] [bind command] [] [0]; docref [menuitemeditkeyinput]; docref [menuitemspectkeyinput]; docident [menuitemmapload] [Menuitem that loads a map, displays the title and the preview or a default image.]; docargument [M] [map] [] [0]; -docargument [T] [text] [] [0]; -docref [maploaditemlength]; -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 [menuitemspectkeyinput] [Menuitem which displays "text" and all keys, that bind "bindcmd"- in spectate mode.]; +docargument [H] [hoveraction] [] [0]; +docargument [D] [description displayed on menu footer] [] [0]; +docref [screenshotpreview]; +docident [menuitemradio] []; +docargument [T] [text] [menu item text] [0]; +docargument [L] [min] [min value] [0]; +docargument [U] [max] [max value (or optionally -1 and set by display string length)] [0]; +docargument [V] [value] [initial value] [0]; +docargument [D] [display] [list of value descriptions or value step size] [0]; +docargument [A] [action] [executed on value changes (new value in arg1)] [0]; +docident [menuitemslider] []; +docargument [T] [text] [menu item text] [0]; +docargument [L] [min] [min value] [0]; +docargument [U] [max] [max value (or optionally -1 and set by display string length)] [0]; +docargument [V] [value] [initial value] [0]; +docargument [D] [display] [list of value descriptions or value step size] [0]; +docargument [A] [action] [executed on value changes (new value in arg1)] [0]; +docargument [W] [wrap] [if 1, wrap slider around] [0]; +docident [menuitemspectkeyinput] [Menuitem which displays "text" and all keys, that bind "bindcmd" - in spectate mode.]; docargument [T] [text] [] [0]; docargument [B] [bind command] [] [0]; docref [menuitemkeyinput]; @@ -2620,18 +2749,14 @@ docargument [A] [action] [] [0]; docargument [H] [hoveraction] [] [0]; docargument [M] [maxchars] [] [0]; docremark [If the last line of a menu is a text input item, pressing enter in that line will not only execute the assigned command, but also close the menu.]; -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]; -docremark [Like 'menuitem', but the menuitem description will be the result of an evaluation, everytime the menu gets displayed.]; -docref [newmenu]; -docref [menuitem]; -docident [menumdl] [Specifies a model to render while displaying the last added menu.]; +docident [menumdl] [Specifies a model to render while displaying the specified menu.]; +docargument [N] [the name of the menu] [] [0]; docargument [M] [the model] [] [0]; docargument [A] [the animation to play] [] [0]; docargument [R] [the rotation speed] [] [0]; docargument [S] [the scale] [] [0]; +docremark [If menu is "", the currently initialised menu is used.]; +docremark [It specifies, which model to render and how. If only menu is specified, no model is rendered.]; docident [menupicturesize] [Changes the size of pictures displayed in menus.]; docargument [N] [size factor] [min 0.1f/max 5.0f/default 1.6f]; docref [chmenutexture]; @@ -2656,13 +2781,16 @@ 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 [menusynctabstops] [Synchronizes tabs in menus.]; +docargument [V] [value] [0: off (default), 1: on] [0]; +docremark [If enabled (1), tab positions in a menu are synchronised. It affects menu title, header and items, but not footer or descriptions.]; 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]; docref [chmenutexture]; docref [menupicturesize]; 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.]; +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.]; docref [menuitem]; docident [refreshcurmenu] [Refreshes (closes and opens again) the current menu.]; docref [curmenu]; @@ -2672,6 +2800,11 @@ docident [refreshcurmenudelayed] [Refreshes (closes and opens again, after very docref [curmenu]; docref [refreshcurmenu]; docref [closecurmenu]; +docident [screenshotpreview] [Creates a screenshot cropped to 4:3 with a given number of lines and jpeg quality 80.]; +docargument [N] [number of lines] [144..480, default 240 or last given value] [0]; +docremark [Pressing CTRL+F12 during spectating creates a clean screenshot and saves it as map preview picture.]; +dockey [CTRL+F12] [Ctrl+F12] [creates map preview pictures during spectating]; +docref [menuitemmapload]; docident [showmenu] [Displays the specified menu.]; docargument [N] [the name of a previously defined menu] [] [0]; docremark [The menu allows the user to pick an item with the cursor keys. Upon pressing return, the associated action will be executed. Pressing ESC will cancel the menu.]; @@ -2740,6 +2873,8 @@ docargument [N] [damagescreen fade] [min 0/max 1000/default 125]; 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]; docref [showstats]; +docident [flagscorehudtransparency] [Options for flag score hud transparency.]; +docargument [V] [flag score hud transparency] [ 0: no transparency, icon set 'flag gone'; 1: transparency, icon set 'flag gone'; 2: transparency, classic icon set min 0/max 2/default 2]; docident [fullconsize] [Sets the percent of screen height for text lines on the F11 history display.]; docargument [V] [] [min 0/max 100/default 40]; docref [consize]; @@ -2768,18 +2903,9 @@ 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 [hideteamscorehud] [Turns on or off the display of team score icons.]; -docargument [V] [enable/disable flag icons] [min 0/max 1/default 0]; +docargument [V] [enable/disable team score icons] [min 0/max 1/default 0]; docident [hidevote] [Turns on or off the display of vote icons.]; docargument [V] [0=on; 1=on, but hide after own vote; 2=off] [min 0/max 2/default 0]; -docident [hudextras] [Show extra gameplay messages on certain events if connected to a server.]; -docargument [] [] [0 (off)] [0]; -docargument [] [] [1 (show extra messages in the console)] [0]; -docargument [] [] [2 (show extra messages in the console and on the HUD)] [0]; -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]; -docref [consize]; -docref [hideconsole]; -docref [hidehudmsgs]; 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 [ktfindicatoralpha] [Sets the level of transparency of ktf flag direction indicator, 100 = totally solid.]; @@ -2812,6 +2938,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 [showmap] [Determines if the mini-map should be shown on screen.]; docargument [B] [show mini-map] [min 0/max 1/default 0]; +dockey [LALT] [left Alt] [toggles minimap]; docident [showmapbackdrop] [Determines whether to have a see-through map overview (0), or render it on a black backdrop (1) or a combination of both (2).]; docargument [B] [backdrop-style] [min 0/max 2/default 0]; docident [showmapbackdroptransparency] [Transparency of the black map backdrop (in percent) rendered if showmapbackdrop is set to 2.]; @@ -2819,18 +2946,21 @@ docargument [T] [transparency] [min 0/max 100/default 75]; docref [showmapbackdrop]; docident [showscores] [Shows or hides the scores.]; dockey [TAB] [] []; +docref [showscoresondeath]; docident [showscoresondeath] [Determines if scores should be shown on death.]; docargument [V] [] [min 0/max 1/default 1]; +docref [showscores]; docident [showspeed] [Enables or disables showing the player's horizontal speed (vector).]; -docargument [N] [0 off, 1 on] [min 0/max 1/default 0]; +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]; docident [showtargetname] [Enables or disables showing the player name on the HUD when in your crosshair.]; -docargument [N] [0 off, 1 on] [min 0/max 1/default 1]; +docargument [N] [0: off, 1: on] [min 0/max 1/default 1]; docident [specthudgun] [Turns on/off the display of the hudgun while spectating a player in first-person view.]; docargument [V] [show/hide hudgun when spectating] [min 0/max 1/default 1]; docremark [Works in demo mode as well.]; docident [toggleconsole] [Toggles the console.]; +dockey [F11] [] []; 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.]; @@ -2902,7 +3032,6 @@ docref [fontchar]; docref [fontskip]; docref [setfont]; docref [menufont]; -docref [scorefont]; docref [menuitemaltfont]; 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]; @@ -2918,6 +3047,9 @@ docref [font]; docref [fontchar]; docident [fov] [Sets the field of view (fov).]; docargument [N] [the FOV value] [min 75/max 120/default 90]; +docref [scopefov]; +docref [spectfov]; +docref [spectfovremote]; docident [fpsrange] [Sets the range of FPS (AC will adjust LOD to achieve it).]; docargument [A] [min] [] [0]; docargument [B] [max] [] [0]; @@ -2935,6 +3067,19 @@ docargument [N] [the gamma value] [min 30/max 300/default 100]; docremark [May not work if your card/driver doesn't support it.]; docident [getdisplayresolutions] [Returns a list of available screen resolutions.]; docref [screenres]; +docident [getigraph] [Returns an encoded string to display an inlined image outside the console.]; +docargument [M] [mnemonic] [] [0]; +docremark [Images are stored in packages/misc/igraph/*.png and loaded during game start. Filenames consist of the image shorthand (mnemonic) and optional frame times, separated by "_". Media file names may only contain letters, digits and "_-.()".]; +docremark [All texts displayed in the game console are scanned for mnemonics prefixed with ":". All found matches are replaced by the image.]; +docremark [The images are displayed as squares with width and height the same as the regular font height. To create animations, put several square images side by side into the file. For example, a 128x32 image is interpreted as four frames. Frame duration is encoded in the filename, so, for example the file "nop_1000_200_100.png" shows the first frame for 1000 milliseconds, the second frame for 200 msec and the third (as the rest) for 100 msec.]; +docremark [Igraphs "1" to "9" are hardcoded and can be manually encoded in menu texts. Use the new escape code "\i" plus the number of the image: "\i\1".."\i\9". Other images can be used in menus as well, but the codes have to be fetched by "getigraph".]; +docremark [If the mnemonic was not found, then "getigraph" returns an empty string.]; +docref [updateigraphs]; +docref [igraphsize]; +docref [igraphsizehardcoded]; +docref [igraphanimate]; +docref [igraphdefaultframetime]; +docref [hideigraphs]; docident [gib] [Enables or disables the gib animation entirely.]; docargument [B] [off OR on] [0 (false), 1 (true) min 0/max 1/default 1]; docref [gibnum]; @@ -2967,6 +3112,9 @@ docargument [E] [extension] [] [0]; docexample [if (glext shadow_funcs) [echo you have shadow functionality] [echo no shadows for you]] []; docident [hidecustomskins] []; docargument [B] [] [min 0/max 1/default 0]; +docident [hideigraphs] [Hides inlined images in the console.]; +docargument [N] [0: show, 1: hide] [min 0/max 1/default 0]; +docref [getigraph]; docident [hirestextures] [Controls whether textures with a scale higher than 1.0 will be scaled down while loading (0) or not (1).]; docargument [S] [scale down?] [min 0/max 1/default 1]; docref [texture]; @@ -2974,8 +3122,27 @@ docident [hwmaxaniso] [Shows the maximum level of anisotropic filtering supporte docref [aniso]; docident [hwtexsize] [Shows the maximum texture size (in pixels) supported by the graphics hardware.]; docref [maxtexsize]; +docident [igraphanimate] [Enables animation of inlined images with multiple frames.]; +docargument [N] [0: display only first frame, 1: enable animation] [min 0/max 1/default 1]; +docref [getigraph]; +docref [igraphdefaultframetime]; +docref [igraphsize]; +docident [igraphdefaultframetime] [Default frame time for inlined images with multiple frames.]; +docargument [N] [frame time for images] [min 5/max 2000/default 200]; +docremark [Used for images with no frame duration specified in the filename.]; +docref [getigraph]; +docref [igraphanimate]; +docref [igraphsize]; +docident [igraphsize] [Scales inlined images (in percent).]; +docargument [N] [size of images (in percent)] [min 80/max 300/default 120]; +docref [getigraph]; +docref [igraphsizehardcoded]; +docident [igraphsizehardcoded] [Scales the hardcoded inlined images: "1".."9" (in percent).]; +docargument [N] [size of images (in percent)] [min 80/max 160/default 106]; +docref [getigraph]; +docref [igraphsize]; 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]; +docargument [E] [the error value, 1 being the best quality] [min 1/max 100/default 4]; docremark [If this variable is changed this during play, a "recalc" is needed to see the effect.]; docref [recalc]; docident [maxfps] [Limits the FPS (frames per second) of AssaultCube's video output.]; @@ -2984,11 +3151,16 @@ docremark [Remark: limit to '200' is optimal.]; docref [fpsrange]; docident [maxroll] [Sets the maximum value the display will roll on strafing.]; docargument [N] [the roll value] [min 0/max 20/default 0]; +docref [maxrolleffect]; docref [maxrollremote]; -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 [maxrolleffect] [Sets the maximum value the display will roll when you get damages.]; +docargument [N] [the roll value] [min 0/max 30/default 10]; +docref [maxrolleffect]; +docref [maxrollremote]; +docident [maxrollremote] [Limits the maximum value the display will roll on strafing or if player gets damages, when spectating other players.]; +docargument [N] [The roll value] [min 0/max 50/default 10]; docref [maxroll]; +docref [maxrolleffect]; docident [maxtexsize] [The maximum texture size that will be used by the engine, larger textures will be scaled down.]; docargument [V] [maximum texture size] [min 0/max 4096/default 0]; docremark [If this value is zero, hwtexsize will be used.]; @@ -3036,9 +3208,6 @@ docident [scorch] []; docargument [V] [] [min 0/max 1/default 1]; docident [scorchttl] []; 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]; -docref [font]; docident [scr_h] [Sets the screen height.]; docargument [H] [the screen height] [min 200/max 10000/default 768]; docident [scr_w] [Sets the screen width.]; @@ -3080,6 +3249,13 @@ docident [smoothmove] [Determines the speed when extrapolating a players positio docargument [V] [movement speed] [min 0/max 100/default 75]; docident [spectfov] [Specifies the Field Of View when in spectating/ghost mode.]; docargument [V] [Spectate FOV size] [min 5/max 120/default 110]; +docref [fov]; +docref [spectfovremote]; +docident [spectfovremote] [Chooses between local or remote player's FOV when spectating.]; +docargument [V] [0: uses 'spectfov' and the local 'scopefov', 1: uses 'fov' and 'scopefov' of the spectated player] [min 0/max 1/default 0]; +docref [fov]; +docref [spectfov]; +docref [scopefov]; docident [stencilbits] []; docargument [V] [] [min 0/max 32/default 0]; docident [stencilshadow] [Sets the transparency/opacity level of stencil shadows.]; @@ -3099,6 +3275,11 @@ docident [texreduce] [Reduces the size of all texture by the selected factor:]; docargument [S] [scale selection] [min -1/max 3/default 0]; docident [trilinear] []; docargument [V] [] [min 0/max 1/default 1]; +docident [tsswap] [Swaps vertices of model triangles.]; +docargument [V] [] [min 0/max 1/default 1]; +docident [updateigraphs] [Checks for new files in packages/misc/igraph/ folder.]; +docremark [Only necessary, if new files are added during the game - for example, by mod package download.]; +docref [getigraph]; docident [vsync] [Enables or disables vsync.]; docargument [V] [vsync] [min -1/max 1/default -1]; docremark [-1 uses the default settings obtained from the system. 0 disables, 1 enables vsync.]; @@ -3133,6 +3314,12 @@ docident [bulletbouncesound] []; docargument [V] [] [min 0/max 1/default 1]; docident [bulletbouncesoundrad] []; docargument [V] [] [min 0/max 1000/default 15]; +docident [enumsounds] [Lists sound index numbers and short descriptions for all sounds of one or more categories.]; +docargument [C] [list of sound categories (flags)] [PAIN, OWNPAIN, WEAPON, PICKUP, MOVEMENT, BULLET, OTHER, VOICECOM, TEAM, PUBLIC, FFA, FLAGONLY] [0]; +docremark [All sounds with at least one of the flags will be listed. Flag names prefixed with "!" will exclude all matching sound from the list. If no such entities exist or the entity type could not be recognised, the list is empty.]; +docexample [echo (enumsounds "VOICECOM !PUBLIC")] [It will list all voicecom sounds that are for teams only]; +docref [sound]; +docref [registersound]; docident [footsteps] [Indicates if the footsteps sound should be played.]; docargument [B] [enable footsteps] [1 (true), 0 (false) min 0/max 1/default 1]; docref [localfootsteps]; @@ -3181,8 +3368,10 @@ docremark [This command returns the sound number, which is assigned from 0 onwar docremark [See for example config/sounds.cfg.]; docref [sound]; 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 "player/jump")' both play the standard jump sound.]; +docargument [N] [number of the sound to play] [integer] [0]; +docremark [See source/src/server.h file or use "enumsounds" command 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.]; +docref [enumsounds]; +docref [registersound]; docident [soundchannels] [Sets the desired amount of allocated sound channels.]; 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.]; @@ -3216,16 +3405,19 @@ docref [docident]; docident [docexample] [Adds an example to the last added identifier.]; docargument [C] [the example code] [] [0]; docargument [E] [the explanation] [] [0]; -docident [docfind] [Searches the ingame docs for identifier documentations matching the specified search string.]; -docargument [S] [the search string] [] [0]; -docremark [The name, description and remarks are included in the search.]; +docident [docfind] [Searches for pattern in all ingame identifier documentations (reference) entries.]; +docargument [P] [the pattern] [] [0]; +docargument [S] [silent?] [] [0]; +docremark [If "silent" is zero or omitted, all found references are listed.]; +docremark [A table of all found entries is returned as result. For each entry, the index of the doc entry string that contains the pattern is listed.]; docref [docident]; docref [docundone]; docref [docinvalid]; +docref [getdoc]; docident [docident] [Adds a new identifier documentation to the last added section.]; docargument [N] [name of the identifier] [] [0]; docargument [D] [the description] [] [0]; -docremark [An identifier represents a command or variable. The new identifier]; +docremark [An identifier represents a command or variable.]; docremark [The name may contain spaces to create a "multipart" identifier documentation that can be used to describe a complex argument as a single pseudo identifier, look at the examples.]; docexample [docident fov "Sets the field of view."] []; docexample [docident "newent light" "Adds a new light entity."] []; @@ -3237,12 +3429,19 @@ docref [docundone]; docref [docinvalid]; docref [docfind]; docref [docwritebaseref]; +docref [docvisible]; +docref [docidentverbose]; +docident [docidentverbose] [Enables identifier details or statement analyser.]; +docargument [V] [level of displaying the additional informations] [min 0/max 3/default 1]; +docref [docident]; +docref [docvisible]; +docref [docrefvisible]; docident [docinvalid] [Outputs a list of identifier documentations that do not match any existing identifier.]; docremark [Multipart identifiers are not included in this list, see 'docident'.]; docref [docident]; docref [docundone]; docref [docfind]; -docident [dockey] []; +docident [dockey] [Adds a new default key to an identifier.]; docargument [A] [] [value] [0]; docident [docref] [Adds a new documentation reference to an identifier.]; docargument [N] [the display name] [] [0]; @@ -3250,14 +3449,19 @@ docargument [I] [the identifier to refer to] [] [0]; docargument [U] [the URL to refer to] [] [0]; docremark [The new reference is added to the last added identifier documentation.]; docref [docident]; +docident [docrefvisible] [Render documentation references (docrefs) of the identifiers.]; +docargument [V] [0: hide, 1: render] [min 0/max 1/default 1]; +docref [docref]; +docref [docvisible]; +docref [docidentverbose]; docident [docremark] [Adds a new documentation remark to the last added identifier.]; docargument [S] [the remark] [] [0]; docref [docident]; docident [docsection] [Adds a new section to the ingame documentation.]; docargument [S] [the section name] [] [0]; docref [docident]; -docident [docskip] []; -docargument [V] [] [min 0/max 1000/default 0]; +docident [docskip] [Allows to scroll through the rendered identifier documentation.]; +docargument [V] [offset (number of lines)] [min 0/max 1000/default 0]; docident [docundone] [Outputs a list of yet undocumented identifiers (commands, variables, etc.).]; docargument [A] [output all identifiers] [1 (true), 0 (false)] [0]; docremark [If the one argument is omitted, only the builtin identifiers will be listed. Therefore specify the argument other identifiers like aliases should be included too.]; @@ -3265,8 +3469,11 @@ docremark [Note that the list also includes identifiers that contain the substri docref [docident]; docref [docinvalid]; docref [docfind]; -docident [docvisible] []; -docargument [V] [] [min 0/max 1/default 1]; +docident [docvisible] [Render identifier documentation for the typed command in the console.]; +docargument [V] [0: hide, 1: render] [min 0/max 1/default 1]; +docref [docident]; +docref [docidentverbose]; +docref [docrefvisible]; docident [docwritebaseref] [Writes out a base XML documentation reference containing templates for the builtin identifiers.]; docargument [R] [the reference name] [] [0]; docargument [S] [the XML schema location string] [] [0]; @@ -3277,11 +3484,68 @@ docref [docundone]; docref [docinvalid]; docref [docfind]; 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] +docargument [I] [Also include aliases?] [0: don't include aliases (default), 1: include aliases] [0]; +docident [getdoc] [Returns a string of the specified identifier documentation (reference) entry.]; +docargument [N] [name of the identifier] [] [0]; +docargument [I] [the string index number of entry] [0: name, 1: description, 2: remarks] [0]; +docremark [String index numbers match with the result of "docfind".]; +docref [docident]; +docref [docfind]; +docsection [Serverbrowser] 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 [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 [clearservers] [Clears the server list.]; +docident [hidefavicons] [Hides favourites icons in serverbrowser.]; +docargument [N] [0: show, 1: hide] [min 0/max 1/default 0]; +docident [listfavcats] [Lists all registered serverbrowser favourites categories.]; +docident [mastertype] [Sets the method which client will use to contact the masterserver.]; +docargument [V] [0: direct TCP connection, 1: HTTP connection (via proxy)] [min 0/max 1/default 1]; +docref [updatefrommaster]; +docident [masterupdatefrequency] []; +docargument [V] [] [min 1/max 24*60*60/default 60*60]; +docref [updatefrommaster]; +docident [maxservpings] [Sets the number of servers to be pinged at once.]; +docargument [V] [] [min 0/max 1000/default 10]; +docident [searchlan] []; +docargument [V] [] [min 0/max 2/default 1]; +docident [searchnickname] [Search a nickname (or -part) on all servers.]; +docargument [N] [nickname to search] [] [0]; +docident [serverbrowserhidefavtag] [Hides favourites tag column in serverbrowser.]; +docargument [N] [-] [min 0/max 2/default 1]; +docident [serverbrowserhideip] [Hides server IP and port in serverbrowser.]; +docargument [N] [-] [min 0/max 2/default 2]; +docident [serversort] []; +docargument [V] [] [min 0/max NUMSERVSORT-1/default 0]; +docident [serversortdir] [Selects ascending of descending sort order in serverbrowser.]; +docident [serversortpreferofficial] [Sort official maps over custom maps in serverbrowser.]; +docargument [N] [-] [min 0/max 1/default 1]; +docident [servpingrate] []; +docargument [V] [] [min 1000/max 60000/default 5000]; +docident [showallplayersnumber] [Shows on serverbrowser number of all players on the all servers.]; +docargument [N] [] [min 0/max 1/default 0]; +docident [showallservers] [Whether servers that have not yet responded to a ping should be shown in the server list.]; +docargument [V] [] [min 0/max 1/default 1]; +docident [showminremain] [Show 'minutes remaining' in serverbrowser.]; +docargument [N] [] [min 0/max 1/default 1]; +docident [shownamesinbrowser] [Show player names in serverbrowser.]; +docargument [N] [-] [min 0/max 1/default 0]; +docident [showonlyfavourites] [Show only servers of one favourites category in serverbrowser.]; +docargument [N] [category index] [min 0/max 100/default 0]; +docident [showonlygoodservers] [Show only servers with the correct protocol in serverbrowser.]; +docargument [N] [-] [min 0/max 1/default 0]; +docident [showweights] [Show 'weights' in serverbrowser.]; +docargument [N] [] [min 0/max 1/default 1]; +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 [updatefrommaster] [Contacts the masterserver and adds any new servers to the server list.]; +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.]; +docref [mastertype]; +docref [masterupdatefrequency]; +docsection [Server commands] docident [autoteam] [Sets automated team assignment.]; docargument [B] [Enables or disables auto team] [1 (On), 0 (Off)] [0]; docref [setadmin]; @@ -3299,7 +3563,9 @@ docremark [This command is wrapped by aliases for better usability and is used t docident [cleardemo] [Clears specific demo currently in memory on the server.]; docargument [X] [number in list] [0 (all), 1..] [0]; docref [listdemos]; +docref [cleardemos]; docident [cleardemos] [Clears all demos currently in memory on the server.]; +docref [cleardemo]; docident [deleteservermap] [Deletes a map from the current server.]; docargument [A] [map name] [] [0]; docident [forceme] [Calls a vote to forceteam yourself to the specified team.]; @@ -3315,39 +3581,24 @@ docident [giveadmin] [Gives admin state to the specified player.]; 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.]; docref [setadmin]; -docident [hidefavicons] [Hides 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 [C] [The player to kick] [client number] [0]; docargument [R] [The reason] [at least 4 characters] [0]; docref [setadmin]; -docident [listfavcats] [Lists 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]; docremark [If the mastermode is set to 'private', no more clients can join the server. Default is 'open' which allows anyone to join the server.]; docref [setadmin]; -docident [masterupdatefrequency] []; -docargument [V] [] [min 1/max 24*60*60/default 60*60]; -docident [maxservpings] [Sets the number of servers to be pinged at once.]; -docargument [V] [] [min 0/max 1000/default 10]; docident [removebans] [Removes all temporary bans from the server.]; docremark [Temporary bans are normally automatically removed after 20 minutes.]; docref [ban]; docref [setadmin]; -docident [searchlan] []; -docargument [V] [] [min 0/max 2/default 1]; -docident [searchnickname] [Search a nickname (or -part) on all servers.]; -docargument [N] [nickname to search] [] [0]; docident [sendmap] [Sends a map to the server.]; docargument [M] [map to send] [] [0]; docremark [During coop edit, the current map gets saved to file and sent to the server. Other players can use 'getmap' to download it.]; docremark [When not in edit mode, the map will not be saved. The new map will be used, when the next game on that map starts on the server.]; docref [getmap]; docref [dlmap]; -docident [serverbrowserhidefavtag] [Hides favourites tag column in serverbrowser.]; -docargument [N] [-] [min 0/max 2/default 1]; -docident [serverbrowserhideip] [Hides server IP and port in serverbrowser.]; -docargument [N] [-] [min 0/max 2/default 2]; docident [serverdesc] [Sets user-define server description.]; docargument [D] [description] [] [0]; docremark [If the server was run with -n1 and -n2 arguments (prefix and suffix of descriptive title) a serveradmin can set a user-defined server description with this command, if it wasn't this command results in "invalid vote". This title will only stay until the next map is loaded.]; @@ -3356,13 +3607,6 @@ docident [serverextension] [Sends the extension name and argument string to the docargument [E] [extension name] [] [0]; docargument [A] [argument] [] [0]; docremark [See source/src/server.cpp ["case SV_EXTENSION:"].]; -docident [serversort] []; -docargument [V] [] [min 0/max NUMSERVSORT-1/default 0]; -docident [serversortdir] [Selects ascending of descending sort order in serverbrowser.]; -docident [serversortpreferofficial] [Sort official maps over custom maps in serverbrowser.]; -docargument [N] [-] [min 0/max 1/default 1]; -docident [servpingrate] []; -docargument [V] [] [min 1000/max 60000/default 5000]; docident [setadmin] [Claims or drops admin status.]; docargument [B] [Status] [1 (Claim), 0 (Drop)] [0]; docargument [PASS] [Password] [case sensitive] [0]; @@ -3372,21 +3616,6 @@ docref [autoteam]; docref [mastermode]; docref [ban]; docref [removebans]; -docident [showallplayersnumber] [Shows on serverbrowser number of all players on the all servers.]; -docargument [N] [] [min 0/max 1/default 0]; -docident [showallservers] [Whether servers that have not yet responded to a ping should be shown in the server list.]; -docargument [V] [] [min 0/max 1/default 1]; -docident [showminremain] [Show 'minutes remaining' in serverbrowser.]; -docargument [N] [] [min 0/max 1/default 1]; -docident [shownamesinbrowser] [Show player names in serverbrowser.]; -docargument [N] [-] [min 0/max 1/default 0]; -docident [showonlyfavourites] [Show only servers of one favourites category in serverbrowser.]; -docargument [N] [category index] [min 0/max 100/default 0]; -docident [showonlygoodservers] [Show only servers with the correct protocol in serverbrowser.]; -docargument [N] [-] [min 0/max 1/default 0]; -docident [showweights] [Show 'weights' in serverbrowser.]; -docargument [N] [] [min 0/max 1/default 1]; -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.]; docremark [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.]; docref [forceteam]; @@ -3723,10 +3952,10 @@ docargument [F] [frame] [] [0]; docargument [R] [range] [] [0]; docargument [S] [speed] [] [0]; docident [md2emit] []; -docargument [T] [tag] [] [0]; -docargument [Y] [type] [] [0]; -docargument [A] [arg1] [] [0]; -docargument [B] [arg2] [] [0]; +docargument [T] [tag name] [] [0]; +docargument [Y] [particle type (integer or name)] [SPARK (0), SMOKE (1), ECLOSEST (2), BLOOD (3), DEMOTRACK (4), FIREBALL (5), SHOTLINE (6), BULLETHOLE (7), BLOODSTAIN (8), SCORCH (9), HUDMUZZLEFLASH (10), MUZZLEFLASH (11), ELIGHT (12), ESPAWN (13), EAMMO (14), EPICKUP (15), EMODEL (16), ECARROT (17), ELADDER (18), EFLAG (19)] [0]; +docargument [A] [attribute 1] [] [0]; +docargument [B] [attribute 2] [] [0]; docident [md2tag] []; docargument [N] [name] [] [0]; docargument [A] [vert1] [] [0]; @@ -3739,14 +3968,14 @@ docargument [S] [startframe] [] [0]; docargument [R] [range] [] [0]; docargument [V] [speed] [] [0]; docident [md3emit] []; -docargument [T] [tag] [] [0]; -docargument [Y] [type] [] [0]; -docargument [A] [arg1] [] [0]; -docargument [B] [arg2] [] [0]; +docargument [T] [tag name] [] [0]; +docargument [Y] [particle type (integer or name)] [SPARK (0), SMOKE (1), ECLOSEST (2), BLOOD (3), DEMOTRACK (4), FIREBALL (5), SHOTLINE (6), BULLETHOLE (7), BLOODSTAIN (8), SCORCH (9), HUDMUZZLEFLASH (10), MUZZLEFLASH (11), ELIGHT (12), ESPAWN (13), EAMMO (14), EPICKUP (15), EMODEL (16), ECARROT (17), ELADDER (18), EFLAG (19)] [0]; +docargument [A] [attribute 1] [] [0]; +docargument [B] [attribute 2] [] [0]; docident [md3link] []; docargument [P] [parentno] [] [0]; docargument [C] [childno] [] [0]; -docargument [T] [tagname] [] [0]; +docargument [T] [tag name] [] [0]; docident [md3load] []; docargument [M] [model] [] [0]; docident [md3skin] []; @@ -3767,7 +3996,7 @@ docref [mapmodelregister]; docident [mdlcachelimit] []; docargument [L] [cachelimit] [] [0]; docident [mdlcullface] []; -docargument [C] [cullface] [0||1] [0]; +docargument [C] [cullface] [0 or 1] [0]; docident [mdlscale] []; docargument [P] [percent] [0..100..N*100] [0]; docident [mdlshadowdist] []; @@ -3779,7 +4008,7 @@ docargument [Z] [] [] [0]; docident [mdltranslucent] []; docargument [T] [translucency] [0..100..N*100] [0]; docident [mdlvertexlight] []; -docargument [V] [vertexligh] [0||1] [0]; +docargument [V] [vertexligh] [0 or 1] [0]; 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).]; @@ -3817,14 +4046,14 @@ docref [waterlevel]; docsection [Bot mode] docident [addbot] [Adds 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 [S] [skill] [best, good, medium, worse, 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] [Adds 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]; +docargument [S] [skill] [best, good, medium, worse, 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.]; @@ -3837,13 +4066,13 @@ docargument [A] [connect automatically] [0 or 1] [0]; docident [autowp] [Automatically places 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]; +docargument [S] [botskill] [best, good, medium, worse, 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]; +docargument [S] [botskill] [best, good, medium, worse, 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]; +docargument [T] [shooting bots?] [0 or 1] [0]; docexample [botsshoot 0] [Bots won't shoot.]; docident [delpath1way1] []; docident [delpath1way2] []; @@ -3851,7 +4080,7 @@ 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]; +docargument [T] [off OR on] [0 or 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.]; @@ -3872,14 +4101,38 @@ docref [setjumpwp]; 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]; +docargument [Y] [show info?] [0 or 1] [0]; docident [wpload] []; docident [wpsave] []; docident [wpvisible] []; -docargument [V] [visible] [0||1] [0]; +docargument [V] [visible] [0 or 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 [Optional] +docident [++] [Increments an alias by 1.]; +docargument [A] [the alias name] [] [0]; +docexample [i = 0; ++ i; echo $i] [Output: 1]; +docref [--]; +docref [++f]; +docref [--f]; +docident [++f] [Increments an alias by floating-point 1.]; +docargument [A] [the alias name] [] [0]; +docexample [i = 2.14; ++f i; echo $i] [Output: 3.14]; +docref [--f]; +docref [++]; +docref [--]; +docident [--] [Decrements an alias by 1.]; +docargument [A] [the alias name] [] [0]; +docexample [i = 0; -- i; echo $i] [Output: -1]; +docref [++]; +docref [--f]; +docref [++f]; +docident [--f] [Decrements an alias by floating-point 1.]; +docargument [A] [the alias name] [] [0]; +docexample [i = 4.14; --f i; echo $i] [Output: 3.14]; +docref [++f]; +docref [--]; +docref [++]; docident [alive] [Returns 1 if the local player is alive.]; docexample [echo (alive)] [Output: 1]; docref [load_compatibility]; @@ -3929,16 +4182,20 @@ docref [load_compatibility]; docident [getclientmode] [Returns the current game mode number.]; docref [load_compatibility]; docident [load_autosave] [Loads optional obsolete autosave settings.]; -docremark [To see the obsolete autosave settings, look in config/opt/autosave.cfg]; +docremark [To see the obsolete autosave settings, look at config/opt/autosave.cfg file.]; docident [load_compatibility] [Loads optional compatibility settings for old scripts.]; -docremark [To see the compatibility settings, look in config/opt/compatibility.cfg]; +docremark [To see the compatibility settings, look at config/opt/compatibility.cfg file.]; +docident [load_convmap] [Loads batch map conversion tools.]; +docremark [To see the map conversion tools, look at config/opt/convmap.cfg file.]; docident [load_faq] [Loads optional FAQ settings.]; -docremark [To see the FAQ settings, look in config/opt/faq.cfg]; +docremark [To see the FAQ settings, look at config/opt/faq.cfg file.]; docremark [The settings are loaded, when FAQ is open in menu.]; +docident [load_mapeditscripts] [Loads extra map editing scripts.]; +docremark [To see the map editing scripts, look at config/opt/mapeditscripts.cfg file.]; docident [load_parsestring] [Loads optional settings for string parsing.]; -docremark [To see the string parsing settings, look in config/opt/parsestring.cfg]; +docremark [To see the string parsing settings, look at config/opt/parsestring.cfg file.]; docident [load_survival] [Loads optional settings for bot survival mode.]; -docremark [To see the settings for survival, look in config/opt/survival.cfg]; +docremark [To see the settings for survival, look at config/opt/survival.cfg file.]; docremark [The settings are loaded, when bot survival mode is started via menu.]; docident [orderscorecolumns] [Show the client number column on the scoreboard first?]; docargument [N] [CN column order] [0 (false), 1 (true) min 0/max 1/default 0]; @@ -3964,6 +4221,23 @@ docexample [echo (pstat_score 0)] [Output: 0 5 3 43 1 1 unarmed]; docref [load_compatibility]; docref [start_intermission]; docref [pstat_weap]; +docident [setedithide] [Hides the list of entity types you set.]; +docargument [L] [list of entity types to hide] [light, playerstart, pistol, ammobox, grenades, health, helmet, armour, akimbo, mapmodel, ladder, ctf-flag, sound, clip, plclip] [0]; +docremark [Call "setedithide [lights mapmodels]" to just hide all lights and mapmodels.]; +docremark [Only shown entity types are potential 'closest entity'.]; +docremark ["setedithide" without any arguments restores visibility of all entities.]; +docref [seteditshow]; +docref [showedithide]; +docident [seteditshow] [Hides all but the single entity type you give.]; +docargument [T] [the entity type to show exclusively] [light, playerstart, pistol, ammobox, grenades, health, helmet, armour, akimbo, mapmodel, ladder, ctf-flag, sound, clip, plclip] [0]; +docremark [Just run "seteditshow mapmodel" and see just the mapmodel entities.]; +docremark [The other entity types are ignored as closestentity too.]; +docremark ["seteditshow" without any argument hides all entities.]; +docref [setedithide]; +docref [showedithide]; +docident [showedithide] [Shows the settings for hidden entities (sparklies).]; +docref [setedithide]; +docref [seteditshow]; 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];