commands documentation update

git-svn-id: svn://svn.code.sf.net/p/actiongame/code/trunk/ac@3983 e016b1c5-ed68-44aa-a2f7-31cac88cffde
This commit is contained in:
Alejandro V. Garcia
2008-12-11 05:19:00 +00:00
parent e7fb664498
commit e1a63bac24
+119 -27
View File
@@ -996,17 +996,40 @@
</command>
<command name="idlebots">
<description>Enables or disables the processing of the bots artificial intelligence</description>
<arguments>
<argument token="Y" description="off OR on" valueNotes="0||1"/>
<argument token="T" description="off OR on" valueNotes="0||1"/>
</arguments>
<examples>
<example>
<code><![CDATA[idlebots 1]]></code>
<explanation>Will make the bots stand still.</explanation>
</example>
<example>
<code><![CDATA[idlebots 0]]></code>
<explanation>Will enable the bots to move and shoot.</explanation>
</example>
</examples>
</command>
<command name="kickallbots"/>
<command name="kickallbots">
<description>Kicks all bots out of the current game.</description>
<arguments>
<argument token="" description="this command does not take any arguments" valueNotes="none"/>
</arguments>
</command>
<command name="kickbot">
<arguments>
<argument token="N" description="botname"/>
</arguments>
<description>Kicks the bot with the given name out of the current game.</description>
<arguments>
<argument token="N" description="botname" valueNotes="name of the bot to kick."/>
</arguments>
<examples>
<example>
<code><![CDATA[kickbot Robbie]]></code>
<explanation>Will make the bot named "Robbie" dissapear from the current game.</explanation>
</example>
</examples>
</command>
<command name="lanconnect"/>
@@ -1024,41 +1047,100 @@
<command name="dropflag"/>
<command name="drawbeamtobots"/>
<command name="drawbeamtobots">
<description>Draws a shooting line in the direction of all available bots.</description>
<arguments>
<argument token="" description="this command does not take any arguments" valueNotes="none"/>
</arguments>
<remarks>
<remark>This is a debugging command and only works for single player modes.</remark>
</remarks>
</command>
<command name="crouch"/>
<command name="addbot">
<description>add a bot for a given team with a given skill calling him a given name.</description>
<arguments>
<argument token="T" description="team"/>
<argument token="S" description="skill" valueNotes="best,good,medium,worse OR bad"/>
<argument token="N" description="name"/>
</arguments>
<description>add a bot for a given team with a given skill calling him a given name.</description>
<arguments>
<argument token="T" description="team" valueNotes="RVSF or CLA"/>
<argument token="S" description="skill" valueNotes="best, good, medium, worse OR bad"/>
<argument token="N" description="name" valueNotes="name for the bot"/>
</arguments>
<remarks>
<remark>This command only works for single player modes.</remark>
</remarks>
<examples>
<example>
<code><![CDATA[addbot RVSF medium Robbie]]></code>
<explanation>Will add a bot named Robbie with a medium skill level to the RVSF team.</explanation>
</example>
</examples>
</command>
<command name="addnbot">
<description>will add a given count of bots for the given team with the given skill and select random names for them.</description>
<arguments>
<argument token="C" description="count"/>
<argument token="T" description="team"/>
<argument token="S" description="skill" valueNotes="best,good,medium,worse OR bad"/>
</arguments>
<description>will add a given count of bots for the given team with the given skill and select random names for them.</description>
<arguments>
<argument token="C" description="count" valueNotes="how many bots to add"/>
<argument token="T" description="team" valueNotes="RVSF or CLA"/>
<argument token="S" description="skill" valueNotes="best, good, medium, worse OR bad"/>
</arguments>
<remarks>
<remark>This command only works for single player modes.</remark>
<remark>The name of the bots will be selected randomly.</remark>
</remarks>
<examples>
<example>
<code><![CDATA[addnbot 2 CLA bad]]></code>
<explanation>Will add 2 bots with a bad skill level to the CLA team.</explanation>
</example>
</examples>
</command>
<command name="botskillall">
<argument token="S" description="botskill" valueNotes="best,good,medium,worse OR bad"/>
</command>
<command name="botskill">
<argument token="N" description="botname" valueNotes="the name of the bot"/>
<argument token="S" description="botskill" valueNotes="best,good,medium,worse OR bad"/>
<description>changes the skill level for the given bot.</description>
<arguments>
<argument token="N" description="botname" valueNotes="the name of the bot"/>
<argument token="S" description="botskill" valueNotes="best, good, medium, worse OR bad"/>
</arguments>
<examples>
<example>
<code><![CDATA[botskill Robbie best]]></code>
<explanation>Changes the previous bot skill level of the bot named Robbie to a 'best' skill level.</explanation>
</example>
</examples>
</command>
<command name="botskillall">
<description>changes the skill level for all bots.</description>
<arguments>
<argument token="S" description="botskill" valueNotes="best, good, medium, worse OR bad"/>
</arguments>
<examples>
<example>
<code><![CDATA[botskillall worse]]></code>
<explanation>Changes the previous bot skill level for all bots to a 'worse' skill level.</explanation>
</example>
</examples>
</command>
<command name="botsshoot">
<argument token="Y" description="shooting bots?" valueNotes="0||1"/>
<description>Enables or disables the ability of the bots to fire their weapons</description>
<arguments>
<argument token="T" description="shooting bots?" valueNotes="0||1"/>
</arguments>
<examples>
<example>
<code><![CDATA[botsshoot 0]]></code>
<explanation>Bots won't shoot.</explanation>
</example>
</examples>
</command>
<command name="changefollowplayer">
<argument token="D" description="delta" valueNotes="how many players to shift +/-"/>
<arguments>
<argument token="D" description="delta" valueNotes="how many players to shift +/-"/>
</arguments>
</command>
<command name="alive">
@@ -1675,11 +1757,21 @@ Output:
<description>takes the current player yaw for the current waypoint</description>
</command>
<command name="telebot"/>
<command name="telebot">
<description>teletransports the bot with the lowest connection number to you current position.</description>
<arguments>
<argument token="" description="this command does not take any arguments" valueNotes="none"/>
</arguments>
<remarks>
<remark>This is a debugging command and only works for single player modes.</remark>
</remarks>
</command>
<command name="togglebotview">
<description>When used you will see what the bot sees. Type it again (with or without name) to return to the game(you will respawn).</description>
<arguments>
<argument token="N" description="botname"/>
<argument token="N" description="botname" valueNotes="the name of the bot"/>
</arguments>
</command>
<command name="testvisible">