more doc updates...

git-svn-id: svn://svn.code.sf.net/p/actiongame/code/trunk/ac@6173 e016b1c5-ed68-44aa-a2f7-31cac88cffde
This commit is contained in:
Bukz
2011-03-31 18:21:42 +00:00
parent 099a1b2930
commit 020043ca07
2 changed files with 87 additions and 23 deletions
+12 -3
View File
@@ -139,6 +139,11 @@ docexample [sleep 1000 [ echo foo ]] [Prints 'foo' to the screen after 1 second.
docident [strcmp] [Determines if two strings are equal.];
docargument [A] [the first string] [] [0];
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];
docident [strstr] [Determines if string B was found in string A.];
docargument [A] [The first string.];
docargument [B] [The second string.];
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!];
docident [strlen] [Returns the length (in characters, including whitespace) of string S.];
docargument [S] [The string to check.];
docexample [echo (strlen "Hello world!")] [output: 12];
@@ -153,6 +158,9 @@ docargument [cond] [the condition] [0 (false) or anything else (true)] [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 [c] [Adds color to a string.];
docargument [N] [The color ID.];
docexample [echo (c 3)Hello (c 0)world!] [Output: a red "Hello" and a green "world!"];
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];
@@ -547,6 +555,9 @@ docident [voicecom] [];
docargument [S] [sound] [must be a registered voicecom-sound] [0];
docargument [T] [text] [] [0];
dockey [V] [] [opens the voicecom menu, use number keys for your choice];
docident [voicecomsounds] [Enables or disables voicecom audio.];
docargument [N] [0..2] [min 0/max 2/default 1];
docremark [0 (off), 1 (always play voicecom audio), 2 (only play voicecom audio from you and your teammates)];
docident [vote] [agree or disagree to the currently running vote];
docargument [V] [vote value] [1 (yes) OR 2 (no)] [0];
dockey [F1] [] [votes YES];
@@ -1557,6 +1568,4 @@ docargument [N] [TODO] [min 0/max 1/default 0];
docident [texreduce] [-1: 2x2 : 0 : 1: x0.5 : 2: x0.25 : 3: x0.125];
docargument [N] [TODO] [min -1/max 3/default 0];
docident [texturescale] [TODO];
docargument [N] [TODO] [min 16/max 64/default 32];
docident [voicecomsounds] [TODO];
docargument [N] [TODO] [min 0/max 2/default 1];
docargument [N] [TODO] [min 16/max 64/default 32];