doc/changelog updates

git-svn-id: svn://svn.code.sf.net/p/actiongame/code/trunk/ac@6528 e016b1c5-ed68-44aa-a2f7-31cac88cffde
This commit is contained in:
Bukz
2011-06-10 14:19:33 +00:00
parent 0c3ad5886b
commit 4322b0fc91
3 changed files with 60 additions and 30 deletions
+3 -1
View File
@@ -171,7 +171,9 @@ CubeScript
[*] listaverage - Returns the average of a list of numbers. (Supports ints and floats - e.g. echo (listaverage "2 5 5") // Output: 4.0)
[*] player1 - // TODO explain // Also getposition and positiontype have been removed in favor of this command which does that and a lot more. :p
[*] rndmap - Returns a random official map. (e.g. echo (rndmap) // Example output: ac_desert3)
[*] persistidents - Controls persistence of idents/aliases
[*] persistidents - Controls persistence of idents/aliases. (Stored into saved.cfg on quit.)
[*] add2bind - Adds a block of code, if it does not already exist, to a keybind.
[*] numconlines - Returns the current number of lines on the console. (e.g. echo $numconlines // Example output: 153)
[*] Multiple Idents - New helper aliases for voting for SURV, TPF, and TLSS. (e.g. /surv ac_desert)
[*] "Sleeps" can be persistent. (e.g. "Persist" even through map loads - new optional 3rd argument of the /sleep command)
[*] Substr crash bug is fixed. Also the command can now use a negative position value.
+4
View File
@@ -254,6 +254,9 @@ docexample [echo (strreplace "Hello cruel world" cruel "")] [Output: Hello world
docident [listaverage] [Returns the average of a list of numbers.];
docargument [L] [the list of numbers] [supports ints and floats] [0];
docexample [echo (listaverage "2 5 5")] [Output: 4.0];
docident [add2bind] [Adds a block of code, if it does not already exist, to a keybind.];
docargument [K] [the key to add to] [] [0];
docargument [C] [the code to add] [] [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];
@@ -422,6 +425,7 @@ 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];
docident [onNewMap] [If this alias exists, it will be automatically executed when you start a new map.];
docident [numconlines] [Holds the current number of lines on the console.];
docsection [Gameplay]
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];
+53 -29
View File
@@ -790,20 +790,6 @@
<argument token="V" description="VALUE"/>
</arguments>
</command>
<command name="add2list">
<description>Appends a new element to a list.</description>
<examples>
<example>
<code><![CDATA[tmp_list = []; add2list tmp_list Hello; add2list tmp_list world!; echo $tmp_list]]></code>
<explanation>Output: Hello world!</explanation>
</example>
</examples>
<arguments>
<argument token="A" description="the alias (list) to add to"/>
<argument token="E" description="the new element to add"/>
</arguments>
</command>
<command name="storesets">
<description>Generates an alias (list) of the current values for the given CVARs.</description>
@@ -1118,6 +1104,55 @@
<argument token="L" description="the list of numbers" valueNotes="supports ints and floats"/>
</arguments>
</command>
<scriptalias name="add2alias">
<description>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.</description>
<examples>
<example>
<code><![CDATA[
foo = "one"
add2alias foo two
echo foo
]]></code>
<explanation>Output: one two</explanation>
<explanation>This will output the string and override any other actions that might've been defined.</explanation>
</example>
</examples>
<references>
<identifierReference identifier="add2bind"/>
<identifierReference identifier="add2list"/>
</references>
</scriptalias>
<scriptalias name="add2list">
<description>Appends a new element to a list.</description>
<examples>
<example>
<code><![CDATA[tmp_list = []; add2list tmp_list Hello; add2list tmp_list world!; echo $tmp_list]]></code>
<explanation>Output: Hello world!</explanation>
</example>
</examples>
<arguments>
<argument token="A" description="the alias (list) to add to"/>
<argument token="E" description="the new element to add"/>
</arguments>
<references>
<identifierReference identifier="add2alias"/>
<identifierReference identifier="add2bind"/>
</references>
</scriptalias>
<scriptalias name="add2bind">
<description>Adds a block of code, if it does not already exist, to a keybind.</description>
<arguments>
<argument token="K" description="the key to add to"/>
<argument token="C" description="the code to add"/>
</arguments>
<references>
<identifierReference identifier="add2alias"/>
<identifierReference identifier="add2list"/>
</references>
</scriptalias>
</identifiers>
</section>
@@ -1766,6 +1801,10 @@
<description>Sets the maximum value the display will roll on strafing.</description>
<value token="N" description="the roll value" minValue="0" maxValue="20" defaultValue="0"/>
</variable>
<variable name="numconlines">
<description>Hold the current number of lines on the console.</description>
</variable>
</identifiers>
</section>
@@ -1931,21 +1970,6 @@ addOnLoadAlways [
</remarks>
</scriptalias>
<scriptalias name="add2alias">
<description>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.</description>
<examples>
<example>
<code><![CDATA[
foo = "one"
add2alias foo two
echo foo
]]></code>
<explanation>Output: one two</explanation>
<explanation>This will output the string and override any other actions that might've been defined.</explanation>
</example>
</examples>
</scriptalias>
<scriptalias name="addOnQuit">
<description>Execute a command or block of code on quit.</description>
<value token="A" description="the command or block of code to execute"/>