<!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>
<a href="../modules/obj.Player.html">obj.Player</a>
</li>
<li><strong>obj.Scheduler</strong></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.Scheduler</code></h1>
<p>Cloneable that processes fireable events.</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="#Scheduler:clear">Scheduler:clear</a> ()</td>
<td class="summary">Empties the Scheduler.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Scheduler:dequeue">Scheduler:dequeue</a> (event)</td>
<td class="summary">Remove an event from the queue.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Scheduler:initialize">Scheduler:initialize</a> ()</td>
<td class="summary">Creates a unique events table for each Scheduler.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Scheduler:isReady">Scheduler:isReady</a> (timestamp)</td>
<td class="summary">Check if there are any Events ready to fire.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Scheduler:isWaiting">Scheduler:isWaiting</a> ()</td>
<td class="summary">Check if the Scheduler has Events waiting.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Scheduler:poll">Scheduler:poll</a> (timestamp)</td>
<td class="summary">Polls the Scheduler for Events waiting to fire.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Scheduler:queue">Scheduler:queue</a> (event)</td>
<td class="summary">Add an Event to the queue.</td>
</tr>
</table>
<h2>Tables</h2>
<table class="table_list">
<tr>
<td class="name" nowrap><a href="#Scheduler">Scheduler</a></td>
<td class="summary">Cloneable that processes fireable Events.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Scheduler.events">Scheduler.events</a></td>
<td class="summary">Contains all of the Events a Scheduler has scheduled.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="functions"></a>Functions</h2>
<dl class="function">
<dt><a name="Scheduler:clear"></a><strong>Scheduler:clear</strong> ()</dt>
<dd>
Empties the Scheduler.
</dd>
<dt><a name="Scheduler:dequeue"></a><strong>Scheduler:dequeue</strong> (event)</dt>
<dd>
Remove an event from the queue.
<h3>Parameters:</h3>
<ul>
<li>
<code><em>event</em></code>: The even to deque.
</li>
</ul>
</dd>
<dt><a name="Scheduler:initialize"></a><strong>Scheduler:initialize</strong> ()</dt>
<dd>
Creates a unique events table for each Scheduler.
</dd>
<dt><a name="Scheduler:isReady"></a><strong>Scheduler:isReady</strong> (timestamp)</dt>
<dd>
Check if there are any Events ready to fire.
<h3>Parameters:</h3>
<ul>
<li>
<code><em>timestamp</em></code>: This is the current timestamp to compare to the destination timestamps.
</li>
</ul>
<h3>Return value:</h3>
<ul>true if an Event is waiting to fire.<br/>false otherwise.</ul>
</dd>
<dt><a name="Scheduler:isWaiting"></a><strong>Scheduler:isWaiting</strong> ()</dt>
<dd>
Check if the Scheduler has Events waiting.
<h3>Return value:</h3>
<ul>true if an Event is waiting.<br/> false otherwise.</ul>
</dd>
<dt><a name="Scheduler:poll"></a><strong>Scheduler:poll</strong> (timestamp)</dt>
<dd>
Polls the Scheduler for Events waiting to fire.
<h3>Parameters:</h3>
<ul>
<li>
<code><em>timestamp</em></code>: This is the current timestamp to compare to the destination timestamps.
</li>
</ul>
</dd>
<dt><a name="Scheduler:queue"></a><strong>Scheduler:queue</strong> (event)</dt>
<dd>
Add an Event to the queue.
<h3>Parameters:</h3>
<ul>
<li>
<code><em>event</em></code>: The Event to queue.
</li>
</ul>
</dd>
</dl>
<h2><a name="tables"></a>Tables</h2>
<dl class="table">
<dt><a name="Scheduler"></a><strong>Scheduler</strong></dt>
<dd>Cloneable that processes fireable Events.<br /><br />
</dd>
<dt><a name="Scheduler.events"></a><strong>Scheduler.events</strong></dt>
<dd>Contains all of the Events a Scheduler has scheduled.<br /><br />
</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>