<!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><strong>obj.MapTile</strong></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>obj.MapTile</code></h1>
<p>Cloneable:MapObject that represents the lowest-level MapObject location on a Map.</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="#MapTile:getLoc">MapTile:getLoc</a> ()</td>
<td class="summary">MapTiles cannot inhabit any other MapObject, so this simply returns self.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#MapTile:getX">MapTile:getX</a> ()</td>
<td class="summary">Get current x location.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#MapTile:getY">MapTile:getY</a> ()</td>
<td class="summary">Get current y location.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#MapTile:getZ">MapTile:getZ</a> ()</td>
<td class="summary">Get current z location.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#MapTile:initialize">MapTile:initialize</a> (map, x, y, z)</td>
<td class="summary">Creates a unique contents table per MapObject.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#MapTile:setXYZLoc">MapTile:setXYZLoc</a> (x, y, z)</td>
<td class="summary">Assigns a complete XYZ location.</td>
</tr>
</table>
<h2>Tables</h2>
<table class="table_list">
<tr>
<td class="name" nowrap><a href="#MapTile">MapTile</a></td>
<td class="summary">Cloneable:MapObject that represents the lowest-level MapObject location on a Map.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="functions"></a>Functions</h2>
<dl class="function">
<dt><a name="MapTile:getLoc"></a><strong>MapTile:getLoc</strong> ()</dt>
<dd>
MapTiles cannot inhabit any other MapObject, so this simply returns self.
<h3>Return value:</h3>
<ul>self</ul>
</dd>
<dt><a name="MapTile:getX"></a><strong>MapTile:getX</strong> ()</dt>
<dd>
Get current x location.
<h3>Return value:</h3>
<ul>Current x location.</ul>
</dd>
<dt><a name="MapTile:getY"></a><strong>MapTile:getY</strong> ()</dt>
<dd>
Get current y location.
<h3>Return value:</h3>
<ul>Current y location.</ul>
</dd>
<dt><a name="MapTile:getZ"></a><strong>MapTile:getZ</strong> ()</dt>
<dd>
Get current z location.
<h3>Return value:</h3>
<ul>Current z location.</ul>
</dd>
<dt><a name="MapTile:initialize"></a><strong>MapTile:initialize</strong> (map, x, y, z)</dt>
<dd>
Creates a unique contents table per MapObject. Also has the potential to assign a Map and XYZ location.
<h3>Parameters:</h3>
<ul>
<li>
<code><em>map</em></code>: Map to be moved to.
</li>
<li>
<code><em>x</em></code>: X loc to be assigned.
</li>
<li>
<code><em>y</em></code>: Y loc to be assigned.
</li>
<li>
<code><em>z</em></code>: Z loc to be assigned.
</li>
</ul>
</dd>
<dt><a name="MapTile:setXYZLoc"></a><strong>MapTile:setXYZLoc</strong> (x, y, z)</dt>
<dd>
Assigns a complete XYZ location.
<h3>Parameters:</h3>
<ul>
<li>
<code><em>x</em></code>: X location to set.
</li>
<li>
<code><em>y</em></code>: Y location to set.
</li>
<li>
<code><em>z</em></code>: Z location to set.
</li>
</ul>
</dd>
</dl>
<h2><a name="tables"></a>Tables</h2>
<dl class="table">
<dt><a name="MapTile"></a><strong>MapTile</strong></dt>
<dd>Cloneable:MapObject that represents the lowest-level MapObject location on a Map.<br /><br />
<h3>Fields:</h3>
<ul>
<li>
<code><em>name</em></code>: Name of the MapTile.
</li>
<li>
<code><em>description</em></code>: Complete description of the MapTile.
</li>
<li>
<code><em>x</em></code>: X location.
</li>
<li>
<code><em>y</em></code>: Y location.
</li>
<li>
<code><em>z</em></code>: Z location.
</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>