feat: world.dispose

3mcd · Mar 1, 2021 · 2ac3378 · 2ac3378
1 parent 114fe7a
commit 2ac3378
Show file tree

Hide file tree

Showing 24 changed files with 151 additions and 75 deletions.
diff --git a/docs-src/content/ecs/_index.md b/docs-src/content/ecs/_index.md
@@ -1,6 +1,6 @@
 +++
 title = "ECS"
-weight = 2
+weight = 3
 sort_by = "weight"
 insert_anchor_links = "right"
 +++

diff --git a/docs-src/content/ecs/world.md b/docs-src/content/ecs/world.md
@@ -53,3 +53,7 @@ if (world.tryGetComponent(entity, Invulnerable) === null) {
 // an entity of (Health, Burn) should always have a position
 world.getComponent(entity, Position)
 ```
+
+## Clearing Data
+
+Use `world.reset()` to completely reset a world. This method will clear all entity and component data, attempting to release pooled components along the way.
diff --git a/docs-src/content/installation/_index.md b/docs-src/content/installation/_index.md
@@ -1,6 +1,6 @@
 +++
 title = "Installation"
-weight = 1
+weight = 2
 +++
 
 ## npm

diff --git a/docs-src/static/javelin-ecs.bundle.min.js b/docs-src/static/javelin-ecs.bundle.min.js
diff --git a/docs/ecs/change-detection/index.html b/docs/ecs/change-detection/index.html
@@ -51,19 +51,19 @@
 
                                 <li >
 
-                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;installation&#x2F;">
+                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;introduction&#x2F;">
 
-                                        Installation
+                                        Introduction
                                     </a>
 
                                 </li>
 
 
                                 <li >
 
-                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;introduction&#x2F;">
+                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;installation&#x2F;">
 
-                                        Introduction
+                                        Installation
                                     </a>
 
                                 </li>

diff --git a/docs/ecs/components/index.html b/docs/ecs/components/index.html
@@ -51,19 +51,19 @@
 
                                 <li >
 
-                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;installation&#x2F;">
+                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;introduction&#x2F;">
 
-                                        Installation
+                                        Introduction
                                     </a>
 
                                 </li>
 
 
                                 <li >
 
-                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;introduction&#x2F;">
+                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;installation&#x2F;">
 
-                                        Introduction
+                                        Installation
                                     </a>
 
                                 </li>

diff --git a/docs/ecs/effects/index.html b/docs/ecs/effects/index.html
@@ -51,19 +51,19 @@
 
                                 <li >
 
-                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;installation&#x2F;">
+                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;introduction&#x2F;">
 
-                                        Installation
+                                        Introduction
                                     </a>
 
                                 </li>
 
 
                                 <li >
 
-                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;introduction&#x2F;">
+                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;installation&#x2F;">
 
-                                        Introduction
+                                        Installation
                                     </a>
 
                                 </li>

diff --git a/docs/ecs/entities/index.html b/docs/ecs/entities/index.html
@@ -51,19 +51,19 @@
 
                                 <li >
 
-                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;installation&#x2F;">
+                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;introduction&#x2F;">
 
-                                        Installation
+                                        Introduction
                                     </a>
 
                                 </li>
 
 
                                 <li >
 
-                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;introduction&#x2F;">
+                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;installation&#x2F;">
 
-                                        Introduction
+                                        Installation
                                     </a>
 
                                 </li>

diff --git a/docs/ecs/filtering/index.html b/docs/ecs/filtering/index.html
@@ -51,19 +51,19 @@
 
                                 <li >
 
-                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;installation&#x2F;">
+                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;introduction&#x2F;">
 
-                                        Installation
+                                        Introduction
                                     </a>
 
                                 </li>
 
 
                                 <li >
 
-                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;introduction&#x2F;">
+                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;installation&#x2F;">
 
-                                        Introduction
+                                        Installation
                                     </a>
 
                                 </li>

diff --git a/docs/ecs/index.html b/docs/ecs/index.html
@@ -51,19 +51,19 @@
 
                                 <li >
 
-                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;installation&#x2F;">
+                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;introduction&#x2F;">
 
-                                        Installation
+                                        Introduction
                                     </a>
 
                                 </li>
 
 
                                 <li >
 
-                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;introduction&#x2F;">
+                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;installation&#x2F;">
 
-                                        Introduction
+                                        Installation
                                     </a>
 
                                 </li>

diff --git a/docs/ecs/performance/index.html b/docs/ecs/performance/index.html
@@ -51,19 +51,19 @@
 
                                 <li >
 
-                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;installation&#x2F;">
+                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;introduction&#x2F;">
 
-                                        Installation
+                                        Introduction
                                     </a>
 
                                 </li>
 
 
                                 <li >
 
-                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;introduction&#x2F;">
+                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;installation&#x2F;">
 
-                                        Introduction
+                                        Installation
                                     </a>
 
                                 </li>

diff --git a/docs/ecs/systems/index.html b/docs/ecs/systems/index.html
@@ -51,19 +51,19 @@
 
                                 <li >
 
-                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;installation&#x2F;">
+                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;introduction&#x2F;">
 
-                                        Installation
+                                        Introduction
                                     </a>
 
                                 </li>
 
 
                                 <li >
 
-                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;introduction&#x2F;">
+                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;installation&#x2F;">
 
-                                        Introduction
+                                        Installation
                                     </a>
 
                                 </li>

diff --git a/docs/ecs/topics/index.html b/docs/ecs/topics/index.html
@@ -51,19 +51,19 @@
 
                                 <li >
 
-                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;installation&#x2F;">
+                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;introduction&#x2F;">
 
-                                        Installation
+                                        Introduction
                                     </a>
 
                                 </li>
 
 
                                 <li >
 
-                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;introduction&#x2F;">
+                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;installation&#x2F;">
 
-                                        Introduction
+                                        Installation
                                     </a>
 
                                 </li>

diff --git a/docs/ecs/world/index.html b/docs/ecs/world/index.html
@@ -51,19 +51,19 @@
 
                                 <li >
 
-                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;installation&#x2F;">
+                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;introduction&#x2F;">
 
-                                        Installation
+                                        Introduction
                                     </a>
 
                                 </li>
 
 
                                 <li >
 
-                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;introduction&#x2F;">
+                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;installation&#x2F;">
 
-                                        Introduction
+                                        Installation
                                     </a>
 
                                 </li>
@@ -220,6 +220,11 @@ <h2 id="finding-components">Finding Components<a class="zola-anchor" href="#find
 <pre><code>// an entity of (Health, Burn) should always have a position
 world.getComponent(entity, Position)
 </code></pre>
+<h2 id="clearing-data">Clearing Data<a class="zola-anchor" href="#clearing-data" aria-label="Anchor link for: clearing-data"
+  >#</a
+>
+</h2>
+<p>Use <code>world.reset()</code> to completely reset a world. This method will clear all entity and component data, attempting to release pooled components along the way.</p>
 
                     </div>
                 </div>

diff --git a/docs/installation/index.html b/docs/installation/index.html
@@ -49,21 +49,21 @@
 
 
 
-                                <li class="active">
+                                <li >
 
-                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;installation&#x2F;">
+                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;introduction&#x2F;">
 
-                                        Installation
+                                        Introduction
                                     </a>
 
                                 </li>
 
 
-                                <li >
+                                <li class="active">
 
-                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;introduction&#x2F;">
+                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;installation&#x2F;">
 
-                                        Introduction
+                                        Installation
                                     </a>
 
                                 </li>

diff --git a/docs/introduction/index.html b/docs/introduction/index.html
@@ -49,21 +49,21 @@
 
 
 
-                                <li >
+                                <li class="active">
 
-                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;installation&#x2F;">
+                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;introduction&#x2F;">
 
-                                        Installation
+                                        Introduction
                                     </a>
 
                                 </li>
 
 
-                                <li class="active">
+                                <li >
 
-                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;introduction&#x2F;">
+                                    <a href="https:&#x2F;&#x2F;javelin.games&#x2F;installation&#x2F;">
 
-                                        Introduction
+                                        Installation
                                     </a>
 
                                 </li>