<!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><strong>Telnet</strong></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>Telnet</code></h1>
<p>Singleton that contains all telnet-specific data and operations.</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="#Telnet.MSSP.name">Telnet.MSSP.name</a> (option)</td>
<td class="summary">Allows for quick reference to Telnet.MSSP.names values.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Telnet.MSSP.nameAll">Telnet.MSSP.nameAll</a> (option)</td>
<td class="summary">Returns a string with every Telnet.MSSP value in the given string, separated by commas.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Telnet.command.name">Telnet.command.name</a> (option)</td>
<td class="summary">Allows for quick reference to Telnet.command.names values.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Telnet.command.nameAll">Telnet.command.nameAll</a> (option)</td>
<td class="summary">Returns a string with every Telnet.command value in the given string, separated by commas.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Telnet.environment.name">Telnet.environment.name</a> (option)</td>
<td class="summary">Allows for quick reference to Telnet.environment.names values.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Telnet.environment.nameAll">Telnet.environment.nameAll</a> (option)</td>
<td class="summary">Returns a string with every Telnet.environment value in the given string, separated by commas.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Telnet.protocol.name">Telnet.protocol.name</a> (option)</td>
<td class="summary">Allows for quick reference to Telnet.protocol.names values.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Telnet.protocol.nameAll">Telnet.protocol.nameAll</a> (option)</td>
<td class="summary">Returns a string with every Telnet.protocol value in the given string, separated by commas.</td>
</tr>
</table>
<h2>Tables</h2>
<table class="table_list">
<tr>
<td class="name" nowrap><a href="#Telnet">Telnet</a></td>
<td class="summary">Singleton that contains all telnet-specific data and operations.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Telnet.MSSP">Telnet.MSSP</a></td>
<td class="summary">Contains MSSP options.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Telnet.MSSP.names">Telnet.MSSP.names</a></td>
<td class="summary">Contains textual representations of Telnet.MSSP values.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Telnet.command">Telnet.command</a></td>
<td class="summary">Contains telnet command options.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Telnet.command.names">Telnet.command.names</a></td>
<td class="summary">Contains textual representations of Telnet.command values.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Telnet.environment">Telnet.environment</a></td>
<td class="summary">Contains environment options.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Telnet.environment.names">Telnet.environment.names</a></td>
<td class="summary">Contains textual representations of Telnet.environment values.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Telnet.protocol">Telnet.protocol</a></td>
<td class="summary">Contains telnet protocol options.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Telnet.protocol.names">Telnet.protocol.names</a></td>
<td class="summary">Contains textual representations of Telnet.protocol values.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="functions"></a>Functions</h2>
<dl class="function">
<dt><a name="Telnet.MSSP.name"></a><strong>Telnet.MSSP.name</strong> (option)</dt>
<dd>
Allows for quick reference to Telnet.MSSP.names values.
<h3>Parameters:</h3>
<ul>
<li>
<code><em>option</em></code>: The option to retrieve the name of.
</li>
</ul>
<h3>Return value:</h3>
<ul>Name of the option.</ul>
</dd>
<dt><a name="Telnet.MSSP.nameAll"></a><strong>Telnet.MSSP.nameAll</strong> (option)</dt>
<dd>
Returns a string with every Telnet.MSSP value in the given string, separated by commas.
<h3>Parameters:</h3>
<ul>
<li>
<code><em>option</em></code>: The string to be named.
</li>
</ul>
<h3>Return value:</h3>
<ul>Formatted string of all option names.</ul>
</dd>
<dt><a name="Telnet.command.name"></a><strong>Telnet.command.name</strong> (option)</dt>
<dd>
Allows for quick reference to Telnet.command.names values.
<h3>Parameters:</h3>
<ul>
<li>
<code><em>option</em></code>: The option to retrieve the name of.
</li>
</ul>
<h3>Return value:</h3>
<ul>Name of the option.</ul>
</dd>
<dt><a name="Telnet.command.nameAll"></a><strong>Telnet.command.nameAll</strong> (option)</dt>
<dd>
Returns a string with every Telnet.command value in the given string, separated by commas.
<h3>Parameters:</h3>
<ul>
<li>
<code><em>option</em></code>: The string to be named.
</li>
</ul>
<h3>Return value:</h3>
<ul>Formatted string of all option names.</ul>
</dd>
<dt><a name="Telnet.environment.name"></a><strong>Telnet.environment.name</strong> (option)</dt>
<dd>
Allows for quick reference to Telnet.environment.names values.
<h3>Parameters:</h3>
<ul>
<li>
<code><em>option</em></code>: The option to retrieve the name of.
</li>
</ul>
<h3>Return value:</h3>
<ul>Name of the option.</ul>
</dd>
<dt><a name="Telnet.environment.nameAll"></a><strong>Telnet.environment.nameAll</strong> (option)</dt>
<dd>
Returns a string with every Telnet.environment value in the given string, separated by commas.
<h3>Parameters:</h3>
<ul>
<li>
<code><em>option</em></code>: The string to be named.
</li>
</ul>
<h3>Return value:</h3>
<ul>Formatted string of all option names.</ul>
</dd>
<dt><a name="Telnet.protocol.name"></a><strong>Telnet.protocol.name</strong> (option)</dt>
<dd>
Allows for quick reference to Telnet.protocol.names values.
<h3>Parameters:</h3>
<ul>
<li>
<code><em>option</em></code>: The option to retrieve the name of.
</li>
</ul>
<h3>Return value:</h3>
<ul>Name of the option.</ul>
</dd>
<dt><a name="Telnet.protocol.nameAll"></a><strong>Telnet.protocol.nameAll</strong> (option)</dt>
<dd>
Returns a string with every Telnet.protocol value in the given string, separated by commas.
<h3>Parameters:</h3>
<ul>
<li>
<code><em>option</em></code>: The string to be named.
</li>
</ul>
<h3>Return value:</h3>
<ul>Formatted string of all option names.</ul>
</dd>
</dl>
<h2><a name="tables"></a>Tables</h2>
<dl class="table">
<dt><a name="Telnet"></a><strong>Telnet</strong></dt>
<dd>Singleton that contains all telnet-specific data and operations.<br /><br />
</dd>
<dt><a name="Telnet.MSSP"></a><strong>Telnet.MSSP</strong></dt>
<dd>Contains MSSP options.<br /><br />
<h3>Fields:</h3>
<ul>
<li>
<code><em>VAL</em></code>: 2
</li>
<li>
<code><em>VAR</em></code>: 1
</li>
</ul>
</dd>
<dt><a name="Telnet.MSSP.names"></a><strong>Telnet.MSSP.names</strong></dt>
<dd>Contains textual representations of Telnet.MSSP values.<br /><br />
<h3>Fields:</h3>
<ul>
<li>
<code><em>Telnet.options.VAL</em></code>: "VAL"
</li>
<li>
<code><em>Telnet.options.VAR</em></code>: "VAR"
</li>
</ul>
</dd>
<dt><a name="Telnet.command"></a><strong>Telnet.command</strong></dt>
<dd>Contains telnet command options.<br /><br />
<h3>Fields:</h3>
<ul>
<li>
<code><em>IAC</em></code>: 255
</li>
<li>
<code><em>DONT</em></code>: 254
</li>
<li>
<code><em>DO</em></code>: 253
</li>
<li>
<code><em>WONT</em></code>: 252
</li>
<li>
<code><em>WILL</em></code>: 251
</li>
<li>
<code><em>SB</em></code>: 250
</li>
<li>
<code><em>GA</em></code>: 249
</li>
<li>
<code><em>EL</em></code>: 248
</li>
<li>
<code><em>EC</em></code>: 247
</li>
<li>
<code><em>SE</em></code>: 240
</li>
<li>
<code><em>EOR</em></code>: 239
</li>
<li>
<code><em>ABORT</em></code>: 238
</li>
<li>
<code><em>SUSP</em></code>: 237
</li>
<li>
<code><em>xEOF</em></code>: 236
</li>
</ul>
</dd>
<dt><a name="Telnet.command.names"></a><strong>Telnet.command.names</strong></dt>
<dd>Contains textual representations of Telnet.command values.<br /><br />
<h3>Fields:</h3>
<ul>
<li>
<code><em>Telnet.command.IAC</em></code>: "IAC"
</li>
<li>
<code><em>Telnet.command.DONT</em></code>: "DONT"
</li>
<li>
<code><em>Telnet.command.DO</em></code>: "DO"
</li>
<li>
<code><em>Telnet.command.WONT</em></code>: "WONT"
</li>
<li>
<code><em>Telnet.command.WILL</em></code>: "WILL"
</li>
<li>
<code><em>Telnet.command.SB</em></code>: "SB"
</li>
<li>
<code><em>Telnet.command.GA</em></code>: "GA"
</li>
<li>
<code><em>Telnet.command.EL</em></code>: "EL"
</li>
<li>
<code><em>Telnet.command.EC</em></code>: "EC"
</li>
<li>
<code><em>Telnet.command.SE</em></code>: "SE"
</li>
<li>
<code><em>Telnet.command.EOR</em></code>: "EOR"
</li>
<li>
<code><em>Telnet.command.ABORT</em></code>: "ABORT"
</li>
<li>
<code><em>Telnet.command.SUSP</em></code>: "SUSP"
</li>
<li>
<code><em>Telnet.command.xEOF</em></code>: "xEOF"
</li>
</ul>
</dd>
<dt><a name="Telnet.environment"></a><strong>Telnet.environment</strong></dt>
<dd>Contains environment options.<br /><br />
<h3>Fields:</h3>
<ul>
<li>
<code><em>SEND</em></code>: 1
</li>
<li>
<code><em>IS</em></code>: 0
</li>
</ul>
</dd>
<dt><a name="Telnet.environment.names"></a><strong>Telnet.environment.names</strong></dt>
<dd>Contains textual representations of Telnet.environment values.<br /><br />
<h3>Fields:</h3>
<ul>
<li>
<code><em>Telnet.environment.SEND</em></code>: "SEND"
</li>
<li>
<code><em>Telnet.environment.IS</em></code>: "IS"
</li>
</ul>
</dd>
<dt><a name="Telnet.protocol"></a><strong>Telnet.protocol</strong></dt>
<dd>Contains telnet protocol options.<br /><br />
<h3>Fields:</h3>
<ul>
<li>
<code><em>MCCP</em></code>: 85
</li>
<li>
<code><em>MCCP2</em></code>: 86
</li>
<li>
<code><em>MSSP</em></code>: 70
</li>
<li>
<code><em>MSDP</em></code>: 69
</li>
<li>
<code><em>TTYPE</em></code>: 24
</li>
</ul>
</dd>
<dt><a name="Telnet.protocol.names"></a><strong>Telnet.protocol.names</strong></dt>
<dd>Contains textual representations of Telnet.protocol values.<br /><br />
<h3>Fields:</h3>
<ul>
<li>
<code><em>Telnet.protocol.MCCP</em></code>: "MCCP"
</li>
<li>
<code><em>Telnet.protocol.MCCP2</em></code>: "MCCP2"
</li>
<li>
<code><em>Telnet.protocol.MSSP</em></code>: "MSSP"
</li>
<li>
<code><em>Telnet.protocol.MSDP</em></code>: "MSDP"
</li>
<li>
<code><em>Telnet.protocol.TTYPE</em></code>: "TTYPE"
</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>