mirror of
https://github.com/Keyslam-Group/Concord.git
synced 2025-09-04 13:23:54 -04:00
Deploying to gh-pages from @ Keyslam-Group/Concord@a80077276d 🚀
This commit is contained in:
parent
a09aa91a13
commit
2a34adcf0f
12 changed files with 523 additions and 125 deletions
|
@ -40,8 +40,8 @@
|
|||
<ul class="nowrap">
|
||||
<li><strong>Component</strong></li>
|
||||
<li><a href="../classes/Entity.html">Entity</a></li>
|
||||
<li><a href="../classes/Filter.html">Filter</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>
|
||||
|
@ -159,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 2022-10-17 19:53:58 </i>
|
||||
<i style="float:right;">Last updated 2023-02-15 01:21:04 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
@ -40,8 +40,8 @@
|
|||
<ul class="nowrap">
|
||||
<li><a href="../classes/Component.html">Component</a></li>
|
||||
<li><strong>Entity</strong></li>
|
||||
<li><a href="../classes/Filter.html">Filter</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>
|
||||
|
@ -98,7 +98,7 @@
|
|||
<td class="summary">Gets a Component from the Entity.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Entity:getComponents">Entity:getComponents ()</a></td>
|
||||
<td class="name" nowrap><a href="#Entity:getComponents">Entity:getComponents (output)</a></td>
|
||||
<td class="summary">Returns a table of all Components the Entity has.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
@ -341,7 +341,7 @@
|
|||
</dd>
|
||||
<dt>
|
||||
<a name = "Entity:getComponents"></a>
|
||||
<strong>Entity:getComponents ()</strong>
|
||||
<strong>Entity:getComponents (output)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns a table of all Components the Entity has.
|
||||
|
@ -349,6 +349,12 @@
|
|||
Use Entity:give/ensure/remove instead
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">output</span>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
@ -408,7 +414,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 2022-10-17 19:53:58 </i>
|
||||
<i style="float:right;">Last updated 2023-02-15 01:21:04 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
255
classes/Filter.html
Normal file
255
classes/Filter.html
Normal file
|
@ -0,0 +1,255 @@
|
|||
<!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="#Methods">Methods</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><strong>Filter</strong></li>
|
||||
<li><a href="../classes/List.html">List</a></li>
|
||||
<li><a href="../classes/System.html">System</a></li>
|
||||
<li><a href="../classes/World.html">World</a></li>
|
||||
</ul>
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/Components.html">Components</a></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>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Class <code>Filter</code></h1>
|
||||
<p>Used to filter Entities with specific Components
|
||||
A Filter has an associated Pool that can contain any amount of Entities.</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
<h2><a href="#Methods">Methods</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Filter:validate">Filter:validate (name, definition, Optional)</a></td>
|
||||
<td class="summary">Validates a Filter Definition to make sure every component is valid.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Filter:parse">Filter:parse (name, definition)</a></td>
|
||||
<td class="summary">Parses the Filter Defintion into two tables
|
||||
required: An array of all the required component names.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Filter:new">Filter:new (name, definition)</a></td>
|
||||
<td class="summary">Creates a new Filter</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Filter:eligible">Filter:eligible (e)</a></td>
|
||||
<td class="summary">Checks if an Entity fulfills the Filter requirements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Filter:getName">Filter:getName ()</a></td>
|
||||
<td class="summary">Gets the name of the Filter</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2 class="section-header "><a name="Methods"></a>Methods</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Filter:validate"></a>
|
||||
<strong>Filter:validate (name, definition, Optional)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Validates a Filter Definition to make sure every component is valid.
|
||||
|
||||
|
||||
<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 for the Filter.
|
||||
</li>
|
||||
<li><span class="parameter">definition</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
||||
Table containing the Filter Definition
|
||||
</li>
|
||||
<li><span class="parameter">Optional</span>
|
||||
<span class="types"><span class="type">onComponent</span></span>
|
||||
function, called when a component is valid.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Filter:parse"></a>
|
||||
<strong>Filter:parse (name, definition)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Parses the Filter Defintion into two tables
|
||||
required: An array of all the required component names.
|
||||
rejected: An array of all the components that will be rejected.
|
||||
|
||||
|
||||
<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 for the Filter.
|
||||
</li>
|
||||
<li><span class="parameter">definition</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
||||
Table containing the Filter Definition
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
<li>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
||||
required</li>
|
||||
<li>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
||||
rejected</li>
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Filter:new"></a>
|
||||
<strong>Filter:new (name, definition)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates a new Filter
|
||||
|
||||
|
||||
<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 for the Filter.
|
||||
</li>
|
||||
<li><span class="parameter">definition</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
|
||||
Table containing the Filter Definition
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
<li>
|
||||
<span class="types"><a class="type" href="../classes/Filter.html#">Filter</a></span>
|
||||
The new Filter</li>
|
||||
<li>
|
||||
<span class="types"><span class="type">Pool</span></span>
|
||||
The associated Pool</li>
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Filter:eligible"></a>
|
||||
<strong>Filter:eligible (e)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Checks if an Entity fulfills the Filter requirements.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">e</span>
|
||||
<span class="types"><a class="type" href="../classes/Entity.html#">Entity</a></span>
|
||||
Entity to check
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Filter:getName"></a>
|
||||
<strong>Filter:getName ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Gets the name of the Filter
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</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 2023-02-15 01:21:04 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
|
@ -40,8 +40,8 @@
|
|||
<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/Filter.html">Filter</a></li>
|
||||
<li><strong>List</strong></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>
|
||||
|
@ -92,6 +92,18 @@
|
|||
<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>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#List:sort">List:sort (order)</a></td>
|
||||
<td class="summary">Sorts the List in place, using the order function.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#List:onAdded">List:onAdded (obj)</a></td>
|
||||
<td class="summary">Callback for when an item is added to the List.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#List:onRemoved">List:onRemoved (obj)</a></td>
|
||||
<td class="summary">Callback for when an item is removed to the List.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
|
@ -128,7 +140,7 @@
|
|||
<dd>
|
||||
Adds an object to the List.
|
||||
Object must be of reference type
|
||||
Object may not be the string 'size'
|
||||
Object may not be the string 'size', 'onAdded' or 'onRemoved'
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
|
@ -272,6 +284,73 @@
|
|||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "List:sort"></a>
|
||||
<strong>List:sort (order)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Sorts the List in place, using the order function.
|
||||
The order function is passed to table.sort internally so documentation on table.sort can be used as reference.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">order</span>
|
||||
Function that takes two Entities (a and b) and returns true if a should go before than b.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/List.html#">List</a></span>
|
||||
self
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "List:onAdded"></a>
|
||||
<strong>List:onAdded (obj)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Callback for when an item is added to the List.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">obj</span>
|
||||
Object that was added
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "List:onRemoved"></a>
|
||||
<strong>List:onRemoved (obj)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Callback for when an item is removed to the List.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">obj</span>
|
||||
Object that was removed
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
@ -280,7 +359,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 2022-10-17 19:53:58 </i>
|
||||
<i style="float:right;">Last updated 2023-02-15 01:21:04 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
@ -250,7 +250,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 2022-10-17 19:53:58 </i>
|
||||
<i style="float:right;">Last updated 2020-08-18 15:20:32 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
@ -41,8 +41,8 @@
|
|||
<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/Filter.html">Filter</a></li>
|
||||
<li><a href="../classes/List.html">List</a></li>
|
||||
<li><a href="../classes/Pool.html">Pool</a></li>
|
||||
<li><strong>System</strong></li>
|
||||
<li><a href="../classes/World.html">World</a></li>
|
||||
</ul>
|
||||
|
@ -83,14 +83,6 @@
|
|||
<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:hasName">System:hasName ()</a></td>
|
||||
<td class="summary">Returns true if the System has a name.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#System:getName">System:getName ()</a></td>
|
||||
<td class="summary">Returns the name of the System.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Callbacks">Callbacks </a></h2>
|
||||
<table class="function_list">
|
||||
|
@ -207,46 +199,6 @@
|
|||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "System:hasName"></a>
|
||||
<strong>System:hasName ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns true if the System has a name.
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "System:getName"></a>
|
||||
<strong>System:getName ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns the name of the System.
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2 class="section-header "><a name="Callbacks"></a>Callbacks </h2>
|
||||
|
@ -308,7 +260,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 2022-10-17 19:53:58 </i>
|
||||
<i style="float:right;">Last updated 2023-02-15 01:21:04 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
@ -40,8 +40,8 @@
|
|||
<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/Filter.html">Filter</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><strong>World</strong></li>
|
||||
</ul>
|
||||
|
@ -76,6 +76,10 @@
|
|||
<td class="summary">Adds an Entity to the World.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#World:newEntity">World:newEntity ()</a></td>
|
||||
<td class="summary">Creates a new Entity and adds it 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>
|
||||
|
@ -104,14 +108,6 @@
|
|||
<td class="summary">Removes all entities from the World</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#World:hasName">World:hasName ()</a></td>
|
||||
<td class="summary">Returns true if the World has a name.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#World:getName">World:getName ()</a></td>
|
||||
<td class="summary">Returns the name of 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>
|
||||
|
@ -119,6 +115,14 @@
|
|||
<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>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#World:setResource">World:setResource (name, resource)</a></td>
|
||||
<td class="summary">Sets a named resource in the world</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#World:getResource">World:getResource (name)</a></td>
|
||||
<td class="summary">Gets a named resource from the world</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
|
@ -174,6 +178,26 @@
|
|||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "World:newEntity"></a>
|
||||
<strong>World:newEntity ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates a new Entity and adds it to the World.
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/Entity.html#">Entity</a></span>
|
||||
e the new Entity
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "World:removeEntity"></a>
|
||||
|
@ -371,46 +395,6 @@
|
|||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "World:hasName"></a>
|
||||
<strong>World:hasName ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns true if the World has a name.
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "World:getName"></a>
|
||||
<strong>World:getName ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns the name of the World.
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "World:onEntityAdded"></a>
|
||||
|
@ -453,6 +437,64 @@
|
|||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "World:setResource"></a>
|
||||
<strong>World:setResource (name, resource)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Sets a named resource in the world
|
||||
|
||||
|
||||
<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 resource
|
||||
</li>
|
||||
<li><span class="parameter">resource</span>
|
||||
<span class="types"><span class="type">Any</span></span>
|
||||
Resource to set
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/World.html#">World</a></span>
|
||||
self
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "World:getResource"></a>
|
||||
<strong>World:getResource (name)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Gets a named resource from the world
|
||||
|
||||
|
||||
<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 resource
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">Any</span></span>
|
||||
resource
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
@ -461,7 +503,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 2022-10-17 19:53:58 </i>
|
||||
<i style="float:right;">Last updated 2023-02-15 01:21:04 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
14
index.html
14
index.html
|
@ -40,8 +40,8 @@
|
|||
<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/Filter.html">Filter</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>
|
||||
|
@ -85,13 +85,13 @@
|
|||
<td class="summary">An object that exists in a world.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="classes/List.html">List</a></td>
|
||||
<td class="summary">Data structure that allows for fast removal at the cost of containing order.</td>
|
||||
<td class="name" nowrap><a href="classes/Filter.html">Filter</a></td>
|
||||
<td class="summary">Used to filter Entities with specific Components
|
||||
A Filter has an associated Pool that can contain any amount of Entities.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="classes/Pool.html">Pool</a></td>
|
||||
<td class="summary">Used to iterate over Entities with a specific Components
|
||||
A Pool contain a any amount of Entities.</td>
|
||||
<td class="name" nowrap><a href="classes/List.html">List</a></td>
|
||||
<td class="summary">Data structure that allows for fast removal at the cost of containing order.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="classes/System.html">System</a></td>
|
||||
|
@ -107,7 +107,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 2022-10-17 19:53:58 </i>
|
||||
<i style="float:right;">Last updated 2023-02-15 01:21:04 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
@ -47,8 +47,8 @@
|
|||
<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/Filter.html">Filter</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>
|
||||
|
@ -69,6 +69,10 @@
|
|||
<td class="summary">Returns true if the containter has the ComponentClass with the specified name</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#reject">reject (name)</a></td>
|
||||
<td class="summary">Prefix a component's name with the currently set Reject Prefix</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>
|
||||
|
@ -112,6 +116,33 @@
|
|||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "reject"></a>
|
||||
<strong>reject (name)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Prefix a component's name with the currently set Reject Prefix
|
||||
|
||||
|
||||
<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 reject
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "try"></a>
|
||||
|
@ -138,6 +169,9 @@
|
|||
<li>
|
||||
<span class="types"><a class="type" href="../classes/Component.html#">Component</a></span>
|
||||
or error string</li>
|
||||
<li>
|
||||
<span class="types"><span class="type">true</span></span>
|
||||
if acceptRejected was true and the name had the Reject Prefix, false otherwise.</li>
|
||||
</ol>
|
||||
|
||||
|
||||
|
@ -178,7 +212,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 2022-10-17 19:53:58 </i>
|
||||
<i style="float:right;">Last updated 2023-02-15 01:21:04 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
@ -43,8 +43,8 @@
|
|||
<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/Filter.html">Filter</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>
|
||||
|
@ -69,7 +69,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 2022-10-17 19:53:58 </i>
|
||||
<i style="float:right;">Last updated 2023-02-15 01:21:04 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
@ -47,8 +47,8 @@
|
|||
<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/Filter.html">Filter</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>
|
||||
|
@ -89,6 +89,10 @@
|
|||
<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.isFilter">Type.isFilter (t)</a></td>
|
||||
<td class="summary">Returns if object is a Filter.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
|
@ -253,6 +257,32 @@
|
|||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Type.isFilter"></a>
|
||||
<strong>Type.isFilter (t)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns if object is a Filter.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">t</span>
|
||||
Object to check
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
@ -261,7 +291,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 2022-10-17 19:53:58 </i>
|
||||
<i style="float:right;">Last updated 2023-02-15 01:21:04 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
@ -47,8 +47,8 @@
|
|||
<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/Filter.html">Filter</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>
|
||||
|
@ -143,7 +143,7 @@
|
|||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2022-10-17 19:53:58 </i>
|
||||
<i style="float:right;">Last updated 2023-02-15 01:21:04 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue