From 4322b0fc91219c9cbde5bd55ca8d421dba00c872 Mon Sep 17 00:00:00 2001 From: Bukz Date: Fri, 10 Jun 2011 14:19:33 +0000 Subject: [PATCH] doc/changelog updates git-svn-id: svn://svn.code.sf.net/p/actiongame/code/trunk/ac@6528 e016b1c5-ed68-44aa-a2f7-31cac88cffde --- changelog.txt | 4 ++- config/docs.cfg | 4 +++ docs/reference.xml | 82 ++++++++++++++++++++++++++++++---------------- 3 files changed, 60 insertions(+), 30 deletions(-) diff --git a/changelog.txt b/changelog.txt index 9fce4253..de302ca0 100644 --- a/changelog.txt +++ b/changelog.txt @@ -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. diff --git a/config/docs.cfg b/config/docs.cfg index a61677ac..5f092eb9 100644 --- a/config/docs.cfg +++ b/config/docs.cfg @@ -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]; diff --git a/docs/reference.xml b/docs/reference.xml index 0bbfc268..51c38e21 100644 --- a/docs/reference.xml +++ b/docs/reference.xml @@ -790,20 +790,6 @@ - - - Appends a new element to a list. - - - - Output: Hello world! - - - - - - - Generates an alias (list) of the current values for the given CVARs. @@ -1118,6 +1104,55 @@ + + + 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. + + + + Output: one two + This will output the string and override any other actions that might've been defined. + + + + + + + + + + Appends a new element to a list. + + + + Output: Hello world! + + + + + + + + + + + + + + Adds a block of code, if it does not already exist, to a keybind. + + + + + + + + + @@ -1766,6 +1801,10 @@ Sets the maximum value the display will roll on strafing. + + + Hold the current number of lines on the console. + @@ -1931,21 +1970,6 @@ addOnLoadAlways [ - - 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. - - - - Output: one two - This will output the string and override any other actions that might've been defined. - - - - Execute a command or block of code on quit.