mirror of
https://github.com/Keyslam-Group/Concord.git
synced 2025-08-20 21:38:29 -04:00
Update version
This will be version 3.0 of Concord
This commit is contained in:
Pablo Ariel Mayobre
parent
1325c4b445
commit
eb82c3c580
3 changed files with 38 additions and 220 deletions
|
|
@ -4,7 +4,7 @@
|
||||||
local PATH = (...):gsub('%.init$', '')
|
local PATH = (...):gsub('%.init$', '')
|
||||||
|
|
||||||
local Concord = {
|
local Concord = {
|
||||||
_VERSION = "2.0 Beta",
|
_VERSION = "3.0",
|
||||||
_DESCRIPTION = "A feature-complete ECS library",
|
_DESCRIPTION = "A feature-complete ECS library",
|
||||||
_LICENCE = [[
|
_LICENCE = [[
|
||||||
MIT LICENSE
|
MIT LICENSE
|
||||||
|
|
|
||||||
|
|
@ -1,185 +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><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>
|
|
||||||
|
|
@ -38,17 +38,13 @@
|
||||||
|
|
||||||
<h2>Modules</h2>
|
<h2>Modules</h2>
|
||||||
<ul class="nowrap">
|
<ul class="nowrap">
|
||||||
<li><a href="../modules/Assemblages.html">Assemblages</a></li>
|
|
||||||
<li><strong>Components</strong></li>
|
<li><strong>Components</strong></li>
|
||||||
<li><a href="../modules/Concord.html">Concord</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/type.html">type</a></li>
|
||||||
<li><a href="../modules/utils.html">utils</a></li>
|
<li><a href="../modules/utils.html">utils</a></li>
|
||||||
<li><a href="../modules/worlds.html">worlds</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<h2>Classes</h2>
|
<h2>Classes</h2>
|
||||||
<ul class="nowrap">
|
<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/Component.html">Component</a></li>
|
||||||
<li><a href="../classes/Entity.html">Entity</a></li>
|
<li><a href="../classes/Entity.html">Entity</a></li>
|
||||||
<li><a href="../classes/List.html">List</a></li>
|
<li><a href="../classes/List.html">List</a></li>
|
||||||
|
|
@ -68,13 +64,14 @@
|
||||||
|
|
||||||
<h2><a href="#Functions">Functions</a></h2>
|
<h2><a href="#Functions">Functions</a></h2>
|
||||||
<table class="function_list">
|
<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>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#has">has (name)</a></td>
|
<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>
|
<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>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="name" nowrap><a href="#get">get (name)</a></td>
|
<td class="name" nowrap><a href="#get">get (name)</a></td>
|
||||||
|
|
@ -89,31 +86,6 @@
|
||||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||||
|
|
||||||
<dl class="function">
|
<dl class="function">
|
||||||
<dt>
|
|
||||||
<a name = "register"></a>
|
|
||||||
<strong>register (name, componentClass)</strong>
|
|
||||||
</dt>
|
|
||||||
<dd>
|
|
||||||
Registers a ComponentClass.
|
|
||||||
|
|
||||||
|
|
||||||
<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
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dd>
|
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "has"></a>
|
<a name = "has"></a>
|
||||||
<strong>has (name)</strong>
|
<strong>has (name)</strong>
|
||||||
|
|
@ -140,6 +112,37 @@
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</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>
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<a name = "get"></a>
|
<a name = "get"></a>
|
||||||
|
|
@ -175,7 +178,7 @@
|
||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
<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="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue