len0rd/Concord
1
0
Fork 0
mirror of https://github.com/Keyslam-Group/Concord.git synced 2025-09-02 12:24:11 -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

6
docs/classes/Component.html
View file

@ -38,7 +38,6 @@
<h2>Classes</h2>
<ul class="nowrap">
<li><a href="../classes/Assemblage.html">Assemblage</a></li>
<li><strong>Component</strong></li>
<li><a href="../classes/Entity.html">Entity</a></li>
<li><a href="../classes/List.html">List</a></li>
@ -48,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>
@ -163,7 +159,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>

15
docs/classes/Entity.html
View file

@ -38,7 +38,6 @@
<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><strong>Entity</strong></li>
<li><a href="../classes/List.html">List</a></li>
@ -48,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>
@ -64,8 +60,7 @@
<h1>Class <code>Entity</code></h1>
<p>An object that exists in a world.</p>
<p> An entity
contains components which are processed by systems.
</p>
contains components which are processed by systems.</p>
<h2><a href="#Methods">Methods</a></h2>
@ -251,11 +246,11 @@
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">assemblage</span>
<span class="types"><a class="type" href="../classes/Assemblage.html#">Assemblage</a></span>
Assemblage to assemble with
<span class="types"><span class="type">function</span></span>
Function that will assemble an entity
</li>
<li><span class="parameter">...</span>
additional arguments to pass to the Assemblage's assemble function.
additional arguments to pass to the assemblage function.
</li>
</ul>
@ -413,7 +408,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>

186
docs/classes/List.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><strong>List</strong></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>
@ -74,6 +69,18 @@
<td class="summary">Creates a new List.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#List:add">List:add (obj)</a></td>
<td class="summary">Adds an object to the List.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#List:remove">List:remove (obj)</a></td>
<td class="summary">Removes an object from the List.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#List:clear">List:clear ()</a></td>
<td class="summary">Clears the List completely.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#List:has">List:has (obj)</a></td>
<td class="summary">Returns true if the List has the object.</td>
</tr>
@ -86,21 +93,6 @@
<td class="summary">Returns the index of an object in the List.</td>
</tr>
</table>
<h2><a href="#Metamethods">Metamethods</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#List:__add">List:__add (obj)</a></td>
<td class="summary">Adds an object to the List.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#List:__remove">List:__remove (obj)</a></td>
<td class="summary">Removes an object from the List.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#List:__clear">List:__clear ()</a></td>
<td class="summary">Clears the List completely.</td>
</tr>
</table>
<br/>
<br/>
@ -128,6 +120,80 @@
</dd>
<dt>
<a name = "List:add"></a>
<strong>List:add (obj)</strong>
</dt>
<dd>
Adds an object to the List.
Object must be of reference type
Object may not be the string 'size'
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">obj</span>
Object to add
</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:remove"></a>
<strong>List:remove (obj)</strong>
</dt>
<dd>
Removes an object from the List.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">obj</span>
Object to remove
</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:clear"></a>
<strong>List:clear ()</strong>
</dt>
<dd>
Clears the List completely.
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../classes/List.html#">List</a></span>
self
</ol>
</dd>
<dt>
<a name = "List:has"></a>
@ -206,84 +272,6 @@
</dd>
</dl>
<h2 class="section-header "><a name="Metamethods"></a>Metamethods</h2>
<dl class="function">
<dt>
<a name = "List:__add"></a>
<strong>List:__add (obj)</strong>
</dt>
<dd>
Adds an object to the List.
Object must be of reference type
Object may not be the string 'size'
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">obj</span>
Object to add
</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:__remove"></a>
<strong>List:__remove (obj)</strong>
</dt>
<dd>
Removes an object from the List.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">obj</span>
Object to remove
</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:__clear"></a>
<strong>List:__clear ()</strong>
</dt>
<dd>
Clears the List completely.
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../classes/List.html#">List</a></span>
self
</ol>
</dd>
</dl>
@ -292,7 +280,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>

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>

89
docs/classes/System.html
View file

@ -39,7 +39,6 @@
<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 +48,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>
@ -66,29 +62,16 @@
<p>Iterates over Entities.</p>
<p> From these Entities its get Components and modify them.
A System contains 1 or more Pools.
A System is contained by 1 World.
</p>
A System is contained by 1 World.</p>
<h2><a href="#Methods">Methods</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#System:new">System:new (...)</a></td>
<td class="name" nowrap><a href="#System:new">System:new (table)</a></td>
<td class="summary">Creates a new SystemClass.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#System:enable">System:enable ()</a></td>
<td class="summary">Enables the System.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#System:disable">System:disable ()</a></td>
<td class="summary">Disables the System.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#System:toggleEnabled">System:toggleEnabled ()</a></td>
<td class="summary">Toggles if the System is enabled.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#System:setEnabled">System:setEnabled (enable)</a></td>
<td class="summary">Sets if the System is enabled</td>
</tr>
@ -134,7 +117,7 @@
<dl class="function">
<dt>
<a name = "System:new"></a>
<strong>System:new (...)</strong>
<strong>System:new (table)</strong>
</dt>
<dd>
Creates a new SystemClass.
@ -142,8 +125,8 @@
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">...</span>
Variable amounts of filters
<li><span class="parameter">table</span>
filters A table containing filters (name = {components...})
</li>
</ul>
@ -157,66 +140,6 @@
</dd>
<dt>
<a name = "System:enable"></a>
<strong>System:enable ()</strong>
</dt>
<dd>
Enables the System.
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../classes/System.html#">System</a></span>
self
</ol>
</dd>
<dt>
<a name = "System:disable"></a>
<strong>System:disable ()</strong>
</dt>
<dd>
Disables the System.
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../classes/System.html#">System</a></span>
self
</ol>
</dd>
<dt>
<a name = "System:toggleEnabled"></a>
<strong>System:toggleEnabled ()</strong>
</dt>
<dd>
Toggles if the System is enabled.
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../classes/System.html#">System</a></span>
self
</ol>
</dd>
<dt>
<a name = "System:setEnabled"></a>
@ -385,7 +308,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>

9
docs/classes/World.html
View file

@ -38,7 +38,6 @@
<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>
@ -48,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>
@ -66,8 +62,7 @@
<p>
A world emits to let Systems iterate.
A World contains any amount of Systems.
A World contains any amount of Entities.
</p>
A World contains any amount of Entities.</p>
<h2><a href="#Methods">Methods</a></h2>
@ -466,7 +461,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>

23
docs/index.html
View file

@ -31,17 +31,13 @@
<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>
<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>
@ -59,10 +55,6 @@
<h2>Modules</h2>
<table class="module_list">
<tr>
<td class="name" nowrap><a href="modules/Assemblages.html">Assemblages</a></td>
<td class="summary">A container for registered <a href="classes/Assemblage.html#">Assemblage</a>s</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/Components.html">Components</a></td>
<td class="summary">Container for registered ComponentClasses</td>
@ -71,10 +63,6 @@
<td class="name" nowrap><a href="modules/Concord.html">Concord</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/Systems.html">Systems</a></td>
<td class="summary">Container for registered SystemClasses</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/type.html">type</a></td>
<td class="summary">Type
@ -85,18 +73,9 @@
<td class="summary">Utils
Helper module for misc operations</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/worlds.html">worlds</a></td>
<td class="summary">Worlds
Container for registered Worlds</td>
</tr>
</table>
<h2>Classes</h2>
<table class="module_list">
<tr>
<td class="name" nowrap><a href="classes/Assemblage.html">Assemblage</a></td>
<td class="summary">Gives an entity a set of components.</td>
</tr>
<tr>
<td class="name" nowrap><a href="classes/Component.html">Component</a></td>
<td class="summary">A pure data container that is contained by a single entity.</td>
@ -128,7 +107,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>

185
docs/modules/Components.html Normal file
View file

@ -0,0 +1,185 @@
<!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><strong>Components</strong></li>
<li><a href="../modules/Concord.html">Concord</a></li>
<li><a href="../modules/type.html">type</a></li>
<li><a href="../modules/utils.html">utils</a></li>
</ul>
<h2>Classes</h2>
<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/List.html">List</a></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>
</div>
<div id="content">
<h1>Module <code>Components</code></h1>
<p>Container for registered ComponentClasses</p>
<p></p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#has">has (name)</a></td>
<td class="summary">Returns true if the containter has the ComponentClass with the specified name</td>
</tr>
<tr>
<td class="name" nowrap><a href="#try">try (name)</a></td>
<td class="summary">Returns true and the ComponentClass if one was registered with the specified name
or false and an error otherwise</td>
</tr>
<tr>
<td class="name" nowrap><a href="#get">get (name)</a></td>
<td class="summary">Returns the ComponentClass with the specified name</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "has"></a>
<strong>has (name)</strong>
</dt>
<dd>
Returns true if the containter has the ComponentClass with the specified name
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">name</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
Name of the ComponentClass to check
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">boolean</span></span>
</ol>
</dd>
<dt>
<a name = "try"></a>
<strong>try (name)</strong>
</dt>
<dd>
Returns true and the ComponentClass if one was registered with the specified name
or false and an error otherwise
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">name</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
Name of the ComponentClass to check
</li>
</ul>
<h3>Returns:</h3>
<ol>
<li>
<span class="types"><span class="type">boolean</span></span>
</li>
<li>
<span class="types"><a class="type" href="../classes/Component.html#">Component</a></span>
or error string</li>
</ol>
</dd>
<dt>
<a name = "get"></a>
<strong>get (name)</strong>
</dt>
<dd>
Returns the ComponentClass with the specified name
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">name</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
Name of the ComponentClass to get
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../classes/Component.html#">Component</a></span>
</ol>
</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-08-18 15:20:32 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>

121
docs/modules/Concord.html
View file

@ -30,25 +30,17 @@
<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/Assemblages.html">Assemblages</a></li>
<li><a href="../modules/Components.html">Components</a></li>
<li><strong>Concord</strong></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>
<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>
@ -66,129 +58,18 @@
<p></p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#loadComponents">loadComponents (pathOrFiles)</a></td>
<td class="summary">Loads ComponentClasses and puts them in the Components container.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#loadSystems">loadSystems (pathOrFiles)</a></td>
<td class="summary">Loads SystemClasses and puts them in the Systems container.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#loadWorlds">loadWorlds (pathOrFiles)</a></td>
<td class="summary">Loads Worlds and puts them in the Worlds container.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#loadAssemblages">loadAssemblages (pathOrFiles)</a></td>
<td class="summary">Loads Assemblages and puts them in the Assemblages container.</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "loadComponents"></a>
<strong>loadComponents (pathOrFiles)</strong>
</dt>
<dd>
Loads ComponentClasses and puts them in the Components container.
Accepts a table of paths to files: {"component_1", "component_2", "etc"}
Accepts a path to a directory with ComponentClasses: "components"
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">pathOrFiles</span>
</li>
</ul>
</dd>
<dt>
<a name = "loadSystems"></a>
<strong>loadSystems (pathOrFiles)</strong>
</dt>
<dd>
Loads SystemClasses and puts them in the Systems container.
Accepts a table of paths to files: {"system_1", "system_2", "etc"}
Accepts a path to a directory with SystemClasses: "systems"
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">pathOrFiles</span>
</li>
</ul>
</dd>
<dt>
<a name = "loadWorlds"></a>
<strong>loadWorlds (pathOrFiles)</strong>
</dt>
<dd>
Loads Worlds and puts them in the Worlds container.
Accepts a table of paths to files: {"world_1", "world_2", "etc"}
Accepts a path to a directory with Worlds: "worlds"
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">pathOrFiles</span>
</li>
</ul>
</dd>
<dt>
<a name = "loadAssemblages"></a>
<strong>loadAssemblages (pathOrFiles)</strong>
</dt>
<dd>
Loads Assemblages and puts them in the Assemblages container.
Accepts a table of paths to files: {"assemblage_1", "assemblage_2", "etc"}
Accepts a path to a directory with Assemblages: "assemblages"
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">pathOrFiles</span>
</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 10:27:07 </i>
<i style="float:right;">Last updated 2020-08-18 15:20:32 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

36
docs/modules/type.html
View file

@ -38,17 +38,13 @@
<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><strong>type</strong></li>
<li><a href="../modules/utils.html">utils</a></li>
<li><a href="../modules/worlds.html">worlds</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>
@ -93,10 +89,6 @@
<td class="name" nowrap><a href="#Type.isWorld">Type.isWorld (t)</a></td>
<td class="summary">Returns if object is a World.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Type.isAssemblage">Type.isAssemblage (t)</a></td>
<td class="summary">Returns if object is an Assemblage.</td>
</tr>
</table>
<br/>
@ -261,32 +253,6 @@
</dd>
<dt>
<a name = "Type.isAssemblage"></a>
<strong>Type.isAssemblage (t)</strong>
</dt>
<dd>
Returns if object is an Assemblage.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">t</span>
Object to check
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">boolean</span></span>
</ol>
</dd>
</dl>
@ -295,7 +261,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>

41
docs/modules/utils.html
View file

@ -38,17 +38,13 @@
<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><strong>utils</strong></li>
<li><a href="../modules/worlds.html">worlds</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>
@ -73,6 +69,10 @@
<td class="name" nowrap><a href="#Utils.shallowCopy">Utils.shallowCopy (orig, target)</a></td>
<td class="summary">Does a shallow copy of a table and appends it to a target table.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Utils.loadNamespace">Utils.loadNamespace (pathOrFiles, namespace)</a></td>
<td class="summary">Requires files and puts them in a table.</td>
</tr>
</table>
<br/>
@ -104,6 +104,37 @@
</dd>
<dt>
<a name = "Utils.loadNamespace"></a>
<strong>Utils.loadNamespace (pathOrFiles, namespace)</strong>
</dt>
<dd>
Requires files and puts them in a table.
Accepts a table of paths to Lua files: {"path/to/file_1", "path/to/another/file_2", "etc"}
Accepts a path to a directory with Lua files: "my_files/here"
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">pathOrFiles</span>
The table of paths or a path to a directory.
</li>
<li><span class="parameter">namespace</span>
A table that will hold the required files
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
The namespace table
</ol>
</dd>
</dl>
@ -112,7 +143,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>