len0rd/Concord
1
0
Fork 0
mirror of https://github.com/Keyslam-Group/Concord.git synced 2025-09-01 20:03:55 -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

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>