From 061c6b9596aa6fc5ea2f5254cd4449860ceb2592 Mon Sep 17 00:00:00 2001 From: Lucas GAUTHERON Date: Mon, 28 Oct 2013 20:46:39 +0000 Subject: [PATCH] docs.cfg update git-svn-id: svn://svn.code.sf.net/p/actiongame/code/trunk/ac@7619 e016b1c5-ed68-44aa-a2f7-31cac88cffde --- config/docs.cfg | 99 +++++++++++++++++++++++++------------------------ 1 file changed, 50 insertions(+), 49 deletions(-) diff --git a/config/docs.cfg b/config/docs.cfg index d4635c87..dc9883c4 100644 --- a/config/docs.cfg +++ b/config/docs.cfg @@ -3,6 +3,12 @@ // 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 [--] [Decrements an alias by 1.]; +docargument [A] [the alias name] [] [0]; +docexample [i = 0; -- i; echo $i] [Output: -1]; docident [!] [Performs a negation.]; docargument [A] [argument] [] [0]; docident [!=] [Determines if two values are not equal.]; @@ -30,6 +36,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]; @@ -51,26 +62,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 [--] [Decrements an alias by 1.]; -docargument [A] [the alias name] [] [0]; -docexample [i = 0; -- i; echo $i] [Output: -1]; -docident [--f] [Decrements an alias by 1.]; -docargument [A] [the alias name] [] [0]; -docexample [i = 4.14; --f i; echo $i] [Output: 3.14]; -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]; @@ -87,9 +78,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]; @@ -201,6 +200,12 @@ 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 [--f] [Decrements an alias by 1.]; +docargument [A] [the alias name] [] [0]; +docexample [i = 4.14; --f i; echo $i] [Output: 3.14]; docident [findcn] [find client number (cn)]; docargument [N] [NAME] [] [0]; docident [findkey] [Returns the name of a key via a specified code.]; @@ -239,12 +244,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 [keybind] [Returns the contents of a keybind.]; docargument [K] [name of key] [] [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!]; @@ -387,11 +392,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]; @@ -484,8 +484,8 @@ docexample [en, de, fr, ...] []; docident [left] [Moves the player left.]; docremark [default keys: A and Left Arrow]; docident [mapshot] [save an image of the entire radar-overview of the map.]; -docident [maxfps] [Limits the FPS (frames per second) of the game.]; -docargument [V] [maximum FPS] [0 disables maxfps min 25 or 0/max 200/default 200]; +docident [maxfps] [Limits the FPS (frames per second) of AssaultCube's video output.]; +docargument [V] [maximum FPS] [0 disables maxfps min 25 or 0/max 1000/default 200]; docident [maxroll] [Sets the maximum value the display will roll on strafing.]; docargument [N] [the roll value] [min 0/max 20/default 0]; docident [maxtmus] [Gets the maximum number of supported textures when performing multitexturing.]; @@ -584,23 +584,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 [KEYPRESS] [If defined, this will be executed every time you press a key.]; -docargument [I] [integer key code] [] [0]; -docexample [checkinit KEYPRESS [echo You pressed key: (findkey $arg1)]] []; -docident [KEYRELEASE] [If defined, this will be executed every time you release a key.]; -docargument [I] [integer key code] [] [0]; -docexample [checkinit KEYRELEASE [echo You released key: (findkey $arg1)]] []; -docident [addListOnQuit] [Deletes a list of aliases (from saved.cfg) on quit.]; -docargument [L] [the list of aliases to delete] [min /max /default ]; -docexample [addListOnQuit "a b c"] [Deletes aliases a, b, and c from existance and saved.cfg upon quit.]; -docident [addOnQuit] [Execute a command or block of code on quit.]; -docargument [A] [the command or block of code to execute] [min /max /default ]; docident [addbot] [add a bot for a given team with a given skill calling him a given name.]; docargument [T] [team] [RVSF or CLA] [0]; docargument [S] [skill] [best, good, medium, worse OR bad] [0]; docargument [N] [name] [name for the bot] [0]; docremark [This command only works for single player modes.]; docexample [addbot RVSF medium Robbie] [Will add a bot named Robbie with a medium skill level to the RVSF team.]; +docident [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]; @@ -608,6 +600,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 [addpckserver] [Adds a packages source server where to download custom content from.]; docargument [S] [The server address. Trailing slash not needed.] [] [0]; docremark [Only add servers you trust.]; @@ -752,7 +746,8 @@ docexample [add2bind MOUSE1 [ if (hasprimary) [ echo you attacked with a primary docident [hidecustomskins] []; docargument [B] [] [min 0/max 1/default 0]; docident [hitsound] [Plays a sound upon every successful hit if enabled.]; -docargument [B] [off OR on] [1 (true), 0 (false) min 0/max 1/default 0]; +docargument [B] [off OR on] [0 (disabled), 1 (server), 2 (local) min 0/max 2/default 0]; +docremark [If hitsound is set to 2, the sound will be played instantly rather than after server acknowledgment.]; docident [idlebots] [Enables or disables the processing of the bots artificial intelligence]; docargument [T] [off OR on] [0||1] [0]; docexample [idlebots 1] [Will make the bots stand still.]; @@ -764,18 +759,24 @@ docident [ignoreall] [Ignores all clients currently on the server. (only works i docident [ignoreenemy] [Ignores all clients on the enemy team.]; docident [ignoreteam] [Ignores all clients on the specified team.]; docargument [T] [the team to ignore] [0 or 1 || cla or rvsf] [0]; -docident [inWater] [Determines if the local player is standing in water or submerged.]; -docargument [T] [check if submerged instead?] [min 0/max 1/default 0] [0]; -docexample [if (inWater) [echo in water] [echo not in water]] [Example output: in water]; -docexample [if (inWater 1) [echo submerged] [echo not submerged]] [Example output: not submerged]; docident [inputcommand] [Makes an input perform a certain command.]; docargument [I] [input] [] [0]; docargument [C] [command] [] [0]; docargument [P] [prompt] [] [0]; +docident [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]; docexample [echo (isclient 32)] [Example output: 0]; +docident [KEYPRESS] [If defined, this will be executed every time you press a key.]; +docargument [I] [integer key code] [] [0]; +docexample [checkinit KEYPRESS [echo You pressed key: (findkey $arg1)]] []; +docident [KEYRELEASE] [If defined, this will be executed every time you release a key.]; +docargument [I] [integer key code] [] [0]; +docexample [checkinit KEYRELEASE [echo You released key: (findkey $arg1)]] []; docident [kickallbots] [Kicks all bots out of the current game.]; docargument [] [this command does not take any arguments] [none] [0]; docident [kickbot] [Kicks the bot with the given name out of the current game.]; @@ -1023,8 +1024,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] []; @@ -1134,6 +1133,8 @@ docremark [Heightfields should be made the exact size that is needed, not more n docident [lightscale] [Used to finetune the "overbright lighting" rendering feature when enabled.]; docargument [N] [the brightness of the scene] [min 1/max 100/default 4]; docremark [After changing this value, a "recalc" is needed to see the differences.]; +docident [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.]; @@ -2142,7 +2143,7 @@ docargument [N] [TODO] [min 0/max 1/default 0]; docident [mapdimsfactor] [TODO]; docargument [N] [TODO] [min 0/max 4/default 2]; docident [maxrollremote] [TODO]; -docargument [N] [TODO] [min 0/max 1/default 1]; +docargument [N] [TODO] [min 0/max 20/default 0]; docident [mdldlist] [TODO]; docargument [N] [TODO] [min 0/max 1/default 1]; docident [menucanblink] [for toggling on the ability for menutext to have the blinking bit set. The global setting of 'allowblinkingtext' overrides this]; @@ -2181,4 +2182,4 @@ docident [setwptriggernr] [TODO: Description]; docargument [A] [TODO] [] [0]; docident [showedithide] [shows the settings of edithide (sparklies)]; docident [testvel] [TODO]; -docargument [N] [TODO] [min 0/max 1/default 0]; \ No newline at end of file +docargument [N] [TODO] [min 0/max 1/default 0];