<!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><strong>Direction</strong></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> <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>Direction</code></h1> <p>Singleton that contains enum-styled values for directional movement.</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="#Direction.name">Direction.name</a> (state)</td> <td class="summary">Allows for quick reference Direction.names enums.</td> </tr> <tr> <td class="name" nowrap><a href="#Direction.reverse">Direction.reverse</a> (direction)</td> <td class="summary">Reverses the given direction.</td> </tr> </table> <h2>Tables</h2> <table class="table_list"> <tr> <td class="name" nowrap><a href="#Direction">Direction</a></td> <td class="summary">Singleton that contains enum-styled values for directional movement.</td> </tr> <tr> <td class="name" nowrap><a href="#Direction.names">Direction.names</a></td> <td class="summary">Contains textual representations of Direction enums.</td> </tr> </table> <br/> <br/> <h2><a name="functions"></a>Functions</h2> <dl class="function"> <dt><a name="Direction.name"></a><strong>Direction.name</strong> (state)</dt> <dd> Allows for quick reference Direction.names enums. <h3>Parameters:</h3> <ul> <li> <code><em>state</em></code>: The direction to retrieve the name of. </li> </ul> <h3>Return value:</h3> <ul>Name of the direction.</ul> </dd> <dt><a name="Direction.reverse"></a><strong>Direction.reverse</strong> (direction)</dt> <dd> Reverses the given direction. <h3>Parameters:</h3> <ul> <li> <code><em>direction</em></code>: Direction to reverse. </li> </ul> <h3>Return value:</h3> <ul>The reverse of the given direction.</ul> </dd> </dl> <h2><a name="tables"></a>Tables</h2> <dl class="table"> <dt><a name="Direction"></a><strong>Direction</strong></dt> <dd>Singleton that contains enum-styled values for directional movement.<br /><br /> <h3>Fields:</h3> <ul> <li> <code><em>NORTH</em></code>: North. </li> <li> <code><em>SOUTH</em></code>: South. </li> <li> <code><em>EAST</em></code>: East. </li> <li> <code><em>WEST</em></code>: West. </li> <li> <code><em>NORTHEAST</em></code>: Northeast. </li> <li> <code><em>NORTHWEST</em></code>: Northwest. </li> <li> <code><em>SOUTHEAST</em></code>: Southeast. </li> <li> <code><em>SOUTHWEST</em></code>: Southwest. </li> </ul> </dd> <dt><a name="Direction.names"></a><strong>Direction.names</strong></dt> <dd>Contains textual representations of Direction enums.<br /><br /> <h3>Fields:</h3> <ul> <li> <code><em>Direction.NORTH</em></code>: "north" </li> <li> <code><em>Direction.SOUTH</em></code>: "south" </li> <li> <code><em>Direction.EAST</em></code>: "east" </li> <li> <code><em>Direction.WEST</em></code>: "west" </li> <li> <code><em>Direction.NORTHEAST</em></code>: "northeast" </li> <li> <code><em>Direction.NORTHWEST</em></code>: "northwest" </li> <li> <code><em>Direction.SOUTHEAST</em></code>: "southeast" </li> <li> <code><em>DIRECTION.SOUTHWEST</em></code>: "southwest" </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>