<!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><strong>obj.Command</strong></li>
<li>
<a href="../modules/obj.CommandParser.html">obj.CommandParser</a>
</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.Command</code></h1>
<p>Cloneable that is used to handle text commands.</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="#Command:execute">Command:execute</a> (player, mob)</td>
<td class="summary">Execute the command by the given player/mob pair.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Command:match">Command:match</a> (player, mob, input)</td>
<td class="summary">Verify that the given input can/will trigger this Command.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Command:parse">Command:parse</a> (player, mob, input)</td>
<td class="summary">Parses a string and runs the Command with necessary arguments.</td>
</tr>
</table>
<h2>Tables</h2>
<table class="table_list">
<tr>
<td class="name" nowrap><a href="#Command">Command</a></td>
<td class="summary">Cloneable that is used to handle text commands.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="functions"></a>Functions</h2>
<dl class="function">
<dt><a name="Command:execute"></a><strong>Command:execute</strong> (player, mob)</dt>
<dd>
Execute the command by the given player/mob pair.
<h3>Parameters:</h3>
<ul>
<li>
<code><em>player</em></code>: Player running the command
</li>
<li>
<code><em>mob</em></code>: Mob running the command.
</li>
</ul>
</dd>
<dt><a name="Command:match"></a><strong>Command:match</strong> (player, mob, input)</dt>
<dd>
Verify that the given input can/will trigger this Command.
<h3>Parameters:</h3>
<ul>
<li>
<code><em>player</em></code>:
</li>
<li>
<code><em>mob</em></code>:
</li>
<li>
<code><em>input</em></code>:
</li>
</ul>
<h3>Return value:</h3>
<ul>true on success.<br/>false otherwise.</ul>
</dd>
<dt><a name="Command:parse"></a><strong>Command:parse</strong> (player, mob, input)</dt>
<dd>
Parses a string and runs the Command with necessary arguments.
<h3>Parameters:</h3>
<ul>
<li>
<code><em>player</em></code>: Player running the command
</li>
<li>
<code><em>mob</em></code>: Mob running the command.
</li>
<li>
<code><em>input</em></code>: Input to be parsed.
</li>
</ul>
</dd>
</dl>
<h2><a name="tables"></a>Tables</h2>
<dl class="table">
<dt><a name="Command"></a><strong>Command</strong></dt>
<dd>Cloneable that is used to handle text commands.<br /><br />
<h3>Fields:</h3>
<ul>
<li>
<code><em>keyword</em></code>: Keyword for the Cloneable.
</li>
</ul>
</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>