mirror of
https://github.com/Keyslam-Group/Concord.git
synced 2025-09-02 12:24:11 -04:00
make the docs a little nicer
main changes: - add parameter and return types where applicable - use @module and @classmod tags at the top of files - remove some redundant descriptions of return values, especially for functions that return a boolean recommended next steps: - more consistent grammar - add links to classes and functions in descriptions where appropriate - be consistent about naming Systems vs. SystemClasses and Components vs. ComponentClasses
This commit is contained in:
Andrew Minnich
parent
55ae5fd987
commit
a65f88dd5e
31 changed files with 1474 additions and 1147 deletions
|
|
@ -1,280 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<head>
|
||||
<title>Reference</title>
|
||||
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
|
||||
</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">
|
||||
|
||||
|
||||
<!-- Menu -->
|
||||
|
||||
<div id="navigation">
|
||||
<br/>
|
||||
<h1>Concord</h1>
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#Functions">Functions</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<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/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>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>pool</code></h1>
|
||||
<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>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Pool.new">Pool.new (name, filter)</a></td>
|
||||
<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:__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/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Pool.new"></a>
|
||||
<strong>Pool.new (name, filter)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates a new Pool
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
Name for the Pool.
|
||||
</li>
|
||||
<li><span class="parameter">filter</span>
|
||||
Table containing the required BaseComponents
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
The new Pool
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
Entity to check
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
True if the entity is eligible, false otherwise
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</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 00:43:06 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Add table
Add a link
Reference in a new issue