<!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> <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><strong>obj.Player</strong></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.Player</code></h1> <p>Cloneable that handles relationships between Clients and Mobs.</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="#Player:askQuestion">Player:askQuestion</a> (msg)</td> <td class="summary">shortcut to sendMessage() that provides the MessageMode.QUESTION mode, followed by no linebreak.</td> </tr> <tr> <td class="name" nowrap><a href="#Player:clearMessageMode">Player:clearMessageMode</a> ()</td> <td class="summary">Reset messageMode to nil.</td> </tr> <tr> <td class="name" nowrap><a href="#Player:getClient">Player:getClient</a> ()</td> <td class="summary">Gets current Client.</td> </tr> <tr> <td class="name" nowrap><a href="#Player:getID">Player:getID</a> ()</td> <td class="summary">Gets current ID.</td> </tr> <tr> <td class="name" nowrap><a href="#Player:getMessageMode">Player:getMessageMode</a> ()</td> <td class="summary">Get message mode.</td> </tr> <tr> <td class="name" nowrap><a href="#Player:getMob">Player:getMob</a> ()</td> <td class="summary">Gets current Mob.</td> </tr> <tr> <td class="name" nowrap><a href="#Player:getState">Player:getState</a> ()</td> <td class="summary">Gets current state.</td> </tr> <tr> <td class="name" nowrap><a href="#Player:initialize">Player:initialize</a> (client)</td> <td class="summary">Initialize the Player and associated it with the given Client.</td> </tr> <tr> <td class="name" nowrap><a href="#Player:send">Player:send</a> (data, i, j)</td> <td class="summary">shortcut to client:send(data,i,j).</td> </tr> <tr> <td class="name" nowrap><a href="#Player:sendLine">Player:sendLine</a> (str)</td> <td class="summary">shortcut to client:sendLine(str).</td> </tr> <tr> <td class="name" nowrap><a href="#Player:sendMessage">Player:sendMessage</a> (msg, mode, autobreak)</td> <td class="summary">Sends a message to the Player.</td> </tr> <tr> <td class="name" nowrap><a href="#Player:sendString">Player:sendString</a> (str)</td> <td class="summary">shortcut to client:sendMessage(str).</td> </tr> <tr> <td class="name" nowrap><a href="#Player:setClient">Player:setClient</a> (client)</td> <td class="summary">Associate this Player with the given Client.</td> </tr> <tr> <td class="name" nowrap><a href="#Player:setID">Player:setID</a> (id)</td> <td class="summary">Set ID.</td> </tr> <tr> <td class="name" nowrap><a href="#Player:setMessageMode">Player:setMessageMode</a> (mode)</td> <td class="summary">Set message mode.</td> </tr> <tr> <td class="name" nowrap><a href="#Player:setMob">Player:setMob</a> (mob)</td> <td class="summary">Associate this Player with the given Mob.</td> </tr> <tr> <td class="name" nowrap><a href="#Player:setState">Player:setState</a> (state)</td> <td class="summary">Set state.</td> </tr> <tr> <td class="name" nowrap><a href="#Player:toString">Player:toString</a> ()</td> <td class="summary">Returns the string-value of the Player.</td> </tr> <tr> <td class="name" nowrap><a href="#Player:unsetClient">Player:unsetClient</a> ()</td> <td class="summary">De-associate this Player from current Client.</td> </tr> <tr> <td class="name" nowrap><a href="#Player:unsetMob">Player:unsetMob</a> ()</td> <td class="summary">De-associate this Player from current Mob.</td> </tr> </table> <h2>Tables</h2> <table class="table_list"> <tr> <td class="name" nowrap><a href="#Player">Player</a></td> <td class="summary">Cloneable that handles relationships between Clients and Mobs.</td> </tr> </table> <br/> <br/> <h2><a name="functions"></a>Functions</h2> <dl class="function"> <dt><a name="Player:askQuestion"></a><strong>Player:askQuestion</strong> (msg)</dt> <dd> shortcut to sendMessage() that provides the MessageMode.QUESTION mode, followed by no linebreak. <h3>Parameters:</h3> <ul> <li> <code><em>msg</em></code>: </li> </ul> </dd> <dt><a name="Player:clearMessageMode"></a><strong>Player:clearMessageMode</strong> ()</dt> <dd> Reset messageMode to nil. </dd> <dt><a name="Player:getClient"></a><strong>Player:getClient</strong> ()</dt> <dd> Gets current Client. <h3>Return value:</h3> <ul>Current Client.</ul> </dd> <dt><a name="Player:getID"></a><strong>Player:getID</strong> ()</dt> <dd> Gets current ID. <h3>Return value:</h3> <ul>Current ID.</ul> </dd> <dt><a name="Player:getMessageMode"></a><strong>Player:getMessageMode</strong> ()</dt> <dd> Get message mode. <h3>Return value:</h3> <ul>Current message mode. Always a member of the MessageMode table.</ul> </dd> <dt><a name="Player:getMob"></a><strong>Player:getMob</strong> ()</dt> <dd> Gets current Mob. <h3>Return value:</h3> <ul>Current Mob, if any.</ul> </dd> <dt><a name="Player:getState"></a><strong>Player:getState</strong> ()</dt> <dd> Gets current state. <h3>Return value:</h3> <ul>Current state. Always a member of the PlayerState table.</ul> </dd> <dt><a name="Player:initialize"></a><strong>Player:initialize</strong> (client)</dt> <dd> Initialize the Player and associated it with the given Client. <h3>Parameters:</h3> <ul> <li> <code><em>client</em></code>: Client to be associated with this Player. </li> </ul> </dd> <dt><a name="Player:send"></a><strong>Player:send</strong> (data, i, j)</dt> <dd> shortcut to client:send(data,i,j). <h3>Parameters:</h3> <ul> <li> <code><em>data</em></code>: </li> <li> <code><em>i</em></code>: </li> <li> <code><em>j</em></code>: </li> </ul> </dd> <dt><a name="Player:sendLine"></a><strong>Player:sendLine</strong> (str)</dt> <dd> shortcut to client:sendLine(str). <h3>Parameters:</h3> <ul> <li> <code><em>str</em></code>: </li> </ul> </dd> <dt><a name="Player:sendMessage"></a><strong>Player:sendMessage</strong> (msg, mode, autobreak)</dt> <dd> Sends a message to the Player. <h3>Parameters:</h3> <ul> <li> <code><em>msg</em></code>: The message to send. </li> <li> <code><em>mode</em></code>: The mode of the message. Always a member of the MessageMode table. </li> <li> <code><em>autobreak</em></code>: If true (default), the message is followed by a linefeed. Always a member of the MessageMode table. </li> </ul> </dd> <dt><a name="Player:sendString"></a><strong>Player:sendString</strong> (str)</dt> <dd> shortcut to client:sendMessage(str). <h3>Parameters:</h3> <ul> <li> <code><em>str</em></code>: </li> </ul> </dd> <dt><a name="Player:setClient"></a><strong>Player:setClient</strong> (client)</dt> <dd> Associate this Player with the given Client. <h3>Parameters:</h3> <ul> <li> <code><em>client</em></code>: Client to be associated. </li> </ul> </dd> <dt><a name="Player:setID"></a><strong>Player:setID</strong> (id)</dt> <dd> Set ID. <h3>Parameters:</h3> <ul> <li> <code><em>id</em></code>: The ID to set. </li> </ul> </dd> <dt><a name="Player:setMessageMode"></a><strong>Player:setMessageMode</strong> (mode)</dt> <dd> Set message mode. <h3>Parameters:</h3> <ul> <li> <code><em>mode</em></code>: The mode to assign. Always a member of the MessageMode table. </li> </ul> </dd> <dt><a name="Player:setMob"></a><strong>Player:setMob</strong> (mob)</dt> <dd> Associate this Player with the given Mob. A Player's Mob shares a mututal reference with the Player, so when the Player's Mob changes, so does the Mob's Player. <h3>Parameters:</h3> <ul> <li> <code><em>mob</em></code>: The mob to assign. </li> </ul> </dd> <dt><a name="Player:setState"></a><strong>Player:setState</strong> (state)</dt> <dd> Set state. <h3>Parameters:</h3> <ul> <li> <code><em>state</em></code>: The state to set. </li> </ul> </dd> <dt><a name="Player:toString"></a><strong>Player:toString</strong> ()</dt> <dd> Returns the string-value of the Player. <h3>Return value:</h3> <ul>A string in the format of <tt>"player#<id>{@<client remote address>}"</tt>.</ul> </dd> <dt><a name="Player:unsetClient"></a><strong>Player:unsetClient</strong> ()</dt> <dd> De-associate this Player from current Client. </dd> <dt><a name="Player:unsetMob"></a><strong>Player:unsetMob</strong> ()</dt> <dd> De-associate this Player from current Mob. </dd> </dl> <h2><a name="tables"></a>Tables</h2> <dl class="table"> <dt><a name="Player"></a><strong>Player</strong></dt> <dd>Cloneable that handles relationships between Clients and Mobs.<br /><br /> <h3>Fields:</h3> <ul> <li> <code><em>id</em></code>: Our unique ID. </li> <li> <code><em>state</em></code>: Current state. Always a member of the PlayerState table. </li> <li> <code><em>client</em></code>: The Client we are associated with. </li> <li> <code><em>mob</em></code>: The Mob we are associated with. </li> <li> <code><em>messageMode</em></code>: Our message mode. Always a member of the MessageMode table. </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>