From 020043ca07d80e28cd4033bd5ea564bd5476f8e1 Mon Sep 17 00:00:00 2001
From: Bukz <bukizzle316@gmail.com>
Date: Thu, 31 Mar 2011 18:21:42 +0000
Subject: [PATCH] more doc updates...

git-svn-id: svn://svn.code.sf.net/p/actiongame/code/trunk/ac@6173 e016b1c5-ed68-44aa-a2f7-31cac88cffde
---
 config/docs.cfg    | 15 ++++++--
 docs/reference.xml | 95 ++++++++++++++++++++++++++++++++++++----------
 2 files changed, 87 insertions(+), 23 deletions(-)

diff --git a/config/docs.cfg b/config/docs.cfg
index 34e1672a..813621a3 100644
--- a/config/docs.cfg
+++ b/config/docs.cfg
@@ -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];
\ No newline at end of file
+docargument [N] [TODO] [min 16/max 64/default 32];
\ No newline at end of file
diff --git a/docs/reference.xml b/docs/reference.xml
index 25b6ffee..04898593 100644
--- a/docs/reference.xml
+++ b/docs/reference.xml
@@ -345,13 +345,40 @@
 
 				<command name="strcmp">
 					<description>Determines if two strings are equal.</description>
+          <examples>
+            <example>
+              <code><![CDATA[if (strcmp yes yes) [echo the two strings are equal] [echo the two strings are not equal]]]></code>
+              <explanation>Output: the two strings are equal</explanation>
+            </example>
+          </examples>
 					<arguments>
 						<argument token="A" description="the first string"/>
 						<argument token="B" description="the second string"/>
 					</arguments>
 					<return token="N" description="the equality" valueNotes="1 (equal) or 0 (unequal)"/>
+          <references>
+            <identifierReference identifier="strstr"/>
+          </references>
 				</command>
         
+        <command name="strstr">
+          <description>Determines if string B was found in string A.</description>
+          <examples>
+            <example>
+              <code><![CDATA[if (strstr "Hello world!" Hello) [echo found Hello in Hello world!] [echo did not find Hello in Hello world!]]]></code>
+              <explanation>Output: found Hello in Hello world!</explanation>
+            </example>
+          </examples>
+          <arguments>
+            <argument token="A" description="the first string"/>
+            <argument token="B" description="the second string"/>
+          </arguments>
+          <return token="N" description="the truth value" valueNotes="0 (false), 1 (true)"/>
+          <references>
+            <identifierReference identifier="strcmp"/>
+          </references>
+        </command>
+        
         <command name="strlen">
 					<description>Returns the length (in characters, including whitespace) of string S.</description>
 					<examples>
@@ -557,6 +584,22 @@
 					</example>
 					</examples>
 				</command>
+        
+        <command name="c">
+          <description>Adds color to a string.</description>
+          <examples>
+          <example>
+            <code><![CDATA[echo (c 3)Hello (c 0)world!]]></code>
+            <explanation>Output: a red "Hello" and a green "world!"</explanation>
+          </example>
+          </examples>
+          <arguments>
+            <argument token="N" description="color id" valueNotes="0 min, 9 max"/>
+          </arguments>
+          <references>
+            <identifierReference identifier="cncolumncolor"/>
+          </references>
+        </command>
 
 			</identifiers>
 		</section>
@@ -1300,6 +1343,16 @@ echo (pstat_weap 0)
 						<key alias="V" description="opens the voicecom menu, use number keys for your choice"/>
 					</defaultKeys>
 				</command>
+        
+        <variable name="voicecomsounds">
+					<description>Enables or disables voicecom audio.</description>
+					<value token="N" description="voicecom sounds" minValue="0" maxValue="2" defaultValue="1" />
+          <arguments>
+            <argument valueNotes="0 (off)"/>
+            <argument valueNotes="1 (always play voicecom audio)"/>
+            <argument valueNotes="2 (only play voicecom audio from you and your teammates)"/>
+          </arguments>
+				</variable>
 
 				<command name="mapname">
 					<description>returns the mapname</description>
@@ -3316,8 +3369,8 @@ Output:
 		</section>
 		<!-- Menus Section Ends -->
 
-		<!-- Head-Up Display Section Starts -->
-		<section name="Head-Up Display" sortindex="06">
+		<!-- Heads-Up Display Section Starts -->
+		<section name="Heads-Up Display" sortindex="06">
 			<description>This section describes the identifiers to configure the head-up display (HUD).</description>
 				<identifiers>
 
@@ -3463,7 +3516,7 @@ Output:
         
         <variable name="hudextras">
 					<description>Shows extra gameplay messages on certain events if connected to a server.</description>
-					<value token="N" description="TODO" minValue="0" maxValue="3" defaultValue="0"/>
+					<value token="N" description="enable/disable extra gameplay messages" minValue="0" maxValue="3" defaultValue="0"/>
           <arguments>
             <argument valueNotes="0 (off)"/>
             <argument valueNotes="1 (show extra messages in the console)"/>
@@ -3606,7 +3659,7 @@ Output:
         
         <variable name="cncolumncolor">
 					<description>colour of CN column in scoreboard</description>
-					<value token="N" description="TODO" minValue="0" maxValue="9" defaultValue="5" />
+					<value token="N" description="color" minValue="0" maxValue="9" defaultValue="5" />
           <arguments>
             <argument valueNotes="0 (green)"/>
             <argument valueNotes="1 (blue)"/>
@@ -4100,6 +4153,7 @@ Output:
 				<command name="mutesound">
 					<description>Mute a specific game sound.</description>
 					<references>
+            <identifierReference identifier="soundmuted"/>
 						<identifierReference identifier="unmuteallsounds"/>
 					</references>
 					<arguments>
@@ -4107,6 +4161,23 @@ Output:
 						<argument token="A" description="audible?" valueNotes="(mute) 0 || 1 (unmute)"/>
 					</arguments>
 				</command>
+        
+        <command name="soundmuted">
+					<description>Returns 1 if sound A is muted, else 0.</description>
+          <examples>
+            <example>
+              <code><![CDATA[mutesound 5; if (soundmuted 5) [echo Sound 5 is muted!] [echo Sound 5 is not muted!]]]></code>
+              <explanation>Output: Sound 5 is muted!</explanation>
+            </example>
+          </examples>
+					<arguments>
+  						<argument token="A" description="sound id" valueNotes="See /config/sounds.cfg for valid sound id's."/>
+					</arguments>
+          <references>
+            <identifierReference identifier="mutesound"/>
+						<identifierReference identifier="unmuteallsounds"/>
+					</references>
+				</command>
 
 				<command name="unmuteallsounds">
 					<description>Unmutes all previously muted sounds.</description>
@@ -5454,7 +5525,6 @@ Output:
 					</references>
 				</command>
 
-
 				<command name="menuitemmapload">
 					<description>a menuitem that loads a map, displays the title and the preview or a default image</description>
 					<arguments>
@@ -5492,13 +5562,6 @@ Output:
 					</arguments>
 				</command>
 
-				<command name="soundmuted">
-					<description>TODO: Description</description>
-					<arguments>
-  						<argument token="A" description="TODO"/>
-					</arguments>
-				</command>
-
 				<variable name="akimboendaction">
 					<description>0: none, 1: switch to primary?, 2: switch to nades?-before-switch to primary?</description>
 					<value token="N" description="TODO" minValue="0" maxValue="2" defaultValue="0" />
@@ -5539,8 +5602,6 @@ Output:
 					<value token="N" description="TODO" minValue="0" maxValue="1000" defaultValue="125" />
 				</variable>
 
-				
-
 				<variable name="interms">
 					<description>TODO</description>
 					<value token="N" description="TODO" minValue="0" maxValue="1" defaultValue="0" />
@@ -5606,12 +5667,6 @@ Output:
 					<value token="N" description="TODO" minValue="16" maxValue="64" defaultValue="32" />
 				</variable>
 
-				<variable name="voicecomsounds">
-					<description>TODO</description>
-					<value token="N" description="TODO" minValue="0" maxValue="2" defaultValue="1" />
-				</variable>
-
-
 				<variable name="maploaditemlength">
 					<description>change at what position to truncate the map title string</description>
 					<value token="N" description="CHAR" minValue="0" maxValue="255" defaultValue="46" />