len0rd/Concord
1
0
Fork 0
mirror of https://github.com/Keyslam-Group/Concord.git synced 2025-08-31 09:28:30 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Publish regenerated LDoc pages

Browse source
This commit is contained in:
Tjakka5 2020-01-04 01:54:21 +01:00
parent 58d9e44bb1
commit 0e1023d2ce
16 changed files with 2283 additions and 805 deletions
Download patch file Download diff file Expand all files Collapse all files

147
docs/modules/assemblage.html Normal file
View file

@ -0,0 +1,147 @@
<!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>assemblage</strong></li>
<li><a href="../modules/assemblages.html">assemblages</a></li>
<li><a href="../modules/component.html">component</a></li>
<li><a href="../modules/components.html">components</a></li>
<li><a href="../modules/entity.html">entity</a></li>
<li><a href="../modules/init.html">init</a></li>
<li><a href="../modules/list.html">list</a></li>
<li><a href="../modules/pool.html">pool</a></li>
<li><a href="../modules/system.html">system</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/world.html">world</a></li>
<li><a href="../modules/worlds.html">worlds</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>assemblage</code></h1>
<p>Assemblage
An Assemblage is a function that 'makes' an entity something.</p>
<p>
It does this by :give'ing or :ensure'ing Components, or by :assemble'ing the Entity.</p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#Assemblage.new">Assemblage.new (assemble)</a></td>
<td class="summary">Creates a new Assemblage.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Assemblage:assemble">Assemblage:assemble (e, ...)</a></td>
<td class="summary">Assembles an Entity.</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "Assemblage.new"></a>
<strong>Assemblage.new (assemble)</strong>
</dt>
<dd>
Creates a new Assemblage.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">assemble</span>
Function that assembles an Entity
</li>
</ul>
<h3>Returns:</h3>
<ol>
A new Assemblage
</ol>
</dd>
<dt>
<a name = "Assemblage:assemble"></a>
<strong>Assemblage:assemble (e, ...)</strong>
</dt>
<dd>
Assembles an Entity.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">e</span>
Entity to assemble
</li>
<li><span class="parameter">...</span>
Varargs to pass to the assemble function
@ return self
</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 00:43:06 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>

116
docs/modules/assemblages.html Normal file
View file

@ -0,0 +1,116 @@
<!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><a href="../modules/assemblage.html">assemblage</a></li>
<li><strong>assemblages</strong></li>
<li><a href="../modules/component.html">component</a></li>
<li><a href="../modules/components.html">components</a></li>
<li><a href="../modules/entity.html">entity</a></li>
<li><a href="../modules/init.html">init</a></li>
<li><a href="../modules/list.html">list</a></li>
<li><a href="../modules/pool.html">pool</a></li>
<li><a href="../modules/system.html">system</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/world.html">world</a></li>
<li><a href="../modules/worlds.html">worlds</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>assemblages</code></h1>
<p>Assemblages
Container for registered Assemblages</p>
<p></p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#Assemblages.register">Assemblages.register (name, assemblage)</a></td>
<td class="summary">Registers an Assemblage.</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "Assemblages.register"></a>
<strong>Assemblages.register (name, assemblage)</strong>
</dt>
<dd>
Registers an Assemblage.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">name</span>
Name to register under
</li>
<li><span class="parameter">assemblage</span>
Assemblage to register
</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 00:43:06 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>

51
docs/modules/component.html
View file

@ -38,13 +38,20 @@
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="../modules/assemblage.html">assemblage</a></li>
<li><a href="../modules/assemblages.html">assemblages</a></li>
<li><strong>component</strong></li>
<li><a href="../modules/components.html">components</a></li>
<li><a href="../modules/entity.html">entity</a></li>
<li><a href="../modules/init.html">init</a></li>
<li><a href="../modules/instance.html">instance</a></li>
<li><a href="../modules/list.html">list</a></li>
<li><a href="../modules/pool.html">pool</a></li>
<li><a href="../modules/system.html">system</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/world.html">world</a></li>
<li><a href="../modules/worlds.html">worlds</a></li>
</ul>
</div>
@ -52,19 +59,25 @@
<div id="content">
<h1>Module <code>component</code></h1>
<p>Component</p>
<p></p>
<p>Component
A Component is a pure data container.</p>
<p>
A Component is contained by a single entity.</p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#Component.new">Component.new (populate)</a></td>
<td class="summary">Creates a new Component.</td>
<td class="summary">Creates a new ComponentClass.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Component:__populate">Component:__populate ()</a></td>
<td class="summary">Internal: Populates a Component with values</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Component:__initialize">Component:__initialize (...)</a></td>
<td class="summary">Creates and initializes a new Bag.</td>
<td class="summary">Internal: Creates and populates a new Component.</td>
</tr>
</table>
@ -80,45 +93,59 @@
<strong>Component.new (populate)</strong>
</dt>
<dd>
Creates a new Component.
Creates a new ComponentClass.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">populate</span>
A function that populates the Bag with values
Function that populates a Component with values
</li>
</ul>
<h3>Returns:</h3>
<ol>
A Component object
A new ComponentClass
</ol>
</dd>
<dt>
<a name = "Component:__populate"></a>
<strong>Component:__populate ()</strong>
</dt>
<dd>
Internal: Populates a Component with values
</dd>
<dt>
<a name = "Component:__initialize"></a>
<strong>Component:__initialize (...)</strong>
</dt>
<dd>
Creates and initializes a new Bag.
Internal: Creates and populates a new Component.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">...</span>
The values passed to the populate function
Varargs passed to the populate function
</li>
</ul>
<h3>Returns:</h3>
<ol>
A new initialized Bag
A new populated Component
</ol>
@ -132,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 2018-09-25 18:42:43 </i>
<i style="float:right;">Last updated 2020-01-04 00:43:06 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

116
docs/modules/components.html Normal file
View file

@ -0,0 +1,116 @@
<!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><a href="../modules/assemblage.html">assemblage</a></li>
<li><a href="../modules/assemblages.html">assemblages</a></li>
<li><a href="../modules/component.html">component</a></li>
<li><strong>components</strong></li>
<li><a href="../modules/entity.html">entity</a></li>
<li><a href="../modules/init.html">init</a></li>
<li><a href="../modules/list.html">list</a></li>
<li><a href="../modules/pool.html">pool</a></li>
<li><a href="../modules/system.html">system</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/world.html">world</a></li>
<li><a href="../modules/worlds.html">worlds</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>components</code></h1>
<p>Components
Container for registered ComponentClasss</p>
<p></p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#Components.register">Components.register (name, componentClass)</a></td>
<td class="summary">Registers a ComponentClass.</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "Components.register"></a>
<strong>Components.register (name, componentClass)</strong>
</dt>
<dd>
Registers a ComponentClass.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">name</span>
Name to register under
</li>
<li><span class="parameter">componentClass</span>
ComponentClass to register
</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 00:43:06 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>

247
docs/modules/entity.html
View file

@ -38,13 +38,20 @@
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="../modules/assemblage.html">assemblage</a></li>
<li><a href="../modules/assemblages.html">assemblages</a></li>
<li><a href="../modules/component.html">component</a></li>
<li><a href="../modules/components.html">components</a></li>
<li><strong>entity</strong></li>
<li><a href="../modules/init.html">init</a></li>
<li><a href="../modules/instance.html">instance</a></li>
<li><a href="../modules/list.html">list</a></li>
<li><a href="../modules/pool.html">pool</a></li>
<li><a href="../modules/system.html">system</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/world.html">world</a></li>
<li><a href="../modules/worlds.html">worlds</a></li>
</ul>
</div>
@ -52,39 +59,62 @@
<div id="content">
<h1>Module <code>entity</code></h1>
<p>Entity</p>
<p></p>
<p>Entity
Entities are the concrete objects that exist in your project.</p>
<p>
An Entity have Components and are processed by Systems.
An Entity is contained by a maximum of 1 World.</p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#Entity.new">Entity.new ()</a></td>
<td class="summary">Creates and initializes a new Entity.</td>
<td class="name" nowrap><a href="#Entity.new">Entity.new (world)</a></td>
<td class="summary">Creates a new Entity.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Entity:give">Entity:give (component, ...)</a></td>
<td class="summary">Gives an Entity a component with values.</td>
<td class="name" nowrap><a href="#Entity:give">Entity:give (componentClass, ...)</a></td>
<td class="summary">Gives an Entity a Component.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Entity:remove">Entity:remove (component)</a></td>
<td class="summary">Removes a component from an Entity.</td>
<td class="name" nowrap><a href="#Entity:ensure">Entity:ensure (componentClass, ...)</a></td>
<td class="summary">Ensures an Entity to have a Component.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Entity:apply">Entity:apply ()</a></td>
<td class="summary">Checks the Entity against the pools again.</td>
<td class="name" nowrap><a href="#Entity:remove">Entity:remove (componentClass)</a></td>
<td class="summary">Removes a Component from an Entity.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Entity:assemble">Entity:assemble (assemblage, ...)</a></td>
<td class="summary">Assembles an Entity.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Entity:destroy">Entity:destroy ()</a></td>
<td class="summary">Destroys the Entity.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Entity:get">Entity:get (component)</a></td>
<td class="name" nowrap><a href="#Entity:__dirty">Entity:__dirty ()</a></td>
<td class="summary">Internal: Tells the World it's in that this Entity is dirty.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Entity:has">Entity:has (componentClass)</a></td>
<td class="summary">Returns true if the Entity has a Component.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Entity:get">Entity:get (componentClass)</a></td>
<td class="summary">Gets a Component from the Entity.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Entity:has">Entity:has (component)</a></td>
<td class="summary">Returns true if the Entity has the Component.</td>
<td class="name" nowrap><a href="#Entity:getComponents">Entity:getComponents ()</a></td>
<td class="summary">Returns a table of all Components the Entity has.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Entity:inWorld">Entity:inWorld ()</a></td>
<td class="summary">Returns true if the Entity is in a World.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Entity:getWorld">Entity:getWorld ()</a></td>
<td class="summary">Returns the World the Entity is in.</td>
</tr>
</table>
@ -97,12 +127,18 @@
<dl class="function">
<dt>
<a name = "Entity.new"></a>
<strong>Entity.new ()</strong>
<strong>Entity.new (world)</strong>
</dt>
<dd>
Creates and initializes a new Entity.
Creates a new Entity. Optionally adds it to a World.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">world</span>
Optional World to add the entity to
</li>
</ul>
<h3>Returns:</h3>
<ol>
@ -116,19 +152,49 @@
</dd>
<dt>
<a name = "Entity:give"></a>
<strong>Entity:give (component, ...)</strong>
<strong>Entity:give (componentClass, ...)</strong>
</dt>
<dd>
Gives an Entity a component with values.
Gives an Entity a Component.
If the Component already exists, it's overridden by this new Component
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">component</span>
The Component to add
<li><span class="parameter">componentClass</span>
ComponentClass to add an instance of
</li>
<li><span class="parameter">...</span>
The values passed to the Component
varargs passed to the Component's populate function
</li>
</ul>
<h3>Returns:</h3>
<ol>
self
</ol>
</dd>
<dt>
<a name = "Entity:ensure"></a>
<strong>Entity:ensure (componentClass, ...)</strong>
</dt>
<dd>
Ensures an Entity to have a Component.
If the Component already exists, no action is taken
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">componentClass</span>
ComponentClass to add an instance of
</li>
<li><span class="parameter">...</span>
varargs passed to the Component's populate function
</li>
</ul>
@ -144,16 +210,16 @@
</dd>
<dt>
<a name = "Entity:remove"></a>
<strong>Entity:remove (component)</strong>
<strong>Entity:remove (componentClass)</strong>
</dt>
<dd>
Removes a component from an Entity.
Removes a Component from an Entity.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">component</span>
The Component to remove
<li><span class="parameter">componentClass</span>
ComponentClass of the Component to remove
</li>
</ul>
@ -168,19 +234,23 @@
</dd>
<dt>
<a name = "Entity:apply"></a>
<strong>Entity:apply ()</strong>
<a name = "Entity:assemble"></a>
<strong>Entity:assemble (assemblage, ...)</strong>
</dt>
<dd>
Checks the Entity against the pools again.
Assembles an Entity.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">assemblage</span>
Assemblage to assemble with
</li>
<li><span class="parameter">...</span>
Varargs to pass to the Assemblage's assemble function.
</li>
</ul>
<h3>Returns:</h3>
<ol>
self
</ol>
@ -192,6 +262,7 @@
</dt>
<dd>
Destroys the Entity.
Removes the Entity from it's World if it's in one.
@ -206,24 +277,18 @@
</dd>
<dt>
<a name = "Entity:get"></a>
<strong>Entity:get (component)</strong>
<a name = "Entity:__dirty"></a>
<strong>Entity:__dirty ()</strong>
</dt>
<dd>
Gets a Component from the Entity.
Internal: Tells the World it's in that this Entity is dirty.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">component</span>
The Component to get
</li>
</ul>
<h3>Returns:</h3>
<ol>
The Bag from the Component
self
</ol>
@ -232,23 +297,107 @@
</dd>
<dt>
<a name = "Entity:has"></a>
<strong>Entity:has (component)</strong>
<strong>Entity:has (componentClass)</strong>
</dt>
<dd>
Returns true if the Entity has the Component.
Returns true if the Entity has a Component.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">component</span>
The Component to check against
<li><span class="parameter">componentClass</span>
ComponentClass of the Component to check
</li>
</ul>
<h3>Returns:</h3>
<ol>
True if the entity has the Bag. False otherwise
True if the Entity has the Component, false otherwise
</ol>
</dd>
<dt>
<a name = "Entity:get"></a>
<strong>Entity:get (componentClass)</strong>
</dt>
<dd>
Gets a Component from the Entity.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">componentClass</span>
ComponentClass of the Component to get
</li>
</ul>
<h3>Returns:</h3>
<ol>
The Component
</ol>
</dd>
<dt>
<a name = "Entity:getComponents"></a>
<strong>Entity:getComponents ()</strong>
</dt>
<dd>
Returns a table of all Components the Entity has.
Warning: Do not modify this table.
Use Entity:give/ensure/remove instead
<h3>Returns:</h3>
<ol>
Table of all Components the Entity has
</ol>
</dd>
<dt>
<a name = "Entity:inWorld"></a>
<strong>Entity:inWorld ()</strong>
</dt>
<dd>
Returns true if the Entity is in a World.
<h3>Returns:</h3>
<ol>
True if the Entity is in a World, false otherwise
</ol>
</dd>
<dt>
<a name = "Entity:getWorld"></a>
<strong>Entity:getWorld ()</strong>
</dt>
<dd>
Returns the World the Entity is in.
<h3>Returns:</h3>
<ol>
The World the Entity is in.
</ol>
@ -262,7 +411,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 2018-09-25 18:42:43 </i>
<i style="float:right;">Last updated 2020-01-04 00:43:06 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

110
docs/modules/init.html
View file

@ -38,13 +38,20 @@
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="../modules/assemblage.html">assemblage</a></li>
<li><a href="../modules/assemblages.html">assemblages</a></li>
<li><a href="../modules/component.html">component</a></li>
<li><a href="../modules/components.html">components</a></li>
<li><a href="../modules/entity.html">entity</a></li>
<li><strong>init</strong></li>
<li><a href="../modules/instance.html">instance</a></li>
<li><a href="../modules/list.html">list</a></li>
<li><a href="../modules/pool.html">pool</a></li>
<li><a href="../modules/system.html">system</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/world.html">world</a></li>
<li><a href="../modules/worlds.html">worlds</a></li>
</ul>
</div>
@ -59,8 +66,20 @@
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#Concord.init">Concord.init (settings)</a></td>
<td class="summary">Initializes the library with some optional settings</td>
<td class="name" nowrap><a href="#Concord.loadComponents">Concord.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="#Concord.loadSystems">Concord.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="#Concord.loadWorlds">Concord.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="#Concord.loadAssemblages">Concord.loadAssemblages (pathOrFiles)</a></td>
<td class="summary">Loads Assemblages and puts them in the Assemblages container.</td>
</tr>
</table>
@ -72,27 +91,88 @@
<dl class="function">
<dt>
<a name = "Concord.init"></a>
<strong>Concord.init (settings)</strong>
<a name = "Concord.loadComponents"></a>
<strong>Concord.loadComponents (pathOrFiles)</strong>
</dt>
<dd>
Initializes the library with some optional settings
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">settings</span>
Table of settings: {
useEvents Flag to overwrite love.run and use events. Defaults to false
}
<li><span class="parameter">pathOrFiles</span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
Concord
</ol>
</dd>
<dt>
<a name = "Concord.loadSystems"></a>
<strong>Concord.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 = "Concord.loadWorlds"></a>
<strong>Concord.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 = "Concord.loadAssemblages"></a>
<strong>Concord.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>
@ -105,7 +185,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 2018-09-25 18:42:43 </i>
<i style="float:right;">Last updated 2020-01-04 00:43:06 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

463
docs/modules/instance.html
View file

@ -1,463 +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><a href="../modules/component.html">component</a></li>
<li><a href="../modules/entity.html">entity</a></li>
<li><a href="../modules/init.html">init</a></li>
<li><strong>instance</strong></li>
<li><a href="../modules/list.html">list</a></li>
<li><a href="../modules/pool.html">pool</a></li>
<li><a href="../modules/system.html">system</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>instance</code></h1>
<p>Instance</p>
<p></p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#Instance.new">Instance.new ()</a></td>
<td class="summary">Creates a new Instance.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Instance:addEntity">Instance:addEntity (e)</a></td>
<td class="summary">Adds an Entity to the Instance.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Instance:checkEntity">Instance:checkEntity (e)</a></td>
<td class="summary">Checks an Entity against all the systems in the Instance.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Instance:removeEntity">Instance:removeEntity (e)</a></td>
<td class="summary">Marks an Entity as removed from the Instance.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Instance:flush">Instance:flush ()</a></td>
<td class="summary">Completely removes all marked Entities in the Instance.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Instance:addSystem">Instance:addSystem (system, eventName, callback, enabled)</a></td>
<td class="summary">Adds a System to the Instance.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Instance:enableSystem">Instance:enableSystem (system, eventName, callback)</a></td>
<td class="summary">Enables a System in the Instance.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Instance:disableSystem">Instance:disableSystem (system, eventName, callback)</a></td>
<td class="summary">Disables a System in the Instance.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Instance:setSystem">Instance:setSystem (system, eventName, callback, enable)</a></td>
<td class="summary">Sets a System 'enable' in the Instance.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Instance:emit">Instance:emit (eventName, ...)</a></td>
<td class="summary">Emits an Event in the Instance.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Instance:clear">Instance:clear ()</a></td>
<td class="summary">Removes all entities from the Instance</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Instance:onEntityAdded">Instance:onEntityAdded (e)</a></td>
<td class="summary">Default callback for adding an Entity.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Instance:onEntityRemoved">Instance:onEntityRemoved (e)</a></td>
<td class="summary">Default callback for removing an Entity.</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "Instance.new"></a>
<strong>Instance.new ()</strong>
</dt>
<dd>
Creates a new Instance.
<h3>Returns:</h3>
<ol>
The new instance
</ol>
</dd>
<dt>
<a name = "Instance:addEntity"></a>
<strong>Instance:addEntity (e)</strong>
</dt>
<dd>
Adds an Entity to the Instance.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">e</span>
The Entity to add
</li>
</ul>
<h3>Returns:</h3>
<ol>
self
</ol>
</dd>
<dt>
<a name = "Instance:checkEntity"></a>
<strong>Instance:checkEntity (e)</strong>
</dt>
<dd>
Checks an Entity against all the systems in the Instance.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">e</span>
The Entity to check
</li>
</ul>
<h3>Returns:</h3>
<ol>
self
</ol>
</dd>
<dt>
<a name = "Instance:removeEntity"></a>
<strong>Instance:removeEntity (e)</strong>
</dt>
<dd>
Marks an Entity as removed from the Instance.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">e</span>
The Entity to mark
</li>
</ul>
<h3>Returns:</h3>
<ol>
self
</ol>
</dd>
<dt>
<a name = "Instance:flush"></a>
<strong>Instance:flush ()</strong>
</dt>
<dd>
Completely removes all marked Entities in the Instance.
<h3>Returns:</h3>
<ol>
self
</ol>
</dd>
<dt>
<a name = "Instance:addSystem"></a>
<strong>Instance:addSystem (system, eventName, callback, enabled)</strong>
</dt>
<dd>
Adds a System to the Instance.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">system</span>
The System to add
</li>
<li><span class="parameter">eventName</span>
The Event to register to
</li>
<li><span class="parameter">callback</span>
The function name to call. Defaults to eventName
</li>
<li><span class="parameter">enabled</span>
If the system is enabled. Defaults to true
</li>
</ul>
<h3>Returns:</h3>
<ol>
self
</ol>
</dd>
<dt>
<a name = "Instance:enableSystem"></a>
<strong>Instance:enableSystem (system, eventName, callback)</strong>
</dt>
<dd>
Enables a System in the Instance.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">system</span>
The System to enable
</li>
<li><span class="parameter">eventName</span>
The Event it was registered to
</li>
<li><span class="parameter">callback</span>
The callback it was registered with. Defaults to eventName
</li>
</ul>
<h3>Returns:</h3>
<ol>
self
</ol>
</dd>
<dt>
<a name = "Instance:disableSystem"></a>
<strong>Instance:disableSystem (system, eventName, callback)</strong>
</dt>
<dd>
Disables a System in the Instance.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">system</span>
The System to disable
</li>
<li><span class="parameter">eventName</span>
The Event it was registered to
</li>
<li><span class="parameter">callback</span>
The callback it was registered with. Defaults to eventName
</li>
</ul>
<h3>Returns:</h3>
<ol>
self
</ol>
</dd>
<dt>
<a name = "Instance:setSystem"></a>
<strong>Instance:setSystem (system, eventName, callback, enable)</strong>
</dt>
<dd>
Sets a System 'enable' in the Instance.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">system</span>
The System to set
</li>
<li><span class="parameter">eventName</span>
The Event it was registered to
</li>
<li><span class="parameter">callback</span>
The callback it was registered with. Defaults to eventName
</li>
<li><span class="parameter">enable</span>
The state to set it to
</li>
</ul>
<h3>Returns:</h3>
<ol>
self
</ol>
</dd>
<dt>
<a name = "Instance:emit"></a>
<strong>Instance:emit (eventName, ...)</strong>
</dt>
<dd>
Emits an Event in the Instance.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">eventName</span>
The Event that should be emitted
</li>
<li><span class="parameter">...</span>
Parameters passed to listeners
</li>
</ul>
<h3>Returns:</h3>
<ol>
self
</ol>
</dd>
<dt>
<a name = "Instance:clear"></a>
<strong>Instance:clear ()</strong>
</dt>
<dd>
Removes all entities from the Instance
<h3>Returns:</h3>
<ol>
self
</ol>
</dd>
<dt>
<a name = "Instance:onEntityAdded"></a>
<strong>Instance:onEntityAdded (e)</strong>
</dt>
<dd>
Default callback for adding an Entity.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">e</span>
The Entity that was added
</li>
</ul>
</dd>
<dt>
<a name = "Instance:onEntityRemoved"></a>
<strong>Instance:onEntityRemoved (e)</strong>
</dt>
<dd>
Default callback for removing an Entity.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">e</span>
The Entity that was removed
</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 2018-09-25 18:42:43 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>

153
docs/modules/list.html
View file

@ -38,13 +38,20 @@
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="../modules/assemblage.html">assemblage</a></li>
<li><a href="../modules/assemblages.html">assemblages</a></li>
<li><a href="../modules/component.html">component</a></li>
<li><a href="../modules/components.html">components</a></li>
<li><a href="../modules/entity.html">entity</a></li>
<li><a href="../modules/init.html">init</a></li>
<li><a href="../modules/instance.html">instance</a></li>
<li><strong>list</strong></li>
<li><a href="../modules/pool.html">pool</a></li>
<li><a href="../modules/system.html">system</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/world.html">world</a></li>
<li><a href="../modules/worlds.html">worlds</a></li>
</ul>
</div>
@ -52,7 +59,8 @@
<div id="content">
<h1>Module <code>list</code></h1>
<p>List</p>
<p>List
Data structure that allows for fast removal at the cost of containing order.</p>
<p></p>
@ -63,24 +71,28 @@
<td class="summary">Creates a new 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:add">List:add (obj)</a></td>
<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="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:get">List:get (index)</a></td>
<td class="summary">Gets an object by numerical index.</td>
<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">Gets if the List has the object.</td>
<td class="summary">Returns true if the List has the object.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#List:get">List:get (i)</a></td>
<td class="summary">Returns the object at an index.</td>
</tr>
<tr>
<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>
</table>
@ -103,7 +115,7 @@
<h3>Returns:</h3>
<ol>
A new list
A new List
</ol>
@ -111,8 +123,60 @@
</dd>
<dt>
<a name = "List:clear"></a>
<strong>List:clear ()</strong>
<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>
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>
self
</ol>
</dd>
<dt>
<a name = "List:__clear"></a>
<strong>List:__clear ()</strong>
</dt>
<dd>
Clears the List completely.
@ -130,49 +194,24 @@
</dd>
<dt>
<a name = "List:add"></a>
<strong>List:add (obj)</strong>
<a name = "List:has"></a>
<strong>List:has (obj)</strong>
</dt>
<dd>
Adds an object to the List.
Returns true if the List has the object.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">obj</span>
The object to add
Object to check for
</li>
</ul>
<h3>Returns:</h3>
<ol>
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>
The object to remove
</li>
</ul>
<h3>Returns:</h3>
<ol>
self
True if the List has the object, false otherwise
</ol>
@ -181,23 +220,23 @@
</dd>
<dt>
<a name = "List:get"></a>
<strong>List:get (index)</strong>
<strong>List:get (i)</strong>
</dt>
<dd>
Gets an object by numerical index.
Returns the object at an index.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">index</span>
The index to look at
<li><span class="parameter">i</span>
Index to get from
</li>
</ul>
<h3>Returns:</h3>
<ol>
The object at the index
Object at the index
</ol>
@ -205,21 +244,25 @@
</dd>
<dt>
<a name = "List:has"></a>
<strong>List:has (obj)</strong>
<a name = "List:indexOf"></a>
<strong>List:indexOf (obj)</strong>
</dt>
<dd>
Gets if the List has the object.
Returns the index of an object in the List.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">obj</span>
The object to search for
true if the list has the object, false otherwise
Object to get index of
</li>
</ul>
<h3>Returns:</h3>
<ol>
index of object in the List.
</ol>
@ -232,7 +275,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 2018-09-25 18:42:43 </i>
<i style="float:right;">Last updated 2020-01-04 00:43:06 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

156
docs/modules/pool.html
View file

@ -38,13 +38,20 @@
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="../modules/assemblage.html">assemblage</a></li>
<li><a href="../modules/assemblages.html">assemblages</a></li>
<li><a href="../modules/component.html">component</a></li>
<li><a href="../modules/components.html">components</a></li>
<li><a href="../modules/entity.html">entity</a></li>
<li><a href="../modules/init.html">init</a></li>
<li><a href="../modules/instance.html">instance</a></li>
<li><a href="../modules/list.html">list</a></li>
<li><strong>pool</strong></li>
<li><a href="../modules/system.html">system</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/world.html">world</a></li>
<li><a href="../modules/worlds.html">worlds</a></li>
</ul>
</div>
@ -52,7 +59,9 @@
<div id="content">
<h1>Module <code>pool</code></h1>
<p>Pool</p>
<p>Pool
A Pool is used to iterate over Entities with a specific Components
A Pool contain a any amount of Entities.</p>
<p></p>
@ -63,9 +72,29 @@
<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="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:__add">Pool:__add (e)</a></td>
<td class="summary">Internal: Adds an Entity to the Pool.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Pool:__remove">Pool:__remove (e)</a></td>
<td class="summary">Internal: Removed an Entity 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>
<tr>
<td class="name" nowrap><a href="#Pool:getFilter">Pool:getFilter ()</a></td>
<td class="summary">Gets the filter of the Pool.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Pool:onEntityAdded">Pool:onEntityAdded (e)</a></td>
<td class="summary">Callback for when an Entity is added to the Pool.</td>
</tr>
</table>
<br/>
@ -86,10 +115,10 @@
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">name</span>
Identifier for the Pool.
Name for the Pool.
</li>
<li><span class="parameter">filter</span>
Table containing the required Components
Table containing the required BaseComponents
</li>
</ul>
@ -104,8 +133,8 @@
</dd>
<dt>
<a name = "Pool:eligible"></a>
<strong>Pool:eligible (e)</strong>
<a name = "Pool:__eligible"></a>
<strong>Pool:__eligible (e)</strong>
</dt>
<dd>
Checks if an Entity is eligible for the Pool.
@ -114,7 +143,7 @@
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">e</span>
The Entity to check
Entity to check
</li>
</ul>
@ -127,6 +156,115 @@
</dd>
<dt>
<a name = "Pool:__add"></a>
<strong>Pool:__add (e)</strong>
</dt>
<dd>
Internal: Adds an Entity to the Pool.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">e</span>
Entity to add
</li>
</ul>
<h3>Returns:</h3>
<ol>
self
</ol>
</dd>
<dt>
<a name = "Pool:__remove"></a>
<strong>Pool:__remove (e)</strong>
</dt>
<dd>
Internal: Removed an Entity from the Pool.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">e</span>
Entity to remove
</li>
</ul>
<h3>Returns:</h3>
<ol>
self
</ol>
</dd>
<dt>
<a name = "Pool:getName"></a>
<strong>Pool:getName ()</strong>
</dt>
<dd>
Gets the name of the Pool
<h3>Returns:</h3>
<ol>
Name of the Pool.
</ol>
</dd>
<dt>
<a name = "Pool:getFilter"></a>
<strong>Pool:getFilter ()</strong>
</dt>
<dd>
Gets the filter of the Pool.
Warning: Do not modify this filter.
<h3>Returns:</h3>
<ol>
Filter of the Pool.
</ol>
</dd>
<dt>
<a name = "Pool:onEntityAdded"></a>
<strong>Pool:onEntityAdded (e)</strong>
</dt>
<dd>
Callback for when an Entity is added to the Pool.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">e</span>
Entity that was added.
</li>
</ul>
</dd>
</dl>
@ -135,7 +273,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 2018-09-25 18:42:43 </i>
<i style="float:right;">Last updated 2020-01-04 00:43:06 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

362
docs/modules/system.html
View file

@ -38,13 +38,20 @@
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="../modules/assemblage.html">assemblage</a></li>
<li><a href="../modules/assemblages.html">assemblages</a></li>
<li><a href="../modules/component.html">component</a></li>
<li><a href="../modules/components.html">components</a></li>
<li><a href="../modules/entity.html">entity</a></li>
<li><a href="../modules/init.html">init</a></li>
<li><a href="../modules/instance.html">instance</a></li>
<li><a href="../modules/list.html">list</a></li>
<li><a href="../modules/pool.html">pool</a></li>
<li><strong>system</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/world.html">world</a></li>
<li><a href="../modules/worlds.html">worlds</a></li>
</ul>
</div>
@ -52,63 +59,62 @@
<div id="content">
<h1>Module <code>system</code></h1>
<p>System</p>
<p></p>
<p>System
A System 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>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#System.new">System.new (...)</a></td>
<td class="summary">Creates a new System prototype.</td>
<td class="summary">Creates a new SystemClass.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#System:__buildPool">System:__buildPool (baseFilter)</a></td>
<td class="summary">Builds a Pool for the System.</td>
<td class="name" nowrap><a href="#System.__buildPool">System.__buildPool (baseFilter)</a></td>
<td class="summary">Internal: Builds a Pool for the System.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#System:__check">System:__check (e)</a></td>
<td class="summary">Checks and applies an Entity to the System's pools.</td>
<td class="name" nowrap><a href="#System:__evaluate">System:__evaluate (e)</a></td>
<td class="summary">Internal: Evaluates an Entity for all the System's Pools.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#System:__remove">System:__remove (e)</a></td>
<td class="summary">Removed an Entity from the System.</td>
<td class="summary">Internal: Removes an Entity from the System.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#System:__tryAdd">System:__tryAdd (e)</a></td>
<td class="summary">Tries to add an Entity to the System.</td>
<td class="name" nowrap><a href="#System:clear">System:clear ()</a></td>
<td class="summary">Internal: Clears all Entities from the System.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#System:__tryRemove">System:__tryRemove (e)</a></td>
<td class="summary">Tries to remove an Entity from the System.</td>
<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:getInstance">System:getInstance ()</a></td>
<td class="summary">Returns the Instance the System is in.</td>
<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:__has">System:__has (e)</a></td>
<td class="summary">Returns if the System has the Entity.</td>
<td class="name" nowrap><a href="#System:toggleEnable">System:toggleEnable ()</a></td>
<td class="summary">Toggles if the System is enabled.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#System:init">System:init (...)</a></td>
<td class="summary">Default callback for system initialization.</td>
<td class="name" nowrap><a href="#System:setEnabled">System:setEnabled (enable)</a></td>
<td class="summary">Sets if the System is enabled</td>
</tr>
<tr>
<td class="name" nowrap><a href="#System:entityAdded">System:entityAdded (e)</a></td>
<td class="summary">Default callback for adding an Entity.</td>
<td class="name" nowrap><a href="#System:isEnabled">System:isEnabled ()</a></td>
<td class="summary">Returns is the System is enabled</td>
</tr>
<tr>
<td class="name" nowrap><a href="#System:entityAddedTo">System:entityAddedTo (e, pool)</a></td>
<td class="summary">Default callback for adding an Entity to a pool.</td>
<td class="name" nowrap><a href="#System:getWorld">System:getWorld ()</a></td>
<td class="summary">Returns the World the System is in.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#System:entityRemoved">System:entityRemoved (e)</a></td>
<td class="summary">Default callback for removing an Entity.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#System:entityRemovedFrom">System:entityRemovedFrom (e, pool)</a></td>
<td class="summary">Default callback for removing an Entity from a pool.</td>
<td class="name" nowrap><a href="#System:init">System:init (world)</a></td>
<td class="summary">Callback for system initialization.</td>
</tr>
</table>
@ -124,7 +130,7 @@
<strong>System.new (...)</strong>
</dt>
<dd>
Creates a new System prototype.
Creates a new SystemClass.
<h3>Parameters:</h3>
@ -137,7 +143,7 @@
<h3>Returns:</h3>
<ol>
A new System prototype
A new SystemClass
</ol>
@ -145,11 +151,11 @@
</dd>
<dt>
<a name = "System:__buildPool"></a>
<strong>System:__buildPool (baseFilter)</strong>
<a name = "System.__buildPool"></a>
<strong>System.__buildPool (baseFilter)</strong>
</dt>
<dd>
Builds a Pool for the System.
Internal: Builds a Pool for the System.
<h3>Parameters:</h3>
@ -170,11 +176,11 @@
</dd>
<dt>
<a name = "System:__check"></a>
<strong>System:__check (e)</strong>
<a name = "System:__evaluate"></a>
<strong>System:__evaluate (e)</strong>
</dt>
<dd>
Checks and applies an Entity to the System's pools.
Internal: Evaluates an Entity for all the System's Pools.
<h3>Parameters:</h3>
@ -187,7 +193,7 @@
<h3>Returns:</h3>
<ol>
True if the Entity was added, false if it was removed. Nil if nothing happend
self
</ol>
@ -199,7 +205,7 @@
<strong>System:__remove (e)</strong>
</dt>
<dd>
Removed an Entity from the System.
Internal: Removes an Entity from the System.
<h3>Parameters:</h3>
@ -209,64 +215,10 @@
</li>
</ul>
</dd>
<dt>
<a name = "System:__tryAdd"></a>
<strong>System:__tryAdd (e)</strong>
</dt>
<dd>
Tries to add an Entity to the System.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">e</span>
The Entity to add
</li>
</ul>
</dd>
<dt>
<a name = "System:__tryRemove"></a>
<strong>System:__tryRemove (e)</strong>
</dt>
<dd>
Tries to remove an Entity from the System.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">e</span>
The Entity to remove
</li>
</ul>
</dd>
<dt>
<a name = "System:getInstance"></a>
<strong>System:getInstance ()</strong>
</dt>
<dd>
Returns the Instance the System is in.
<h3>Returns:</h3>
<ol>
The Instance
self
</ol>
@ -274,24 +226,138 @@
</dd>
<dt>
<a name = "System:__has"></a>
<strong>System:__has (e)</strong>
<a name = "System:clear"></a>
<strong>System:clear ()</strong>
</dt>
<dd>
Returns if the System has the Entity.
Internal: Clears all Entities from the System.
<h3>Returns:</h3>
<ol>
self
</ol>
</dd>
<dt>
<a name = "System:enable"></a>
<strong>System:enable ()</strong>
</dt>
<dd>
Enables the System.
<h3>Returns:</h3>
<ol>
self
</ol>
</dd>
<dt>
<a name = "System:disable"></a>
<strong>System:disable ()</strong>
</dt>
<dd>
Disables the System.
<h3>Returns:</h3>
<ol>
self
</ol>
</dd>
<dt>
<a name = "System:toggleEnable"></a>
<strong>System:toggleEnable ()</strong>
</dt>
<dd>
Toggles if the System is enabled.
<h3>Returns:</h3>
<ol>
self
</ol>
</dd>
<dt>
<a name = "System:setEnabled"></a>
<strong>System:setEnabled (enable)</strong>
</dt>
<dd>
Sets if the System is enabled
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">e</span>
The Entity to check for
<li><span class="parameter">enable</span>
Enable
</li>
</ul>
<h3>Returns:</h3>
<ol>
True if the System has the Entity. False otherwise
self
</ol>
</dd>
<dt>
<a name = "System:isEnabled"></a>
<strong>System:isEnabled ()</strong>
</dt>
<dd>
Returns is the System is enabled
<h3>Returns:</h3>
<ol>
True if the System is enabled, false otherwise
</ol>
</dd>
<dt>
<a name = "System:getWorld"></a>
<strong>System:getWorld ()</strong>
</dt>
<dd>
Returns the World the System is in.
<h3>Returns:</h3>
<ol>
The World the System is in
</ol>
@ -300,102 +366,16 @@
</dd>
<dt>
<a name = "System:init"></a>
<strong>System:init (...)</strong>
<strong>System:init (world)</strong>
</dt>
<dd>
Default callback for system initialization.
Callback for system initialization.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">...</span>
Varags
</li>
</ul>
</dd>
<dt>
<a name = "System:entityAdded"></a>
<strong>System:entityAdded (e)</strong>
</dt>
<dd>
Default callback for adding an Entity.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">e</span>
The Entity that was added
</li>
</ul>
</dd>
<dt>
<a name = "System:entityAddedTo"></a>
<strong>System:entityAddedTo (e, pool)</strong>
</dt>
<dd>
Default callback for adding an Entity to a pool.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">e</span>
The Entity that was added
</li>
<li><span class="parameter">pool</span>
The pool the Entity was added to
</li>
</ul>
</dd>
<dt>
<a name = "System:entityRemoved"></a>
<strong>System:entityRemoved (e)</strong>
</dt>
<dd>
Default callback for removing an Entity.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">e</span>
The Entity that was removed
</li>
</ul>
</dd>
<dt>
<a name = "System:entityRemovedFrom"></a>
<strong>System:entityRemovedFrom (e, pool)</strong>
</dt>
<dd>
Default callback for removing an Entity from a pool.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">e</span>
The Entity that was removed
</li>
<li><span class="parameter">pool</span>
The pool the Entity was removed from
<li><span class="parameter">world</span>
The World the System was added to
</li>
</ul>
@ -411,7 +391,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 2018-09-25 18:42:43 </i>
<i style="float:right;">Last updated 2020-01-04 00:43:06 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

116
docs/modules/systems.html Normal file
View file

@ -0,0 +1,116 @@
<!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><a href="../modules/assemblage.html">assemblage</a></li>
<li><a href="../modules/assemblages.html">assemblages</a></li>
<li><a href="../modules/component.html">component</a></li>
<li><a href="../modules/components.html">components</a></li>
<li><a href="../modules/entity.html">entity</a></li>
<li><a href="../modules/init.html">init</a></li>
<li><a href="../modules/list.html">list</a></li>
<li><a href="../modules/pool.html">pool</a></li>
<li><a href="../modules/system.html">system</a></li>
<li><strong>systems</strong></li>
<li><a href="../modules/type.html">type</a></li>
<li><a href="../modules/utils.html">utils</a></li>
<li><a href="../modules/world.html">world</a></li>
<li><a href="../modules/worlds.html">worlds</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>systems</code></h1>
<p>Systems
Container for registered SystemClasses</p>
<p></p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#Systems.register">Systems.register (name, systemClass)</a></td>
<td class="summary">Registers a SystemClass.</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "Systems.register"></a>
<strong>Systems.register (name, systemClass)</strong>
</dt>
<dd>
Registers a SystemClass.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">name</span>
Name to register under
</li>
<li><span class="parameter">systemClass</span>
SystemClass to register
</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 00:43:06 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>

292
docs/modules/type.html Normal file
View file

@ -0,0 +1,292 @@
<!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><a href="../modules/assemblage.html">assemblage</a></li>
<li><a href="../modules/assemblages.html">assemblages</a></li>
<li><a href="../modules/component.html">component</a></li>
<li><a href="../modules/components.html">components</a></li>
<li><a href="../modules/entity.html">entity</a></li>
<li><a href="../modules/init.html">init</a></li>
<li><a href="../modules/list.html">list</a></li>
<li><a href="../modules/pool.html">pool</a></li>
<li><a href="../modules/system.html">system</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/world.html">world</a></li>
<li><a href="../modules/worlds.html">worlds</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>type</code></h1>
<p>Type
Helper module to do easy type checking for Concord types</p>
<p></p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#Type.isEntity">Type.isEntity (t)</a></td>
<td class="summary">Returns if object is an Entity.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Type.isComponentClass">Type.isComponentClass (t)</a></td>
<td class="summary">Returns if object is a ComponentClass.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Type.isComponent">Type.isComponent (t)</a></td>
<td class="summary">Returns if object is a Component.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Type.isSystemClass">Type.isSystemClass (t)</a></td>
<td class="summary">Returns if object is a SystemClass.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Type.isSystem">Type.isSystem (t)</a></td>
<td class="summary">Returns if object is a System.</td>
</tr>
<tr>
<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/>
<br/>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "Type.isEntity"></a>
<strong>Type.isEntity (t)</strong>
</dt>
<dd>
Returns if object is an Entity.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">t</span>
Object to check
</li>
</ul>
<h3>Returns:</h3>
<ol>
True if object is an Entity, false otherwise
</ol>
</dd>
<dt>
<a name = "Type.isComponentClass"></a>
<strong>Type.isComponentClass (t)</strong>
</dt>
<dd>
Returns if object is a ComponentClass.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">t</span>
Object to check
</li>
</ul>
<h3>Returns:</h3>
<ol>
True if object is an ComponentClass, false otherwise
</ol>
</dd>
<dt>
<a name = "Type.isComponent"></a>
<strong>Type.isComponent (t)</strong>
</dt>
<dd>
Returns if object is a Component.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">t</span>
Object to check
</li>
</ul>
<h3>Returns:</h3>
<ol>
True if object is an Component, false otherwise
</ol>
</dd>
<dt>
<a name = "Type.isSystemClass"></a>
<strong>Type.isSystemClass (t)</strong>
</dt>
<dd>
Returns if object is a SystemClass.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">t</span>
Object to check
</li>
</ul>
<h3>Returns:</h3>
<ol>
True if object is an SystemClass, false otherwise
</ol>
</dd>
<dt>
<a name = "Type.isSystem"></a>
<strong>Type.isSystem (t)</strong>
</dt>
<dd>
Returns if object is a System.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">t</span>
Object to check
</li>
</ul>
<h3>Returns:</h3>
<ol>
True if object is an System, false otherwise
</ol>
</dd>
<dt>
<a name = "Type.isWorld"></a>
<strong>Type.isWorld (t)</strong>
</dt>
<dd>
Returns if object is a World.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">t</span>
Object to check
</li>
</ul>
<h3>Returns:</h3>
<ol>
True if object is an World, false otherwise
</ol>
</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>
True if object is an Assemblage, false otherwise
</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-01-04 00:43:06 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>

116
docs/modules/utils.html Normal file
View file

@ -0,0 +1,116 @@
<!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><a href="../modules/assemblage.html">assemblage</a></li>
<li><a href="../modules/assemblages.html">assemblages</a></li>
<li><a href="../modules/component.html">component</a></li>
<li><a href="../modules/components.html">components</a></li>
<li><a href="../modules/entity.html">entity</a></li>
<li><a href="../modules/init.html">init</a></li>
<li><a href="../modules/list.html">list</a></li>
<li><a href="../modules/pool.html">pool</a></li>
<li><a href="../modules/system.html">system</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/world.html">world</a></li>
<li><a href="../modules/worlds.html">worlds</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>utils</code></h1>
<p>Utils
Helper module for misc operations</p>
<p></p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<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>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "Utils.shallowCopy"></a>
<strong>Utils.shallowCopy (orig, target)</strong>
</dt>
<dd>
Does a shallow copy of a table and appends it to a target table.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">orig</span>
Table to copy
</li>
<li><span class="parameter">target</span>
Table to append to
</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 00:43:06 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>

453
docs/modules/world.html Normal file
View file

@ -0,0 +1,453 @@
<!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><a href="../modules/assemblage.html">assemblage</a></li>
<li><a href="../modules/assemblages.html">assemblages</a></li>
<li><a href="../modules/component.html">component</a></li>
<li><a href="../modules/components.html">components</a></li>
<li><a href="../modules/entity.html">entity</a></li>
<li><a href="../modules/init.html">init</a></li>
<li><a href="../modules/list.html">list</a></li>
<li><a href="../modules/pool.html">pool</a></li>
<li><a href="../modules/system.html">system</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><strong>world</strong></li>
<li><a href="../modules/worlds.html">worlds</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>world</code></h1>
<p>World
A World is a collection of Systems and Entities
A world emits to let Systems iterate
A World contains any amount of Systems
A World contains any amount of Entities</p>
<p></p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#World.new">World.new ()</a></td>
<td class="summary">Creates a new World.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#World:addEntity">World:addEntity (e)</a></td>
<td class="summary">Adds an Entity to the World.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#World:removeEntity">World:removeEntity (e)</a></td>
<td class="summary">Removes an Entity from the World.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#World:__dirtyEntity">World:__dirtyEntity (e)</a></td>
<td class="summary">Internal: Marks an Entity as dirty.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#World:__flush">World:__flush ()</a></td>
<td class="summary">Internal: Flushes all changes to Entities.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#World:addSystem">World:addSystem (systemClass)</a></td>
<td class="summary">Adds a System to the World.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#World:addSystems">World:addSystems (...)</a></td>
<td class="summary">Adds multiple Systems to the World.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#World:hasSystem">World:hasSystem (systemClass)</a></td>
<td class="summary">Returns if the World has a System.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#World:getSystem">World:getSystem (systemClass)</a></td>
<td class="summary">Gets a System from the World.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#World:emit">World:emit (functionName, ...)</a></td>
<td class="summary">Emits a callback in the World.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#World:clear">World:clear ()</a></td>
<td class="summary">Removes all entities from the World</td>
</tr>
<tr>
<td class="name" nowrap><a href="#World:onEntityAdded">World:onEntityAdded (e)</a></td>
<td class="summary">Callback for when an Entity is added to the World.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#World:onEntityRemoved">World:onEntityRemoved (e)</a></td>
<td class="summary">Callback for when an Entity is removed from the World.</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "World.new"></a>
<strong>World.new ()</strong>
</dt>
<dd>
Creates a new World.
<h3>Returns:</h3>
<ol>
The new World
</ol>
</dd>
<dt>
<a name = "World:addEntity"></a>
<strong>World:addEntity (e)</strong>
</dt>
<dd>
Adds an Entity to the World.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">e</span>
Entity to add
</li>
</ul>
<h3>Returns:</h3>
<ol>
self
</ol>
</dd>
<dt>
<a name = "World:removeEntity"></a>
<strong>World:removeEntity (e)</strong>
</dt>
<dd>
Removes an Entity from the World.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">e</span>
Entity to remove
</li>
</ul>
<h3>Returns:</h3>
<ol>
self
</ol>
</dd>
<dt>
<a name = "World:__dirtyEntity"></a>
<strong>World:__dirtyEntity (e)</strong>
</dt>
<dd>
Internal: Marks an Entity as dirty.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">e</span>
Entity to mark as dirty
</li>
</ul>
</dd>
<dt>
<a name = "World:__flush"></a>
<strong>World:__flush ()</strong>
</dt>
<dd>
Internal: Flushes all changes to Entities.
This processes all entities. Adding and removing entities, as well as reevaluating dirty entities.
<h3>Returns:</h3>
<ol>
self
</ol>
</dd>
<dt>
<a name = "World:addSystem"></a>
<strong>World:addSystem (systemClass)</strong>
</dt>
<dd>
Adds a System to the World.
Callbacks are registered automatically
Entities added before are added to the System retroactively
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">systemClass</span>
SystemClass of System to add
</li>
</ul>
<h3>Returns:</h3>
<ol>
self
</ol>
<h3>See also:</h3>
<ul>
<a href="../modules/world.html#World:emit">World:emit</a>
</ul>
</dd>
<dt>
<a name = "World:addSystems"></a>
<strong>World:addSystems (...)</strong>
</dt>
<dd>
Adds multiple Systems to the World.
Callbacks are registered automatically
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">...</span>
SystemClasses of Systems to add
</li>
</ul>
<h3>Returns:</h3>
<ol>
self
</ol>
<h3>See also:</h3>
<ul>
<li><a href="../modules/world.html#World:addSystem">World:addSystem</a></li>
<li><a href="../modules/world.html#World:emit">World:emit</a></li>
</ul>
</dd>
<dt>
<a name = "World:hasSystem"></a>
<strong>World:hasSystem (systemClass)</strong>
</dt>
<dd>
Returns if the World has a System.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">systemClass</span>
SystemClass of System to check for
</li>
</ul>
<h3>Returns:</h3>
<ol>
True if World has System, false otherwise
</ol>
</dd>
<dt>
<a name = "World:getSystem"></a>
<strong>World:getSystem (systemClass)</strong>
</dt>
<dd>
Gets a System from the World.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">systemClass</span>
SystemClass of System to get
</li>
</ul>
<h3>Returns:</h3>
<ol>
System to get
</ol>
</dd>
<dt>
<a name = "World:emit"></a>
<strong>World:emit (functionName, ...)</strong>
</dt>
<dd>
Emits a callback in the World.
Calls all functions with the functionName of added Systems
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">functionName</span>
Name of functions to call.
</li>
<li><span class="parameter">...</span>
Parameters passed to System's functions
</li>
</ul>
<h3>Returns:</h3>
<ol>
self
</ol>
</dd>
<dt>
<a name = "World:clear"></a>
<strong>World:clear ()</strong>
</dt>
<dd>
Removes all entities from the World
<h3>Returns:</h3>
<ol>
self
</ol>
</dd>
<dt>
<a name = "World:onEntityAdded"></a>
<strong>World:onEntityAdded (e)</strong>
</dt>
<dd>
Callback for when an Entity is added to the World.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">e</span>
The Entity that was added
</li>
</ul>
</dd>
<dt>
<a name = "World:onEntityRemoved"></a>
<strong>World:onEntityRemoved (e)</strong>
</dt>
<dd>
Callback for when an Entity is removed from the World.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">e</span>
The Entity that was removed
</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 00:43:06 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>

116
docs/modules/worlds.html Normal file
View file

@ -0,0 +1,116 @@
<!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><a href="../modules/assemblage.html">assemblage</a></li>
<li><a href="../modules/assemblages.html">assemblages</a></li>
<li><a href="../modules/component.html">component</a></li>
<li><a href="../modules/components.html">components</a></li>
<li><a href="../modules/entity.html">entity</a></li>
<li><a href="../modules/init.html">init</a></li>
<li><a href="../modules/list.html">list</a></li>
<li><a href="../modules/pool.html">pool</a></li>
<li><a href="../modules/system.html">system</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/world.html">world</a></li>
<li><strong>worlds</strong></li>
</ul>
</div>
<div id="content">
<h1>Module <code>worlds</code></h1>
<p>Worlds
Container for registered Worlds</p>
<p></p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#Worlds.register">Worlds.register (name, world)</a></td>
<td class="summary">Registers a World.</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "Worlds.register"></a>
<strong>Worlds.register (name, world)</strong>
</dt>
<dd>
Registers a World.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">name</span>
Name to register under
</li>
<li><span class="parameter">world</span>
World to register
</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 00:43:06 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>