Reuh/ubiquitousse
1
0
Fork 0
mirror of https://github.com/Reuh/ubiquitousse.git synced 2025-10-27 17:19:31 +00:00
Code Releases Activity

ecs: implement skip lists

Browse source
This commit is contained in:
Étienne Fildadut 2022-10-11 19:14:48 +09:00
parent 0ea6117af9
commit bd28610ff4
14 changed files with 936 additions and 639 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/modules/asset.html
View file

@ -337,7 +337,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-07 12:40:59 </i>
<i style="float:right;">Last updated 2022-10-11 19:12:05 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

175
docs/modules/ecs.html
View file

@ -70,7 +70,8 @@ Main differences include:</p>
<li>ability to nest systems (more organisation potential);</li>
<li>instanciation of systems for each world (no shared state) (several worlds can coexist at the same time easily);</li>
<li>adding and removing entities is done instantaneously (no going isane over tiny-ecs cache issues);</li>
<li>ability to add and remove components from entities after they were added to the world (more dynamic entities).</li>
<li>ability to add and remove components from entities after they were added to the world (more dynamic entities);</li>
<li>much better performance for ordered systems (entities are stored in a skip list internally).</li>
</ul>
@ -83,6 +84,8 @@ if you don&rsquo;t use them.</p>
<p>The module returns a table that contains several functions, <a href="../modules/ecs.html#world">world</a> or <a href="../modules/scene.html#">scene</a> are starting points
to create your world.</p>
<p>This library was designed to be reasonably fast; on my machine using LuaJIT, in the duration of a frame (1/60 seconds) about 40000 entities can be added to an unordered system or 8000 to an ordered system. Complexities are documented for each function.</p>
<p>No mandatory dependency.
Optional dependency: <a href="../modules/ubiquitousse.html#scene">ubiquitousse.scene</a>, to allow quick creation of ECS-based scenes (<a href="../modules/ecs.html#scene">ecs.scene</a>).</p>
<h3>Usage:</h3>
@ -140,6 +143,26 @@ end
</table>
<h3 class="doc-title"><a href="#Entity.Component">Components.</a></h3>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#Entity.first">Entity.first</a></td>
<td class="summary">First element of the highest layer linked list of entities: { entity, next_element, element_in_lower_layer }.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Entity.firstBase">Entity.firstBase</a></td>
<td class="summary">First element of the base layer.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Entity.previous">Entity.previous</a></td>
<td class="summary">List of hash map (one per skip listlayer) of entities in the system and their previous linked list element.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Entity.nLayers">Entity.nLayers</a></td>
<td class="summary">Number of layers in the skip list.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Entity.n">Entity.n</a></td>
<td class="summary">Number of elements in the skip list.</td>
</tr>
</table>
<h2><a href="#System_objects">System objects </a></h2>
<table class="function_list">
@ -519,6 +542,117 @@ component or if it doesn&rsquo;t exist in the entity.
}</pre>
</ul>
</dd>
<dt>
<a name = "Entity.first"></a>
<strong>Entity.first</strong>
</dt>
<dd>
First element of the highest layer linked list of entities: { entity, next_element, element_in_lower_layer }.
The default entity <code>head</code> is always added as a first element to simplify algorithms; remember to skip it.
</ul>
</ul>
</ul>
</ul>
<h3>Fields:</h3>
<ul>
<li><span class="parameter">head</span>
</li>
<li><span class="parameter">nil</span>
</li>
</ul>
</dd>
<dt>
<a name = "Entity.firstBase"></a>
<strong>Entity.firstBase</strong>
</dt>
<dd>
First element of the base layer.
</ul>
</ul>
</ul>
</ul>
</dd>
<dt>
<a name = "Entity.previous"></a>
<strong>Entity.previous</strong>
</dt>
<dd>
List of hash map (one per skip listlayer) of entities in the system and their previous linked list element.
Does not contain a key for the <code>head</code> entity.
This make each linked list layer effectively a doubly linked list, but with fast access to the previous element using this map (and therefore O(1) deletion).
</ul>
</ul>
</ul>
</ul>
<h3>Fields:</h3>
<ul>
<li><span class="parameter">{</span>
</li>
</ul>
</dd>
<dt>
<a name = "Entity.nLayers"></a>
<strong>Entity.nLayers</strong>
</dt>
<dd>
Number of layers in the skip list.
</ul>
</ul>
</ul>
</ul>
</dd>
<dt>
<a name = "Entity.n"></a>
<strong>Entity.n</strong>
</dt>
<dd>
Number of elements in the skip list.
</ul>
</ul>
</ul>
</ul>
</dd>
</dl>
<h2 class="section-header has-description"><a name="System_objects"></a>System objects </h2>
@ -1306,7 +1440,7 @@ avoid repeating your filters or allow controlling several system from a single p
If you do that, since <a href="../modules/ecs.html#System:remove">System:remove</a> will not search for entities in systems where they should have been filtered out, the added entities will not be removed
when calling <a href="../modules/ecs.html#System:remove">System:remove</a> on a parent system or the world. The entity can be removed by calling <a href="../modules/ecs.html#System:remove">System:remove</a> on the system <a href="../modules/ecs.html#System:add">System:add</a> was called on.</p>
<p> Complexity: O(1) per unordered system, O(entityCount) per ordered system.
<p> Complexity: O(1) per unordered system, O(log2(entityCount)) per ordered system.
</ul>
</ul>
@ -1349,7 +1483,7 @@ avoid repeating your filters or allow controlling several system from a single p
<p> If you intend to call this on a subsystem instead of the world, please read the warning in <a href="../modules/ecs.html#System:add">System:add</a>.</p>
<p> Complexity: O(1) per system.
<p> Complexity: O(1) per unordered system, O(log2(entityCount)) per ordered system.
</ul>
</ul>
@ -1429,7 +1563,7 @@ avoid repeating your filters or allow controlling several system from a single p
<p> Will recalculate the entity position in the entity list for this system and its subsystems.
Will skip entities that are not in the system.</p>
<p> Complexity: O(entityCount) per system.
<p> Complexity: O(1) per unordered system, O(log2(entityCount)) per ordered system.
</ul>
</ul>
@ -1501,7 +1635,9 @@ avoid repeating your filters or allow controlling several system from a single p
<strong>System:iter ()</strong>
</dt>
<dd>
Returns an iterator that iterate through the entties in this system, in order.
Returns an iterator that iterate through the entties in this system, in order. </p>
<p> Complexity: O(1) per iteration; O(entityCount) for the full iteration
</ul>
</ul>
@ -1525,9 +1661,9 @@ avoid repeating your filters or allow controlling several system from a single p
<strong>System:get (i)</strong>
</dt>
<dd>
Get the <code>i</code>th entity in the system.
This is a simple wrapper around <a href="../modules/ecs.html#System:iter">iter</a>; it <em>will</em> iterate over all the entities in the system in order until we reach the desired one.
Complexity: O(i)
Get the <code>i</code>th entity in the system. </p>
<p> Complexity: O(i)
</ul>
</ul>
@ -1558,7 +1694,9 @@ avoid repeating your filters or allow controlling several system from a single p
<strong>System:clear ()</strong>
</dt>
<dd>
Remove every entity from the system and its subsystems.
Remove every entity from the system and its subsystems. </p>
<p> Complexity: O(entityCount) per system
</ul>
</ul>
@ -1578,7 +1716,9 @@ avoid repeating your filters or allow controlling several system from a single p
<dd>
Try to update the system and its subsystems. Should be called on every game update.</p>
<p> Subsystems are updated after their parent system.
<p> Subsystems are updated after their parent system.</p>
<p> Complexity: O(entityCount) per system if system:process is defined; O(1) per system otherwise.
</ul>
</ul>
@ -1605,7 +1745,9 @@ avoid repeating your filters or allow controlling several system from a single p
<dd>
Try to draw the system and its subsystems. Should be called on every game draw.</p>
<p> Subsystems are drawn after their parent system.
<p> Subsystems are drawn after their parent system.</p>
<p> &mdash; Complexity: O(entityCount) per system if system:render is defined; O(1) per system otherwise.
</ul>
</ul>
@ -1629,7 +1771,9 @@ avoid repeating your filters or allow controlling several system from a single p
if the method exists and the entity is in the system. <code>c</code> is the system <a href="#Entity.Component">component</a>
associated with the current system, and <code>e</code> is the <a href="../modules/ecs.html#Entity_objects">Entity</a>.</p>
<p> Think of it as a way to perform custom callbacks issued from an entity event, similar to <a href="../modules/ecs.html#System:onAdd">System:onAdd</a>.
<p> Think of it as a way to perform custom callbacks issued from an entity event, similar to <a href="../modules/ecs.html#System:onAdd">System:onAdd</a>.</p>
<p> Complexity: O(1) per system
</ul>
</ul>
@ -1681,7 +1825,9 @@ its sibling systems (i.e. completely stop the propagation of the event).</li>
disable <a href="../modules/ecs.html#System:onUpdate">System:onUpdate</a> behaviour on the system and its subsystems).</p>
<p> <code>&quot;capture&quot;</code> would be for example used to prevent other systems from handling the event (for example to make sure an
input event is handled only once by a single system).
input event is handled only once by a single system).</p>
<p> Complexity: O(1) per system
</ul>
</ul>
@ -1710,6 +1856,7 @@ its sibling systems (i.e. completely stop the propagation of the event).</li>
</dt>
<dd>
Remove all the entities and subsystems in this system.
Complexity: O(entityCount) per system
</ul>
</ul>
@ -1729,7 +1876,7 @@ its sibling systems (i.e. completely stop the propagation of the event).</li>
</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-07 12:40:59 </i>
<i style="float:right;">Last updated 2022-10-11 19:12:05 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

31
docs/modules/input.html
View file

@ -238,6 +238,10 @@ end
<td class="summary">Set the state of this input and its children to a neutral position (i.e.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Input:set">Input:set (...)</a></td>
<td class="summary">Manually set the state of this input.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Input:setJoystick">Input:setJoystick (joystick)</a></td>
<td class="summary">Set the joystick associated with this input.</td>
</tr>
@ -1181,6 +1185,31 @@ player.fire.event:bind(<span class="string">"pressed"</span>, <span class="keywo
</dd>
<dt>
<a name = "Input:set"></a>
<strong>Input:set (...)</strong>
</dt>
<dd>
Manually set the state of this input.
</ul>
</ul>
</ul>
</ul>
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">...</span>
</li>
</ul>
</dd>
<dt>
<a name = "Input:setJoystick"></a>
@ -1694,7 +1723,7 @@ player.fire.event:bind(<span class="string">"pressed"</span>, <span class="keywo
</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-07 12:40:59 </i>
<i style="float:right;">Last updated 2022-10-11 19:12:05 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

6
docs/modules/ldtk.html
View file

@ -2066,7 +2066,7 @@ end
Level background. </p>
<p> If there is a background image, <code>background.image</code> contains a table <code>{image=image, x=number, y=number, sx=number, sy=number}</code>
where <a href="../modules/ldtk.html#Tileset.image">image</a> is the LÖVE image (or image filepath if LÖVE not available) <a href="../modules/ldtk.html#Tile.x">x</a> and <a href="../modules/ldtk.html#Tile.y">y</a> are the top-left position,
where <a href="../modules/ldtk.html#Tileset.image">image</a> is the LÖVE image (or image filepath if LÖVE not available) <a href="../modules/ldtk.html#Entity.x">x</a> and <a href="../modules/ldtk.html#Tile.y">y</a> are the top-left position,
and <a href="../modules/ldtk.html#Entity.sx">sx</a> and <a href="../modules/ldtk.html#Entity.sy">sy</a> the horizontal and vertical scale factors.
</ul>
@ -2142,7 +2142,7 @@ end
<li>Enum are converted into a Lua string giving the currently selected enum value.</li>
<li>Filepath are converted into a Lua string giving the file path.</li>
<li>Arrays are converted into a Lua table with the elements in it as a list.</li>
<li>Points are converted into a Lua table with the fields <a href="../modules/ldtk.html#Tile.x">x</a> and <a href="../modules/ldtk.html#Tile.y">y</a>, in pixels: <code>{ x=number, y=number }</code>.</li>
<li>Points are converted into a Lua table with the fields <a href="../modules/ldtk.html#Entity.x">x</a> and <a href="../modules/ldtk.html#Tile.y">y</a>, in pixels: <code>{ x=number, y=number }</code>.</li>
<li>Colors are converted into a Lua table with the red, green and blue components in [0-1] as a list: <code>{r,g,b}</code>.</li>
<li>Tiles are converted into a Lua table { tileset = associated tileset object, quad = associated quad } where <a href="../modules/ldtk.html#Tile.quad">quad</a> is a LÖVE Quad if LÖVE is available, otherwise a table <code>{ x, y, width, height }</code>.</li>
<li>EntityRef are converted into a Lua table { level = level, layerIid = layer IID, entityIid = entity IID, entity = see explanation }. If the entity being refernced belongs to another level and this level is not loaded, <code>entity</code> will be nil; otherwise (same level or the other level is also loaded), it will contain the entity.</li>
@ -2170,7 +2170,7 @@ end
</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-07 12:40:59 </i>
<i style="float:right;">Last updated 2022-10-11 19:12:05 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
docs/modules/scene.html
View file

@ -703,7 +703,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-07 12:40:59 </i>
<i style="float:right;">Last updated 2022-10-11 19:12:05 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
docs/modules/signal.html
View file

@ -788,7 +788,7 @@ signal.event:bind(&quot;keypressed&quot;, function(key, scancode) print(&quot;pr
</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-07 12:40:59 </i>
<i style="float:right;">Last updated 2022-10-11 19:12:05 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
docs/modules/timer.html
View file

@ -1154,7 +1154,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-07 12:40:59 </i>
<i style="float:right;">Last updated 2022-10-11 19:12:05 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
docs/modules/ubiquitousse.html
View file

@ -394,7 +394,7 @@ the repository to save you a few seconds.</p>
</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-07 12:40:59 </i>
<i style="float:right;">Last updated 2022-10-11 19:12:05 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
docs/modules/util.html
View file

@ -785,7 +785,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-07 12:40:59 </i>
<i style="float:right;">Last updated 2022-10-11 19:12:05 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>