len0rd/Concord
1
0
Fork 0
mirror of https://github.com/Keyslam-Group/Concord.git synced 2025-09-01 11:53:57 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Regenerated docs

Browse source
This commit is contained in:
Josh Perry 2020-08-18 15:20:56 +01:00
parent 0897b1e4f9
commit 7979226c33
11 changed files with 387 additions and 430 deletions
Download patch file Download diff file Expand all files Collapse all files

106
docs/classes/Pool.html
View file

@ -33,13 +33,11 @@
<h2>Contents</h2>
<ul>
<li><a href="#Methods">Methods</a></li>
<li><a href="#Metamethods">Metamethods</a></li>
</ul>
<h2>Classes</h2>
<ul class="nowrap">
<li><a href="../classes/Assemblage.html">Assemblage</a></li>
<li><a href="../classes/Component.html">Component</a></li>
<li><a href="../classes/Entity.html">Entity</a></li>
<li><a href="../classes/List.html">List</a></li>
@ -49,13 +47,10 @@
</ul>
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="../modules/Assemblages.html">Assemblages</a></li>
<li><a href="../modules/Components.html">Components</a></li>
<li><a href="../modules/Concord.html">Concord</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/worlds.html">worlds</a></li>
</ul>
</div>
@ -75,6 +70,14 @@
<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="summary">Checks if an Entity is eligible for the Pool.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Pool:evaluate">Pool:evaluate (e)</a></td>
<td class="summary">Evaluate whether an Entity should be added or removed 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>
@ -87,13 +90,6 @@
<td class="summary">Callback for when an Entity is added to the Pool.</td>
</tr>
</table>
<h2><a href="#Metamethods">Metamethods</a></h2>
<table class="function_list">
<tr>
<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>
</table>
<br/>
<br/>
@ -132,6 +128,59 @@
</dd>
<dt>
<a name = "Pool:eligible"></a>
<strong>Pool:eligible (e)</strong>
</dt>
<dd>
Checks if an Entity is eligible for the Pool.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">e</span>
<span class="types"><a class="type" href="../classes/Entity.html#">Entity</a></span>
Entity to check
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">boolean</span></span>
</ol>
</dd>
<dt>
<a name = "Pool:evaluate"></a>
<strong>Pool:evaluate (e)</strong>
</dt>
<dd>
Evaluate whether an Entity should be added or removed from the Pool.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">e</span>
Entity to add or remove
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../classes/Pool.html#">Pool</a></span>
self
</ol>
</dd>
<dt>
<a name = "Pool:getName"></a>
@ -193,37 +242,6 @@
</dd>
</dl>
<h2 class="section-header "><a name="Metamethods"></a>Metamethods</h2>
<dl class="function">
<dt>
<a name = "Pool:__eligible"></a>
<strong>Pool:__eligible (e)</strong>
</dt>
<dd>
Checks if an Entity is eligible for the Pool.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">e</span>
<span class="types"><a class="type" href="../classes/Entity.html#">Entity</a></span>
Entity to check
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">boolean</span></span>
</ol>
</dd>
</dl>
@ -232,7 +250,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 2020-01-04 10:27:07 </i>
<i style="float:right;">Last updated 2020-08-18 15:20:32 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>