Deploying to gh-pages from @ Keyslam-Group/Concord@a80077276d 🚀

This commit is contained in:
pablomayobre 2023-02-15 01:21:05 +00:00
parent a09aa91a13
commit 2a34adcf0f
12 changed files with 523 additions and 125 deletions

View file

@ -40,8 +40,8 @@
<ul class="nowrap">
<li><a href="../classes/Component.html">Component</a></li>
<li><a href="../classes/Entity.html">Entity</a></li>
<li><a href="../classes/Filter.html">Filter</a></li>
<li><strong>List</strong></li>
<li><a href="../classes/Pool.html">Pool</a></li>
<li><a href="../classes/System.html">System</a></li>
<li><a href="../classes/World.html">World</a></li>
</ul>
@ -92,6 +92,18 @@
<td class="name" nowrap><a href="#List:indexOf">List:indexOf (obj)</a></td>
<td class="summary">Returns the index of an object in the List.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#List:sort">List:sort (order)</a></td>
<td class="summary">Sorts the List in place, using the order function.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#List:onAdded">List:onAdded (obj)</a></td>
<td class="summary">Callback for when an item is added to the List.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#List:onRemoved">List:onRemoved (obj)</a></td>
<td class="summary">Callback for when an item is removed to the List.</td>
</tr>
</table>
<br/>
@ -128,7 +140,7 @@
<dd>
Adds an object to the List.
Object must be of reference type
Object may not be the string 'size'
Object may not be the string 'size', 'onAdded' or 'onRemoved'
<h3>Parameters:</h3>
@ -272,6 +284,73 @@
</dd>
<dt>
<a name = "List:sort"></a>
<strong>List:sort (order)</strong>
</dt>
<dd>
Sorts the List in place, using the order function.
The order function is passed to table.sort internally so documentation on table.sort can be used as reference.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">order</span>
Function that takes two Entities (a and b) and returns true if a should go before than b.
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../classes/List.html#">List</a></span>
self
</ol>
</dd>
<dt>
<a name = "List:onAdded"></a>
<strong>List:onAdded (obj)</strong>
</dt>
<dd>
Callback for when an item is added to the List.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">obj</span>
Object that was added
</li>
</ul>
</dd>
<dt>
<a name = "List:onRemoved"></a>
<strong>List:onRemoved (obj)</strong>
</dt>
<dd>
Callback for when an item is removed to the List.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">obj</span>
Object that was removed
</li>
</ul>
</dd>
</dl>
@ -280,7 +359,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 2022-10-17 19:53:58 </i>
<i style="float:right;">Last updated 2023-02-15 01:21:04 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>