<!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><strong>PlayerState</strong></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>PlayerState</code></h1> <p>Singleton that contains enum-styled values for Player.state.</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="#PlayerState.name">PlayerState.name</a> (state)</td> <td class="summary">Allows for quick reference to PlayerState.names enums.</td> </tr> </table> <h2>Tables</h2> <table class="table_list"> <tr> <td class="name" nowrap><a href="#PlayerState">PlayerState</a></td> <td class="summary">Singleton that contains enum-styled values for Player.state.</td> </tr> <tr> <td class="name" nowrap><a href="#PlayerState.names">PlayerState.names</a></td> <td class="summary">Contains textual representations of PlayerState enums.</td> </tr> </table> <br/> <br/> <h2><a name="functions"></a>Functions</h2> <dl class="function"> <dt><a name="PlayerState.name"></a><strong>PlayerState.name</strong> (state)</dt> <dd> Allows for quick reference to PlayerState.names enums. <h3>Parameters:</h3> <ul> <li> <code><em>state</em></code>: The state to retrieve the name of. </li> </ul> <h3>Return value:</h3> <ul>Name of the state.</ul> </dd> </dl> <h2><a name="tables"></a>Tables</h2> <dl class="table"> <dt><a name="PlayerState"></a><strong>PlayerState</strong></dt> <dd>Singleton that contains enum-styled values for Player.state.<br /><br /> <h3>Fields:</h3> <ul> <li> <code><em>NEW</em></code>: Player has just been connected. </li> <li> <code><em>DISCONNECTING</em></code>: Player is in the process of disconnecting. </li> <li> <code><em>NAME</em></code>: Retreiving a name to be used by the player. </li> <li> <code><em>NEW_CHAR_NAME_CONFIRM</em></code>: Confirming they wish to use this name to create a new character. </li> <li> <code><em>NEW_CHAR_PASSWORD</em></code>: Asking for a password for their new character. </li> <li> <code><em>NEW_CHAR_PASSWORD_CONFIRM</em></code>: Asking to confirm their password. </li> <li> <code><em>LOAD_CHAR_PASSWORD</em></code>: Asking for the password for an existent character. </li> <li> <code><em>MOTD</em></code>: Getting the MOTD. </li> <li> <code><em>PLAYING</em></code>: Playing the game. </li> </ul> </dd> <dt><a name="PlayerState.names"></a><strong>PlayerState.names</strong></dt> <dd>Contains textual representations of PlayerState enums.<br /><br /> <h3>Fields:</h3> <ul> <li> <code><em>PlayerState.NEW</em></code>: "new" </li> <li> <code><em>PlayerState.DISCONNECTING</em></code>: "disconnecting" </li> <li> <code><em>PlayerState.NAME</em></code>: "name" </li> <li> <code><em>PlayerState.NEW_CHAR_NAME_CONFIRM</em></code>: "(new char) name confirm" </li> <li> <code><em>PlayerState.NEW_CHAR_PASSWORD</em></code>: "(new char) password" </li> <li> <code><em>PlayerState.NEW_CHAR_PASSWORD_CONFIRM</em></code>: "(new char) password confirm" </li> <li> <code><em>PlayerState.LOAD_CHAR_PASSWORD</em></code>: "(load char) password" </li> <li> <code><em>PlayerState.MOTD</em></code>: "MOTD" </li> <li> <code><em>PlayerState.PLAYING</em></code>: "PLAYING" </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>