From 863d48119a7df84878403275ff718dc643f4e8a8 Mon Sep 17 00:00:00 2001 From: Lucas GAUTHERON Date: Fri, 11 Jan 2013 20:43:12 +0000 Subject: [PATCH] docs.cfg update git-svn-id: svn://svn.code.sf.net/p/actiongame/code/trunk/ac@7064 e016b1c5-ed68-44aa-a2f7-31cac88cffde --- config/docs.cfg | 156 +++++++++++++++++++++++++++--------------------- 1 file changed, 89 insertions(+), 67 deletions(-) diff --git a/config/docs.cfg b/config/docs.cfg index c130a336..0fc5c169 100644 --- a/config/docs.cfg +++ b/config/docs.cfg @@ -3,6 +3,9 @@ // To generate this file automatically, please carefully read the comment at the top of reference.xml docsection [CubeScript] +docident [-] [Performs a subtraction.]; +docargument [A] [the minuend] [] [0]; +docargument [B] [the subtrahend] [] [0]; docident [!] [Performs a negation.]; docargument [A] [argument] [] [0]; docident [!=] [Determines if two values are not equal.]; @@ -30,6 +33,11 @@ docremark [Example: *=f foo 13.37]; docident [*f] [Performs a floating point multiplication.]; docargument [A] [the multiplicand] [] [0]; docargument [B] [the multiplier] [] [0]; +docident [||] [logical OR.]; +docargument [A] [first value] [] [0]; +docargument [B] [second value] [] [0]; +docexample [echo (|| 1 0)] [output: 1]; +docexample [echo (|| 0 0)] [output: 0]; docident [+] [Performs an addition.]; docargument [A] [the first summand] [] [0]; docargument [B] [the second summand] [] [0]; @@ -45,20 +53,6 @@ docremark [Example: +=f foo 13.37]; docident [+f] [Adds up two floating-point numbers.]; docargument [A] [the first summand] [float] [0]; docargument [B] [the second summand] [float] [0]; -docident [-] [Performs a subtraction.]; -docargument [A] [the minuend] [] [0]; -docargument [B] [the subtrahend] [] [0]; -docident [-=] [Subtracts a value from an alias.]; -docargument [A] [the alias to subtract from] [] [0]; -docargument [B] [value to be subtracted] [] [0]; -docremark [Example: -= foo 1337]; -docident [-=f] [Subtracts a floating-point value from an alias.]; -docargument [A] [the alias to subtract from] [] [0]; -docargument [B] [value to be subtracted] [] [0]; -docremark [Example: -=f foo 13.37]; -docident [-f] [Subtracts two floating-point numbers.]; -docargument [A] [the minuend] [float] [0]; -docargument [B] [the subtrahend] [float] [0]; docident [<] [Determines if a value is smaller than a second value.]; docargument [A] [the first value] [] [0]; docargument [B] [the second value] [] [0]; @@ -75,9 +69,17 @@ docident [=] [Determines if two values are equal.]; docargument [A] [first value] [] [0]; docargument [B] [second value] [] [0]; docexample [echo there are only (concatword (= 1 1) (= 1 0)) types of people in the world] [Output: there are only 10 types of people in the world]; +docident [-=] [Subtracts a value from an alias.]; +docargument [A] [the alias to subtract from] [] [0]; +docargument [B] [value to be subtracted] [] [0]; +docremark [Example: -= foo 1337]; docident [=f] [Compares if a particular floating-point value is equal to another floating-point value.]; docargument [A] [The first value.] [] [0]; docargument [B] [The second value.] [] [0]; +docident [-=f] [Subtracts a floating-point value from an alias.]; +docargument [A] [the alias to subtract from] [] [0]; +docargument [B] [value to be subtracted] [] [0]; +docremark [Example: -=f foo 13.37]; docident [>] [Determines if a value is bigger than a second value.]; docargument [A] [the first value] [] [0]; docargument [B] [the second value] [] [0]; @@ -90,39 +92,6 @@ docargument [B] [the second value] [] [0]; docident [>f] [Determines if the first floating-point value is greater than the second floating-point value.]; docargument [A] [the first value] [] [0]; docargument [B] [the second value] [] [0]; -docident [MDArray_Add_To_Subarray] [Adds a string to an existing subarray in a cubescript multidimensional array.]; -docargument [A] [name of alias (multidimensional array)] [] [0]; -docargument [N] [name of target subarray to add to] [] [0]; -docargument [C] [string to add to target subarray] [] [0]; -docexample [MDArray_New_Subarray test list1 "this is part of list1"; MDArray_Add_To_Subarray test list1 "and so is this"; echo (MDArray_Get test list1 -1)] [Output: "this is part of list1" "and so is this"]; -docident [MDArray_Delete_Subarray] [Deletes an entire subarray from an existing cubescript multidimensional array.]; -docargument [A] [name of alias (multidimensional array)] [] [0]; -docargument [N] [name of target subarray to delete] [] [0]; -docident [MDArray_Get] [Returns a subarray or a subarray element of a cubescript multidimensional array.]; -docargument [A] [name of alias (multidimensional array)] [] [0]; -docargument [N] [name of target subarray to get] [] [0]; -docargument [E] [element # of subarray to get (-1 to return the whole subarray)] [] [0]; -docexample [MDArray_New_Subarray test words "how now brown cow"; echo (MDArray_Get test words -1); echo (MDArray_Get test words 2)] [Output: how now brown cow]; -docident [MDArray_Get_All_Subarray_Names] [Returns a list of all subarray names in a cubescript multidimensional array.]; -docargument [A] [name of alias (multidimensional array)] [] [0]; -docexample [MDArray_New_Subarray test chars "a b c d e f"; MDArray_New_Subarray test words "how now brown cow"; echo (MDArray_Get_All_Subarray_Names test)] [Output: chars words]; -docident [MDArray_Get_Subarray_Count] [Returns the number of subarrays in a cubescript multidimensional array.]; -docargument [A] [name of alias (multidimensional array)] [] [0]; -docident [MDArray_Modify_Subarray] [Modifies a subarray element of a cubescript multidimensional array.]; -docargument [A] [name of alias (multidimensional array)] [] [0]; -docargument [N] [name of target subarray to modify] [] [0]; -docargument [E] [element # of subarray to modify] [] [0]; -docargument [C] [new value of subarray element] [] [0]; -docexample [MDArray_New_Subarray test numbers "1 2 3 4 5"; MDArray_Modify_Subarray test numbers 2 9; echo (MDArray_Get test numbers -1)] [Output: 1 2 9 4 5]; -docident [MDArray_New_Subarray] [Adds a subarray to a cubescript multidimensional array. (alias)]; -docargument [A] [name of alias (multidimensional array)] [] [0]; -docargument [N] [name of subarray to create] [] [0]; -docargument [C] [subarray content (string)] [] [0]; -docexample [MDArray_New_Subarray test words "how now brown cow"; echo (MDArray_Get test words -1); echo (MDArray_Get test words 2)] [Output: how now brown cow]; -docident [MDArray_Search] [Returns a list of all subarray names that have content matching a specific keyword.]; -docargument [A] [name of alias (multidimensional array)] [] [0]; -docargument [K] [keyword to search for] [] [0]; -docexample [MDArray_New_Subarray test words "how now brown cow"; MDArray_New_Subarray test days "monday tuesday wednesday thursday friday saturday sunday"; MDArray_New_Subarray test sentences [ "his shirt was brown" "her shirt was white" ]; echo (MDArray_Search test brown)] [Output: words sentences]; docident [add2alias] [This will append the passed 2nd argument to any existing content of the alias named in the 1st argument. Several popular aliases have predefined shortcuts using this scriptalias: addOnQuit, addOnLoadOnce, addOnLoadAlways. Check config/scripts.cfg for possible omissions in that list.]; docexample [foo = "one" add2alias foo two echo foo] [Output: one two]; docident [add2bind] [Adds a block of code, if it does not already exist, to a keybind.]; @@ -216,6 +185,9 @@ docargument [B] [] [the divisor] [0]; 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 [-f] [Subtracts two floating-point numbers.]; +docargument [A] [the minuend] [float] [0]; +docargument [B] [the subtrahend] [float] [0]; docident [findcn] [find client number (cn)]; docargument [N] [NAME] [] [0]; docident [findlist] [Searches a list for a specified value.]; @@ -236,12 +208,12 @@ docargument [cond] [the condition] [0 (false) or anything else (true)] [0]; docargument [true] [the body to execute if the condition is true] [] [0]; docargument [false] [the body to execute if the condition is false] [] [0]; docexample [if (> $x 10) [ echo x is bigger than 10 ] [ echo x too small ]] []; -docident [isIdent] [returns whether or not there is an identifier by that name]; -docargument [N] [identifier name] [] [0]; docident [isconst] [Determines if the argument given is a constant or not.]; docargument [A] [the alias to check for] [] [0]; docexample [const hello ""; echo (isconst hello)] [Output: 1]; docexample [hello = value; echo (isconst hello)] [Output: 0]; +docident [isIdent] [returns whether or not there is an identifier by that name]; +docargument [N] [identifier name] [] [0]; docident [l0] [leading zeros for the number V to make it W chars wide. It may look like 10 - which might be considered a mnemonic - but it's lowercase-L and 0!]; docargument [W] [WIDTH] [] [0]; docargument [V] [VALUE] [] [0]; @@ -263,6 +235,39 @@ docargument [V] [the list to browse] [] [0]; docargument [N] [the alias containing the current element value.] [] [0]; docargument [body] [the body to execute on each iteration] [] [0]; docexample [looplist "zero one two three" number [ echo $number ]] []; +docident [MDArray_Add_To_Subarray] [Adds a string to an existing subarray in a cubescript multidimensional array.]; +docargument [A] [name of alias (multidimensional array)] [] [0]; +docargument [N] [name of target subarray to add to] [] [0]; +docargument [C] [string to add to target subarray] [] [0]; +docexample [MDArray_New_Subarray test list1 "this is part of list1"; MDArray_Add_To_Subarray test list1 "and so is this"; echo (MDArray_Get test list1 -1)] [Output: "this is part of list1" "and so is this"]; +docident [MDArray_Delete_Subarray] [Deletes an entire subarray from an existing cubescript multidimensional array.]; +docargument [A] [name of alias (multidimensional array)] [] [0]; +docargument [N] [name of target subarray to delete] [] [0]; +docident [MDArray_Get] [Returns a subarray or a subarray element of a cubescript multidimensional array.]; +docargument [A] [name of alias (multidimensional array)] [] [0]; +docargument [N] [name of target subarray to get] [] [0]; +docargument [E] [element # of subarray to get (-1 to return the whole subarray)] [] [0]; +docexample [MDArray_New_Subarray test words "how now brown cow"; echo (MDArray_Get test words -1); echo (MDArray_Get test words 2)] [Output: how now brown cow]; +docident [MDArray_Get_All_Subarray_Names] [Returns a list of all subarray names in a cubescript multidimensional array.]; +docargument [A] [name of alias (multidimensional array)] [] [0]; +docexample [MDArray_New_Subarray test chars "a b c d e f"; MDArray_New_Subarray test words "how now brown cow"; echo (MDArray_Get_All_Subarray_Names test)] [Output: chars words]; +docident [MDArray_Get_Subarray_Count] [Returns the number of subarrays in a cubescript multidimensional array.]; +docargument [A] [name of alias (multidimensional array)] [] [0]; +docident [MDArray_Modify_Subarray] [Modifies a subarray element of a cubescript multidimensional array.]; +docargument [A] [name of alias (multidimensional array)] [] [0]; +docargument [N] [name of target subarray to modify] [] [0]; +docargument [E] [element # of subarray to modify] [] [0]; +docargument [C] [new value of subarray element] [] [0]; +docexample [MDArray_New_Subarray test numbers "1 2 3 4 5"; MDArray_Modify_Subarray test numbers 2 9; echo (MDArray_Get test numbers -1)] [Output: 1 2 9 4 5]; +docident [MDArray_New_Subarray] [Adds a subarray to a cubescript multidimensional array. (alias)]; +docargument [A] [name of alias (multidimensional array)] [] [0]; +docargument [N] [name of subarray to create] [] [0]; +docargument [C] [subarray content (string)] [] [0]; +docexample [MDArray_New_Subarray test words "how now brown cow"; echo (MDArray_Get test words -1); echo (MDArray_Get test words 2)] [Output: how now brown cow]; +docident [MDArray_Search] [Returns a list of all subarray names that have content matching a specific keyword.]; +docargument [A] [name of alias (multidimensional array)] [] [0]; +docargument [K] [keyword to search for] [] [0]; +docexample [MDArray_New_Subarray test words "how now brown cow"; MDArray_New_Subarray test days "monday tuesday wednesday thursday friday saturday sunday"; MDArray_New_Subarray test sentences [ "his shirt was brown" "her shirt was white" ]; echo (MDArray_Search test brown)] [Output: words sentences]; docident [mod] [Performs a modulo operation.]; docargument [A] [the dividend] [] [0]; docargument [B] [the divisor] [] [0]; @@ -367,11 +372,6 @@ docargument [cond] [the condition] [the code evaluated before each iteration] [0 docargument [body] [the body to execute on each iteration] [] [0]; docremark [This command sets the alias "i" from 0 to N-1 for every iteration. Note that the condition here has to have [], otherwise it would only be evaluated once.]; docexample [alias i 0; while [ (< $i 10) ] [ echo $i; alias i (+ $i 1) ]] []; -docident [||] [logical OR.]; -docargument [A] [first value] [] [0]; -docargument [B] [second value] [] [0]; -docexample [echo (|| 1 0)] [output: 1]; -docexample [echo (|| 0 0)] [output: 0]; docsection [General] 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]; @@ -416,6 +416,9 @@ docident [debugargs] [Dump all command arguments to STDOUT]; docargument [...] [...] [] [1]; docident [echo] [Outputs text to the console.]; docargument [L] [List of strings] [] [0]; +docident [editbind] [Similar to bind, but is only active while editing, where it overrides the regular bind for the specified key.]; +docargument [K] [the key to bind] [string] [0]; +docargument [A] [the command] [string, usually an alias] [0]; docident [exec] [Executes all commands in a specified config file.]; docargument [C] [the config file] [] [0]; docident [forward] [Moves the player forward.]; @@ -528,6 +531,9 @@ docargument [V] [distance] [min 0/max 16/default 8]; docident [smoothmove] [Determines the speed when extrapolating a players position.]; docargument [V] [movement speed] [min 0/max 100/default 75]; docident [soundtest] [Plays all hardcoded sounds in order.]; +docident [specbind] [Similar to bind, but is only active while spectating, where it overrides the regular bind for the specified key.]; +docargument [K] [the key to bind] [string] [0]; +docargument [A] [the command] [string, usually an alias] [0]; docident [systime] [seconds since the epoch (00:00:00 UTC on January 1, 1970)]; docexample [echo (systime)] []; docident [throttle_accel] [Determines how fast network throttling accelerates.]; @@ -554,17 +560,15 @@ docident [version] [Gets an integer representing the game version. READ ONLY]; docremark [As example, version 1.0 is represented as value 1000.]; docident [writecfg] [writes current configuration to config/saved.cfg - automatic on quit]; docsection [Gameplay] -docident [addListOnQuit] [Deletes a list of aliases (from saved.cfg) on quit.]; -docargument [L] [the list of aliases to delete] [min /max /default ]; -docexample [addListOnQuit "a b c"] [Deletes aliases a, b, and c from existance and saved.cfg upon quit.]; -docident [addOnQuit] [Execute a command or block of code on quit.]; -docargument [A] [the command or block of code to execute] [min /max /default ]; docident [addbot] [add a bot for a given team with a given skill calling him a given name.]; docargument [T] [team] [RVSF or CLA] [0]; docargument [S] [skill] [best, good, medium, worse OR bad] [0]; docargument [N] [name] [name for the bot] [0]; docremark [This command only works for single player modes.]; docexample [addbot RVSF medium Robbie] [Will add a bot named Robbie with a medium skill level to the RVSF team.]; +docident [addListOnQuit] [Deletes a list of aliases (from saved.cfg) on quit.]; +docargument [L] [the list of aliases to delete] [min /max /default ]; +docexample [addListOnQuit "a b c"] [Deletes aliases a, b, and c from existance and saved.cfg upon quit.]; docident [addnbot] [will add a given count of bots for the given team with the given skill and select random names for them.]; docargument [C] [count] [how many bots to add] [0]; docargument [T] [team] [RVSF or CLA] [0]; @@ -572,6 +576,8 @@ docargument [S] [skill] [best, good, medium, worse OR bad] [0]; docremark [This command only works for single player modes.]; docremark [The name of the bots will be selected randomly.]; docexample [addnbot 2 CLA bad] [Will add 2 bots with a bad skill level to the CLA team.]; +docident [addOnQuit] [Execute a command or block of code on quit.]; +docargument [A] [the command or block of code to execute] [min /max /default ]; docident [akimboautoswitch] [Enables or disables automatic switching to the akimbo upon pickup.]; docargument [N] [enable or disable] [min 0/max 1/default 1]; docident [akimboendaction] [Sets the behavior of weapon switching upon akimbo expiration.]; @@ -694,14 +700,14 @@ docexample [idlebots 0] [Will enable the bots to move and shoot.]; docident [ignore] [Ignore a player.]; docargument [A] [client number] [] [0]; docremark [You won't see any further game chat or hear any more voice com messages from that player.]; -docident [inWater] [Determines if the local player is standing in water or submerged.]; -docargument [T] [check if submerged instead?] [min 0/max 1/default 0] [0]; -docexample [if (inWater) [echo in water] [echo not in water]] [Example output: in water]; -docexample [if (inWater 1) [echo submerged] [echo not submerged]] [Example output: not submerged]; docident [inputcommand] [Makes an input perform a certain command.]; docargument [I] [input] [] [0]; docargument [C] [command] [] [0]; docargument [P] [prompt] [] [0]; +docident [inWater] [Determines if the local player is standing in water or submerged.]; +docargument [T] [check if submerged instead?] [min 0/max 1/default 0] [0]; +docexample [if (inWater) [echo in water] [echo not in water]] [Example output: in water]; +docexample [if (inWater 1) [echo submerged] [echo not submerged]] [Example output: not submerged]; docident [isclient] [Determines if the client number given is a valid client (player).]; docargument [C] [client number] [] [0]; docexample [echo (isclient 0)] [Example output: 1]; @@ -911,8 +917,6 @@ docargument [C] [clientnum] [] [0]; docident [xhairwpsel] [Determines if bot waypoints should be selected/placed using the crosshair or by the nearest location to your player.]; docargument [V] [Note: This is turned on by default.] [min 0/max 1/default 1]; docsection [Editing] -docident [Map editing] [A variable indicating if the game is in editmode.]; -docargument [B] [editmode] [1 (true), 0 (false) read-only]; docident [addpath1way1] []; docident [addpath1way2] []; docident [addpath2way1] []; @@ -1021,6 +1025,8 @@ docremark [The output will be added to the file 'mapdependencies.txt'.]; docident [listmapdependencies_all] [Prints all media dependencies of all maps to a file.]; docargument [A] [42] [] [0]; docremark [The output will be written to the file 'mapdependencies.txt'.]; +docident [Map editing] [A variable indicating if the game is in editmode.]; +docargument [B] [editmode] [1 (true), 0 (false) read-only]; 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.]; @@ -1346,7 +1352,7 @@ docargument [N] [0: new, 1: old] [min 0/max 1/default 0]; 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]; docident [radarentsize] [Sets the icon size of the players shown in the radar and the minimap.]; -docargument [V] [size of icons inside radar] [min 1/max 64/default 4]; +docargument [V] [size of icons inside radar] [min 4/max 64/default 12]; docident [radarheight] [change at what height you are floating in the radar-view]; docargument [H] [height] [min 5/max 500/default 150]; docident [recoilbackfade] []; @@ -1355,10 +1361,26 @@ docident [recoilbase] []; docargument [V] [] [min 0/max 1000/default 40]; docident [recoilincrease] []; docargument [V] [] [min 1/max 10/default 2]; -docident [recoiltest] [.]; +docident [recoiltest] []; docargument [V] [] [min 0/max 1/default 0]; docident [righthanded] [Choose whether the players hand carrying the weapon appears as right or left handed.]; docargument [N] [0: lefty, 1: righty] [min 0/max 1/default 1]; +docident [sc_clientnum] [Sets the order priority for the column cn on the scoreboard.]; +docargument [V] [low priority: left, high priority: right] [min 0/max 100/default 6]; +docident [sc_deaths] [Sets the order priority for the column deaths or disables it on the scoreboard.]; +docargument [V] [-1: disable, low priority: left, high priority: right] [min -1/max 100/default 2]; +docident [sc_flags] [Sets the order priority for the column flags on the scoreboard.]; +docargument [V] [low priority: left, high priority: right] [min 0/max 100/default 0]; +docident [sc_frags] [Sets the order priority for the column frags on the scoreboard.]; +docargument [V] [low priority: left, high priority: right] [min 0/max 100/default 1]; +docident [sc_lag] [Sets the order priority for the column pj/ping or disables it on the scoreboard.]; +docargument [V] [-1: disable, low priority: left, high priority: right] [min -1/max 100/default 5]; +docident [sc_name] [Sets the order priority for the column name on the scoreboard.]; +docargument [V] [low priority: left, high priority: right] [min 0/max 100/default 7]; +docident [sc_ratio] [Sets the order priority for the column ratio or disables it on the scoreboard.]; +docargument [V] [-1: disable, low priority: left, high priority: right] [min -1/max 100/default -1]; +docident [sc_score] [Sets the order priority for the column score or disables it on the scoreboard.]; +docargument [V] [-1: disable, low priority: left, high priority: right] [min -1/max 100/default 4]; docident [showmodedescriptions] [enables or disables the showing of game mode descriptions on the console after map starts.]; docargument [B] [0 off, 1 on] [min 0/max 1/default 1]; docident [showspeed] [Enables or disables showing the player's horizontal speed.];