From 099a1b29309d109fdd477209d8ac2b09eaf201fa Mon Sep 17 00:00:00 2001 From: Bukz Date: Wed, 30 Mar 2011 23:47:06 +0000 Subject: [PATCH] doc updates git-svn-id: svn://svn.code.sf.net/p/actiongame/code/trunk/ac@6172 e016b1c5-ed68-44aa-a2f7-31cac88cffde --- config/docs.cfg | 21 ++++++------ docs/reference.xml | 79 ++++++++++++++++++++++++++++++++-------------- 2 files changed, 66 insertions(+), 34 deletions(-) diff --git a/config/docs.cfg b/config/docs.cfg index 304a5ebf..34e1672a 100644 --- a/config/docs.cfg +++ b/config/docs.cfg @@ -87,6 +87,10 @@ docargument [B] [the multiplier] [] [0]; docident [+f] [Adds up two floating-point numbers.]; docargument [A] [the first summand] [float] [0]; docargument [B] [the second summand] [float] [0]; +docident [findcn] [find client number (cn)]; +docargument [N] [NAME] [] [0]; +docident [findpn] [find player name]; +docargument [C] [CLIENTNUM] [] [0]; docident [findlist] [Searches a list for a specified value.]; docargument [L] [the list] [] [0]; docargument [I] [the item to find] [] [0]; @@ -863,7 +867,7 @@ docremark [All menu commands placed after newmenu (i.e. menuitem, menuitemcheckb docident [showmenu] [Displays the specified menu.]; docargument [N] [the name of a previously defined menu] [] [0]; docremark [The menu allows the user to pick an item with the cursor keys. Upon pressing return, the associated action will be executed. Pressing ESC will cancel the menu.]; -docsection [Head-Up Display] +docsection [Heads-Up Display] docident [aboveheadiconfadetime] [Time in milliseconds before the abovehead icon dissapears.]; docargument [V] [abovehead icon display time] [min 1/max 10000/default 2000]; docident [altconsize] [Sets the number of text lines on an alternate F11 history display.]; @@ -913,6 +917,9 @@ docident [hidehudequipment] [Turns on or off the display of equipement icons.]; docargument [V] [enable/disable equipement icons] [min 0/max 1/default 0]; docident [hidehudmsgs] [Turns on or off the display of messages at the bottom of the screen.]; docargument [V] [enable/disable messages] [min 0/max 1/default 0]; +docident [hudextras] [Shows extra gameplay messages on certain events if connected to a server.]; +docargument [N] [0..3] [min 0/max 3/default 0]; +docremark [0 (off), 1 (show extra messages in the console), 2 (show extra messages in the console and on the HUD), 3 (SPAM extra messages in the console and on the HUD)]; docident [hideradar] [Turns on or off the display of the on-screen radar.]; docargument [V] [enable/disable radar] [min 0/max 1/default 0]; docident [hidespecthud] [Turns on or off the display of spectator staus.]; @@ -961,6 +968,8 @@ docident [swayupmovediv] []; docargument [V] [] [min 1/max 1000/default 200]; docident [swayupspeeddiv] []; docargument [V] [] [min 1/max 1000/default 105]; +docident [cncolumncolor] [colour of CN column in scoreboard]; +docargument [N] [0..9] [min 0/max 9/default 5]; docsection [Visuals] docident [aadynshadow] [Sets the size/resolution of the dynamic shadow data.]; docargument [] [the size] [min 0/max 3/default 2]; @@ -1470,13 +1479,11 @@ docident [akimboendaction] [0: none, 1: switch to primary?, 2: switch to nades?- docargument [N] [TODO] [min 0/max 2/default 0]; docident [ambient] [TODO]; docargument [N] [TODO] [min 0/max 16777215/default 0]; -docident [applydialog] [do you reall want to quit?]; +docident [applydialog] [do you really want to quit?]; docargument [N] [TODO] [min 0/max 1/default 1]; docident [autoscopesens] [TODO]; docargument [N] [TODO] [min 0/max 1/default 0]; docident [checkmapdependencies] [Find what media the map depends on, this is used for mediapack providers.]; -docident [cncolumncolor] [colour of CN column in scoreboard]; -docargument [N] [TODO] [min 0/max 9/default 5]; docident [damagescreen] [show the blood-spat overlay when receiving damage?]; docargument [N] [TODO] [min 0/max 1/default 1]; docident [damagescreenalpha] [if overlay of blood-spat, at what blending (transparency) level?]; @@ -1485,16 +1492,10 @@ docident [damagescreenfactor] [if overlay of blood-spat, use which factor]; docargument [N] [TODO] [min 1/max 100/default 7]; docident [damagescreenfade] [if overlay of blood-spat, at what speed does it fade]; docargument [N] [TODO] [min 0/max 1000/default 125]; -docident [findcn] [find client number (cn)]; -docargument [N] [NAME] [] [0]; -docident [findpn] [find player name]; -docargument [C] [CLIENTNUM] [] [0]; docident [fontskip] [At what char does the definition proceed?]; docargument [A] [TODO] [] [0]; docident [gettext] [An alias used for i18n. Translateable text should be marked [(_ "this is the EN-us variant of the text")].]; docargument [M] [I18Nmessage] [] [0]; -docident [hudextras] [TODO]; -docargument [N] [TODO] [min 0/max 3/default 0]; docident [interms] [TODO]; docargument [N] [TODO] [min 0/max 1/default 0]; docident [mapdimsfactor] [TODO]; diff --git a/docs/reference.xml b/docs/reference.xml index 6ed9cab9..25b6ffee 100644 --- a/docs/reference.xml +++ b/docs/reference.xml @@ -354,7 +354,13 @@ Returns the length (in characters, including whitespace) of string S. - + + + + Output: 12 + + + @@ -496,6 +502,20 @@ + + + find client number (cn) + + + + + + + find player name + + + + Searches a list for a specified value. @@ -3440,6 +3460,22 @@ Output: Turns on or off the display of messages at the bottom of the screen. + + + Shows extra gameplay messages on certain events if connected to a server. + + + + + + + + + + + + + Turns on or off the display of spectator staus. @@ -3567,6 +3603,23 @@ Output: Sets the icon size of the players shown in the radar and the minimap. + + + colour of CN column in scoreboard + + + + + + + + + + + + + + @@ -5356,20 +5409,6 @@ Output: Find what media the map depends on, this is used for mediapack providers. - - find client number (cn) - - - - - - - find player name - - - - - At what char does the definition proceed? @@ -5480,11 +5519,6 @@ Output: - - colour of CN column in scoreboard - - - show the blood-spat overlay when receiving damage? @@ -5505,10 +5539,7 @@ Output: - - TODO - - + TODO