Skip to content

Commit

Permalink
Update version
Browse files Browse the repository at this point in the history
This will be version 3.0 of Concord
  • Loading branch information
pablomayobre committed Jan 9, 2021
1 parent 1325c4b commit eb82c3c
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 208 deletions.
2 changes: 1 addition & 1 deletion concord/init.lua
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
local PATH = (...):gsub('%.init$', '')

local Concord = {
_VERSION = "2.0 Beta",
_VERSION = "3.0",
_DESCRIPTION = "A feature-complete ECS library",
_LICENCE = [[
MIT LICENSE
Expand Down
185 changes: 0 additions & 185 deletions docs/modules/Components.html

This file was deleted.

47 changes: 25 additions & 22 deletions docs/modules/components.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,17 +38,13 @@ <h2>Contents</h2>

<h2>Modules</h2>
<ul class="nowrap">
<li><a href="../modules/Assemblages.html">Assemblages</a></li>
<li><strong>Components</strong></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>
Expand All @@ -68,13 +64,14 @@ <h1>Module <code>Components</code></h1>

<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#register">register (name, componentClass)</a></td>
<td class="summary">Registers a ComponentClass.</td>
</tr>
<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>
Expand All @@ -90,36 +87,39 @@ <h2 class="section-header "><a name="Functions"></a>Functions</h2>

<dl class="function">
<dt>
<a name = "register"></a>
<strong>register (name, componentClass)</strong>
<a name = "has"></a>
<strong>has (name)</strong>
</dt>
<dd>
Registers a ComponentClass.
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 to register under
</li>
<li><span class="parameter">componentClass</span>
<span class="types"><a class="type" href="../classes/Component.html#">Component</a></span>
ComponentClass to register
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 = "has"></a>
<strong>has (name)</strong>
<a name = "try"></a>
<strong>try (name)</strong>
</dt>
<dd>
Returns true if the containter has the ComponentClass with the specified name
Returns true and the ComponentClass if one was registered with the specified name
or false and an error otherwise


<h3>Parameters:</h3>
Expand All @@ -132,9 +132,12 @@ <h3>Parameters:</h3>

<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>


Expand Down Expand Up @@ -175,7 +178,7 @@ <h3>Returns:</h3>
</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>
Expand Down

0 comments on commit eb82c3c

Please sign in to comment.