Concord/docs/index.html
2020-01-04 01:54:21 +01:00

142 lines
4.2 KiB
HTML

<!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>
<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><a href="modules/worlds.html">worlds</a></li>
</ul>
</div>
<div id="content">
<h2>A feature-complete ECS library</h2>
<h2>Modules</h2>
<table class="module_list">
<tr>
<td class="name" nowrap><a href="modules/assemblage.html">assemblage</a></td>
<td class="summary">Assemblage
An Assemblage is a function that 'makes' an entity something.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/assemblages.html">assemblages</a></td>
<td class="summary">Assemblages
Container for registered Assemblages</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/component.html">component</a></td>
<td class="summary">Component
A Component is a pure data container.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/components.html">components</a></td>
<td class="summary">Components
Container for registered ComponentClasss</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/entity.html">entity</a></td>
<td class="summary">Entity
Entities are the concrete objects that exist in your project.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/init.html">init</a></td>
<td class="summary">init</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/list.html">list</a></td>
<td class="summary">List
Data structure that allows for fast removal at the cost of containing order.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/pool.html">pool</a></td>
<td class="summary">Pool
A Pool is used to iterate over Entities with a specific Components
A Pool contain a any amount of Entities.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/system.html">system</a></td>
<td class="summary">System
A System iterates over Entities.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/systems.html">systems</a></td>
<td class="summary">Systems
Container for registered SystemClasses</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/type.html">type</a></td>
<td class="summary">Type
Helper module to do easy type checking for Concord types</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/utils.html">utils</a></td>
<td class="summary">Utils
Helper module for misc operations</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/world.html">world</a></td>
<td class="summary">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</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/worlds.html">worlds</a></td>
<td class="summary">Worlds
Container for registered Worlds</td>
</tr>
</table>
</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>