<!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><strong>CharacterManager</strong></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>
<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>CharacterManager</code></h1>
<p>Singleton that provides character management utilities.</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="#CharacterManager.characterNameTaken">CharacterManager.characterNameTaken</a> (name)</td>
<td class="summary">Check if a character name is in use.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#CharacterManager.generateCharacterData">CharacterManager.generateCharacterData</a> (mob)</td>
<td class="summary">Get the XML format of a character.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#CharacterManager.getCharacterFileFromName">CharacterManager.getCharacterFileFromName</a> (name)</td>
<td class="summary">Get the character filename for a given name.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#CharacterManager.legalizeName">CharacterManager.legalizeName</a> (name)</td>
<td class="summary">Get the legalized name form of the given string.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#CharacterManager.loadCharacter">CharacterManager.loadCharacter</a> (name, mob)</td>
<td class="summary">Load a character into a mob.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#CharacterManager.readCharacterData">CharacterManager.readCharacterData</a> (xml, mob)</td>
<td class="summary">Read XML data into a mob's attributes.<br/> <b>I am not liking the Expat library.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#CharacterManager.saveCharacter">CharacterManager.saveCharacter</a> (mob)</td>
<td class="summary">Save a mob as a character.</td>
</tr>
</table>
<h2>Tables</h2>
<table class="table_list">
<tr>
<td class="name" nowrap><a href="#CharacterManager">CharacterManager</a></td>
<td class="summary">Singleton that provides character management utilities.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="functions"></a>Functions</h2>
<dl class="function">
<dt><a name="CharacterManager.characterNameTaken"></a><strong>CharacterManager.characterNameTaken</strong> (name)</dt>
<dd>
Check if a character name is in use.
<h3>Parameters:</h3>
<ul>
<li>
<code><em>name</em></code>: Name to check.
</li>
</ul>
<h3>Return value:</h3>
<ul>true if name is taken.<br/>false otherwise.</ul>
</dd>
<dt><a name="CharacterManager.generateCharacterData"></a><strong>CharacterManager.generateCharacterData</strong> (mob)</dt>
<dd>
Get the XML format of a character.
<h3>Parameters:</h3>
<ul>
<li>
<code><em>mob</em></code>: Mob of the character to generate data of.
</li>
</ul>
<h3>Return value:</h3>
<ul>The XML format of the character.</ul>
</dd>
<dt><a name="CharacterManager.getCharacterFileFromName"></a><strong>CharacterManager.getCharacterFileFromName</strong> (name)</dt>
<dd>
Get the character filename for a given name.
<h3>Parameters:</h3>
<ul>
<li>
<code><em>name</em></code>: Name of the character to generate a filename for.
</li>
</ul>
<h3>Return value:</h3>
<ul>Properly formatted filename for character based on its name.</ul>
</dd>
<dt><a name="CharacterManager.legalizeName"></a><strong>CharacterManager.legalizeName</strong> (name)</dt>
<dd>
Get the legalized name form of the given string.
<h3>Parameters:</h3>
<ul>
<li>
<code><em>name</em></code>: Name to be legalized.
</li>
</ul>
<h3>Return value:</h3>
<ul>The legalized name, or nil followed by an error message.</ul>
</dd>
<dt><a name="CharacterManager.loadCharacter"></a><strong>CharacterManager.loadCharacter</strong> (name, mob)</dt>
<dd>
Load a character into a mob.
<h3>Parameters:</h3>
<ul>
<li>
<code><em>name</em></code>: Name of the character to be loaded.
</li>
<li>
<code><em>mob</em></code>: The mob for character data to be read into.<br/>if nil, a new mob will be generated and returned.
</li>
</ul>
<h3>Return value:</h3>
<ul>The mob that data was read into.</ul>
</dd>
<dt><a name="CharacterManager.readCharacterData"></a><strong>CharacterManager.readCharacterData</strong> (xml, mob)</dt>
<dd>
Read XML data into a mob's attributes.<br/> <b>I am not liking the Expat library. I might switch to LuaXML.</b>
<h3>Parameters:</h3>
<ul>
<li>
<code><em>xml</em></code>: The XML to be read.
</li>
<li>
<code><em>mob</em></code>: Optional mob to read data into.<br/>If not specified, will return a new mob created with the XML data.
</li>
</ul>
<h3>Return value:</h3>
<ul>The mob that the data was applied to.</ul>
</dd>
<dt><a name="CharacterManager.saveCharacter"></a><strong>CharacterManager.saveCharacter</strong> (mob)</dt>
<dd>
Save a mob as a character.
<h3>Parameters:</h3>
<ul>
<li>
<code><em>mob</em></code>: Mob of the character to save.
</li>
</ul>
</dd>
</dl>
<h2><a name="tables"></a>Tables</h2>
<dl class="table">
<dt><a name="CharacterManager"></a><strong>CharacterManager</strong></dt>
<dd>Singleton that provides character management utilities.<br /><br />
<h3>Fields:</h3>
<ul>
<li>
<code><em>directory</em></code>: Where saves are stored.
</li>
<li>
<code><em>extension</em></code>: File extension for saves.
</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>