doc updates
git-svn-id: svn://svn.code.sf.net/p/actiongame/code/trunk/ac@6172 e016b1c5-ed68-44aa-a2f7-31cac88cffde
This commit is contained in:
Bukz
+11
-10
@@ -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];
|
||||
|
||||
+55
-24
@@ -354,7 +354,13 @@
|
||||
|
||||
<command name="strlen">
|
||||
<description>Returns the length (in characters, including whitespace) of string S.</description>
|
||||
<arguments>
|
||||
<examples>
|
||||
<example>
|
||||
<code><![CDATA[echo (strlen "Hello world!")]]></code>
|
||||
<explanation>Output: 12</explanation>
|
||||
</example>
|
||||
</examples>
|
||||
<arguments>
|
||||
<argument token="S" description="STRING"/>
|
||||
</arguments>
|
||||
<references>
|
||||
@@ -496,6 +502,20 @@
|
||||
<argument token="L" description="the list"/>
|
||||
</arguments>
|
||||
</command>
|
||||
|
||||
<command name="findcn">
|
||||
<description>find client number (cn)</description>
|
||||
<arguments>
|
||||
<argument token="N" description="NAME"/>
|
||||
</arguments>
|
||||
</command>
|
||||
|
||||
<command name="findpn">
|
||||
<description>find player name</description>
|
||||
<arguments>
|
||||
<argument token="C" description="CLIENTNUM"/>
|
||||
</arguments>
|
||||
</command>
|
||||
|
||||
<command name="findlist">
|
||||
<description>Searches a list for a specified value.</description>
|
||||
@@ -3440,6 +3460,22 @@ Output:
|
||||
<description>Turns on or off the display of messages at the bottom of the screen.</description>
|
||||
<value token="V" description="enable/disable messages" minValue="0" maxValue="1" defaultValue="0"/>
|
||||
</variable>
|
||||
|
||||
<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"/>
|
||||
<arguments>
|
||||
<argument valueNotes="0 (off)"/>
|
||||
<argument valueNotes="1 (show extra messages in the console)"/>
|
||||
<argument valueNotes="2 (show extra messages in the console and on the HUD)"/>
|
||||
<argument valueNotes="3 (SPAM extra messages in the console and on the HUD)"/>
|
||||
</arguments>
|
||||
<references>
|
||||
<identifierReference identifier="consize"/>
|
||||
<identifierReference identifier="hideconsole"/>
|
||||
<identifierReference identifier="hidehudmsgs"/>
|
||||
</references>
|
||||
</variable>
|
||||
|
||||
<variable name="hidespecthud">
|
||||
<description>Turns on or off the display of spectator staus.</description>
|
||||
@@ -3567,6 +3603,23 @@ Output:
|
||||
<description>Sets the icon size of the players shown in the radar and the minimap.</description>
|
||||
<value token="V" description="size of icons inside radar" minValue="1" maxValue="64" defaultValue="4"/>
|
||||
</variable>
|
||||
|
||||
<variable name="cncolumncolor">
|
||||
<description>colour of CN column in scoreboard</description>
|
||||
<value token="N" description="TODO" minValue="0" maxValue="9" defaultValue="5" />
|
||||
<arguments>
|
||||
<argument valueNotes="0 (green)"/>
|
||||
<argument valueNotes="1 (blue)"/>
|
||||
<argument valueNotes="2 (yellow)"/>
|
||||
<argument valueNotes="3 (red)"/>
|
||||
<argument valueNotes="4 (gray)"/>
|
||||
<argument valueNotes="5 (white, default)"/>
|
||||
<argument valueNotes="6 (dark brown)"/>
|
||||
<argument valueNotes="7 (dark red)"/>
|
||||
<argument valueNotes="8 (purple)"/>
|
||||
<argument valueNotes="9 (orange)"/>
|
||||
</arguments>
|
||||
</variable>
|
||||
|
||||
</identifiers>
|
||||
</section>
|
||||
@@ -5356,20 +5409,6 @@ Output:
|
||||
<description>Find what media the map depends on, this is used for mediapack providers.</description>
|
||||
</command>
|
||||
|
||||
<command name="findcn">
|
||||
<description>find client number (cn)</description>
|
||||
<arguments>
|
||||
<argument token="N" description="NAME"/>
|
||||
</arguments>
|
||||
</command>
|
||||
|
||||
<command name="findpn">
|
||||
<description>find player name</description>
|
||||
<arguments>
|
||||
<argument token="C" description="CLIENTNUM"/>
|
||||
</arguments>
|
||||
</command>
|
||||
|
||||
<command name="fontskip">
|
||||
<description>At what char does the definition proceed?</description>
|
||||
<arguments>
|
||||
@@ -5480,11 +5519,6 @@ Output:
|
||||
<value token="N" description="TODO" minValue="0" maxValue="1" defaultValue="0" />
|
||||
</variable>
|
||||
|
||||
<variable name="cncolumncolor">
|
||||
<description>colour of CN column in scoreboard</description>
|
||||
<value token="N" description="TODO" minValue="0" maxValue="9" defaultValue="5" />
|
||||
</variable>
|
||||
|
||||
<variable name="damagescreen">
|
||||
<description>show the blood-spat overlay when receiving damage?</description>
|
||||
<value token="N" description="TODO" minValue="0" maxValue="1" defaultValue="1" />
|
||||
@@ -5505,10 +5539,7 @@ Output:
|
||||
<value token="N" description="TODO" minValue="0" maxValue="1000" defaultValue="125" />
|
||||
</variable>
|
||||
|
||||
<variable name="hudextras">
|
||||
<description>TODO</description>
|
||||
<value token="N" description="TODO" minValue="0" maxValue="3" defaultValue="0" />
|
||||
</variable>
|
||||
|
||||
|
||||
<variable name="interms">
|
||||
<description>TODO</description>
|
||||
|
||||
Reference in New Issue
Block a user