<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<title>Reference</title>
<link rel="stylesheet" href="../luadoc.css" type="text/css" />
<!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div> <!-- id="product" -->
<div id="main">
<div id="navigation">
<h1>LuaDoc</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<!-- Module list -->
<h1>Modules</h1>
<ul>
<li>
<a href="../modules/CharacterManager.html">CharacterManager</a>
</li>
<li>
<a href="../modules/Direction.html">Direction</a>
</li>
<li>
<a href="../modules/Game.html">Game</a>
</li>
<li>
<a href="../modules/GameState.html">GameState</a>
</li>
<li>
<a href="../modules/MessageMode.html">MessageMode</a>
</li>
<li>
<a href="../modules/Nanny.html">Nanny</a>
</li>
<li>
<a href="../modules/PlayerState.html">PlayerState</a>
</li>
<li>
<a href="../modules/Telnet.html">Telnet</a>
</li>
<li>
<a href="../modules/config.html">config</a>
</li>
<li>
<a href="../modules/ext.string.html">ext.string</a>
</li>
<li>
<a href="../modules/ext.table.html">ext.table</a>
</li>
<li>
<a href="../modules/main.html">main</a>
</li>
<li>
<a href="../modules/obj.Client.html">obj.Client</a>
</li>
<li>
<a href="../modules/obj.Cloneable.html">obj.Cloneable</a>
</li>
<li>
<a href="../modules/obj.Command.html">obj.Command</a>
</li>
<li><strong>obj.CommandParser</strong></li>
<li>
<a href="../modules/obj.Event.html">obj.Event</a>
</li>
<li>
<a href="../modules/obj.Map.html">obj.Map</a>
</li>
<li>
<a href="../modules/obj.MapObject.html">obj.MapObject</a>
</li>
<li>
<a href="../modules/obj.MapTile.html">obj.MapTile</a>
</li>
<li>
<a href="../modules/obj.Mob.html">obj.Mob</a>
</li>
<li>
<a href="../modules/obj.Player.html">obj.Player</a>
</li>
<li>
<a href="../modules/obj.Scheduler.html">obj.Scheduler</a>
</li>
<li>
<a href="../modules/obj.Server.html">obj.Server</a>
</li>
</ul>
<!-- File list -->
</div><!-- id="navigation" -->
<div id="content">
<h1>Module <code>obj.CommandParser</code></h1>
<p>Cloneable that parses commands on behalf of a player.</p>
<p><b>Author:</b>
<table class="authors_list">
<tr><td class="name">milkmanjack</td></tr>
</table>
</p>
<h2>Functions</h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#CommandParser:addCommand">CommandParser:addCommand</a> (command)</td>
<td class="summary">Adds a Command to the list of commands we recognize.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#CommandParser:getCommands">CommandParser:getCommands</a> ()</td>
<td class="summary">Return the Commands this parser sorts through.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#CommandParser:initialize">CommandParser:initialize</a> ()</td>
<td class="summary">Creates a unique commands table per CommandParser.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#CommandParser:parse">CommandParser:parse</a> (player, mob, input)</td>
<td class="summary">Parses command input with a player as an assumed source.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#CommandParser:removeCommand">CommandParser:removeCommand</a> (command)</td>
<td class="summary">Remove a Command from the list of commands we recognize.</td>
</tr>
</table>
<h2>Tables</h2>
<table class="table_list">
<tr>
<td class="name" nowrap><a href="#CommandParser">CommandParser</a></td>
<td class="summary">Cloneable that parses commands on behalf of a player.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#CommandParser.commands">CommandParser.commands</a></td>
<td class="summary">List of all commands we recognized.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="functions"></a>Functions</h2>
<dl class="function">
<dt><a name="CommandParser:addCommand"></a><strong>CommandParser:addCommand</strong> (command)</dt>
<dd>
Adds a Command to the list of commands we recognize.
<h3>Parameters:</h3>
<ul>
<li>
<code><em>command</em></code>: Command to be added.
</li>
</ul>
</dd>
<dt><a name="CommandParser:getCommands"></a><strong>CommandParser:getCommands</strong> ()</dt>
<dd>
Return the Commands this parser sorts through.
<h3>Return value:</h3>
<ul>List of Commands.</ul>
</dd>
<dt><a name="CommandParser:initialize"></a><strong>CommandParser:initialize</strong> ()</dt>
<dd>
Creates a unique commands table per CommandParser.
</dd>
<dt><a name="CommandParser:parse"></a><strong>CommandParser:parse</strong> (player, mob, input)</dt>
<dd>
Parses command input with a player as an assumed source.
<h3>Parameters:</h3>
<ul>
<li>
<code><em>player</em></code>: Player to be treated as the source of the input.
</li>
<li>
<code><em>mob</em></code>: Mob of the Player being treated as the source of the input.
</li>
<li>
<code><em>input</em></code>:
</li>
</ul>
<h3>Return value:</h3>
<ul>true on successful command match.<br/>false otherwise.</ul>
</dd>
<dt><a name="CommandParser:removeCommand"></a><strong>CommandParser:removeCommand</strong> (command)</dt>
<dd>
Remove a Command from the list of commands we recognize.
<h3>Parameters:</h3>
<ul>
<li>
<code><em>command</em></code>: Command to be removed.
</li>
</ul>
</dd>
</dl>
<h2><a name="tables"></a>Tables</h2>
<dl class="table">
<dt><a name="CommandParser"></a><strong>CommandParser</strong></dt>
<dd>Cloneable that parses commands on behalf of a player.<br /><br />
</dd>
<dt><a name="CommandParser.commands"></a><strong>CommandParser.commands</strong></dt>
<dd>List of all commands we recognized.<br /><br />
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>