Publish regenerated LDoc pages

This commit is contained in:
Tjakka5 2020-01-04 01:54:21 +01:00
parent 58d9e44bb1
commit 0e1023d2ce
16 changed files with 2283 additions and 805 deletions

View file

@ -38,13 +38,20 @@
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="../modules/assemblage.html">assemblage</a></li>
<li><a href="../modules/assemblages.html">assemblages</a></li>
<li><a href="../modules/component.html">component</a></li>
<li><a href="../modules/components.html">components</a></li>
<li><a href="../modules/entity.html">entity</a></li>
<li><a href="../modules/init.html">init</a></li>
<li><a href="../modules/instance.html">instance</a></li>
<li><a href="../modules/list.html">list</a></li>
<li><strong>pool</strong></li>
<li><a href="../modules/system.html">system</a></li>
<li><a href="../modules/systems.html">systems</a></li>
<li><a href="../modules/type.html">type</a></li>
<li><a href="../modules/utils.html">utils</a></li>
<li><a href="../modules/world.html">world</a></li>
<li><a href="../modules/worlds.html">worlds</a></li>
</ul>
</div>
@ -52,7 +59,9 @@
<div id="content">
<h1>Module <code>pool</code></h1>
<p>Pool</p>
<p>Pool
A Pool is used to iterate over Entities with a specific Components
A Pool contain a any amount of Entities.</p>
<p></p>
@ -63,9 +72,29 @@
<td class="summary">Creates a new Pool</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Pool:eligible">Pool:eligible (e)</a></td>
<td class="name" nowrap><a href="#Pool:__eligible">Pool:__eligible (e)</a></td>
<td class="summary">Checks if an Entity is eligible for the Pool.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Pool:__add">Pool:__add (e)</a></td>
<td class="summary">Internal: Adds an Entity to the Pool.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Pool:__remove">Pool:__remove (e)</a></td>
<td class="summary">Internal: Removed an Entity from the Pool.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Pool:getName">Pool:getName ()</a></td>
<td class="summary">Gets the name of the Pool</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Pool:getFilter">Pool:getFilter ()</a></td>
<td class="summary">Gets the filter of the Pool.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Pool:onEntityAdded">Pool:onEntityAdded (e)</a></td>
<td class="summary">Callback for when an Entity is added to the Pool.</td>
</tr>
</table>
<br/>
@ -86,10 +115,10 @@
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">name</span>
Identifier for the Pool.
Name for the Pool.
</li>
<li><span class="parameter">filter</span>
Table containing the required Components
Table containing the required BaseComponents
</li>
</ul>
@ -104,8 +133,8 @@
</dd>
<dt>
<a name = "Pool:eligible"></a>
<strong>Pool:eligible (e)</strong>
<a name = "Pool:__eligible"></a>
<strong>Pool:__eligible (e)</strong>
</dt>
<dd>
Checks if an Entity is eligible for the Pool.
@ -114,7 +143,7 @@
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">e</span>
The Entity to check
Entity to check
</li>
</ul>
@ -127,6 +156,115 @@
</dd>
<dt>
<a name = "Pool:__add"></a>
<strong>Pool:__add (e)</strong>
</dt>
<dd>
Internal: Adds an Entity to the Pool.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">e</span>
Entity to add
</li>
</ul>
<h3>Returns:</h3>
<ol>
self
</ol>
</dd>
<dt>
<a name = "Pool:__remove"></a>
<strong>Pool:__remove (e)</strong>
</dt>
<dd>
Internal: Removed an Entity from the Pool.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">e</span>
Entity to remove
</li>
</ul>
<h3>Returns:</h3>
<ol>
self
</ol>
</dd>
<dt>
<a name = "Pool:getName"></a>
<strong>Pool:getName ()</strong>
</dt>
<dd>
Gets the name of the Pool
<h3>Returns:</h3>
<ol>
Name of the Pool.
</ol>
</dd>
<dt>
<a name = "Pool:getFilter"></a>
<strong>Pool:getFilter ()</strong>
</dt>
<dd>
Gets the filter of the Pool.
Warning: Do not modify this filter.
<h3>Returns:</h3>
<ol>
Filter of the Pool.
</ol>
</dd>
<dt>
<a name = "Pool:onEntityAdded"></a>
<strong>Pool:onEntityAdded (e)</strong>
</dt>
<dd>
Callback for when an Entity is added to the Pool.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">e</span>
Entity that was added.
</li>
</ul>
</dd>
</dl>
@ -135,7 +273,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2018-09-25 18:42:43 </i>
<i style="float:right;">Last updated 2020-01-04 00:43:06 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>