chore: regen docs

Prozi · Aug 7, 2022 · e1a021b · e1a021b
1 parent 340df35
commit e1a021b
Show file tree

Hide file tree

Showing 34 changed files with 239 additions and 238 deletions.
diff --git a/dist/system.d.ts b/dist/system.d.ts
@@ -1,3 +1,4 @@
+/// <reference types="sat" />
 import RBush from "rbush";
 import { BaseSystem } from "./base-system";
 import { Body, Data, RaycastResult, Response, Vector } from "./model";

diff --git a/dist/system.d.ts.map b/dist/system.d.ts.map
diff --git a/docs/classes/Box.html b/docs/classes/Box.html
diff --git a/docs/classes/Circle.html b/docs/classes/Circle.html
diff --git a/docs/classes/Ellipse.html b/docs/classes/Ellipse.html
diff --git a/docs/classes/Line.html b/docs/classes/Line.html
diff --git a/docs/classes/Point.html b/docs/classes/Point.html
diff --git a/docs/classes/Polygon.html b/docs/classes/Polygon.html
diff --git a/docs/classes/System.html b/docs/classes/System.html
diff --git a/docs/enums/Types.html b/docs/enums/Types.html
@@ -17,7 +17,7 @@ <h1>Enumeration Types</h1></div>
 <div class="tsd-comment tsd-typography"><p>types</p>
 </div></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/3d50495/src/model.ts#L17">src/model.ts:17</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/340df35/src/model.ts#L17">src/model.ts:17</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -38,32 +38,32 @@ <h2>Enumeration Members</h2>
 <h3 class="tsd-anchor-link"><span>Box</span><a href="#Box" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
 <div class="tsd-signature">Box<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Box&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/3d50495/src/model.ts#L21">src/model.ts:21</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/340df35/src/model.ts#L21">src/model.ts:21</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Circle" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>Circle</span><a href="#Circle" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">Circle<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Circle&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/3d50495/src/model.ts#L20">src/model.ts:20</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/340df35/src/model.ts#L20">src/model.ts:20</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Ellipse" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>Ellipse</span><a href="#Ellipse" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">Ellipse<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Ellipse&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/3d50495/src/model.ts#L18">src/model.ts:18</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/340df35/src/model.ts#L18">src/model.ts:18</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Line" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>Line</span><a href="#Line" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">Line<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Line&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/3d50495/src/model.ts#L19">src/model.ts:19</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/340df35/src/model.ts#L19">src/model.ts:19</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Point" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>Point</span><a href="#Point" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">Point<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Point&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/3d50495/src/model.ts#L22">src/model.ts:22</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/340df35/src/model.ts#L22">src/model.ts:22</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Polygon" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>Polygon</span><a href="#Polygon" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">Polygon<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Polygon&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/3d50495/src/model.ts#L23">src/model.ts:23</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/340df35/src/model.ts#L23">src/model.ts:23</a></li></ul></aside></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

diff --git a/docs/functions/clockwise.html b/docs/functions/clockwise.html
@@ -26,7 +26,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5>points: <a href="../interfaces/Vector.html" class="tsd-signature-type" data-tsd-kind="Interface">Vector</a><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/3d50495/src/utils.ts#L70">src/utils.ts:70</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/340df35/src/utils.ts#L70">src/utils.ts:70</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

diff --git a/docs/functions/createBox.html b/docs/functions/createBox.html
@@ -28,7 +28,7 @@ <h5>width: <span class="tsd-signature-type">number</span></h5></li>
 <h5>height: <span class="tsd-signature-type">number</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="../classes/SATVector.html" class="tsd-signature-type" data-tsd-kind="Class">SATVector</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/3d50495/src/utils.ts#L29">src/utils.ts:29</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/340df35/src/utils.ts#L29">src/utils.ts:29</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

diff --git a/docs/functions/createEllipse.html b/docs/functions/createEllipse.html
@@ -28,7 +28,7 @@ <h5>radiusY: <span class="tsd-signature-type">number</span><span class="tsd-sign
 <h5>step: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="../classes/SATVector.html" class="tsd-signature-type" data-tsd-kind="Class">SATVector</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/3d50495/src/utils.ts#L9">src/utils.ts:9</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/340df35/src/utils.ts#L9">src/utils.ts:9</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

diff --git a/docs/functions/dashLineTo.html b/docs/functions/dashLineTo.html
@@ -38,7 +38,7 @@ <h5>dash: <span class="tsd-signature-type">number</span><span class="tsd-signatu
 <h5>gap: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 4</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/3d50495/src/utils.ts#L114">src/utils.ts:114</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/340df35/src/utils.ts#L114">src/utils.ts:114</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

diff --git a/docs/functions/distance.html b/docs/functions/distance.html
@@ -28,7 +28,7 @@ <h5>a: <a href="../interfaces/Vector.html" class="tsd-signature-type" data-tsd-k
 <h5>b: <a href="../interfaces/Vector.html" class="tsd-signature-type" data-tsd-kind="Interface">Vector</a></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/3d50495/src/utils.ts#L63">src/utils.ts:63</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/340df35/src/utils.ts#L63">src/utils.ts:63</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

diff --git a/docs/functions/ensureConvexPolygons.html b/docs/functions/ensureConvexPolygons.html
@@ -26,7 +26,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5>body: <a href="../classes/Polygon.html" class="tsd-signature-type" data-tsd-kind="Class">Polygon</a></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="../classes/Polygon.html" class="tsd-signature-type" data-tsd-kind="Class">Polygon</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/3d50495/src/utils.ts#L244">src/utils.ts:244</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/340df35/src/utils.ts#L244">src/utils.ts:244</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

diff --git a/docs/functions/ensurePolygonPoints.html b/docs/functions/ensurePolygonPoints.html
@@ -26,7 +26,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5>points: <a href="../interfaces/PotentialVector.html" class="tsd-signature-type" data-tsd-kind="Interface">PotentialVector</a><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="../classes/SATVector.html" class="tsd-signature-type" data-tsd-kind="Class">SATVector</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/3d50495/src/utils.ts#L50">src/utils.ts:50</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/340df35/src/utils.ts#L50">src/utils.ts:50</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

diff --git a/docs/functions/ensureVectorPoint.html b/docs/functions/ensureVectorPoint.html
@@ -26,7 +26,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5>point: <a href="../interfaces/PotentialVector.html" class="tsd-signature-type" data-tsd-kind="Interface">PotentialVector</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="../classes/SATVector.html" class="tsd-signature-type" data-tsd-kind="Class">SATVector</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/3d50495/src/utils.ts#L41">src/utils.ts:41</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/340df35/src/utils.ts#L41">src/utils.ts:41</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

diff --git a/docs/functions/extendBody.html b/docs/functions/extendBody.html
@@ -28,7 +28,7 @@ <h5>body: <a href="../types/Body.html" class="tsd-signature-type" data-tsd-kind=
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../interfaces/BodyOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BodyOptions</a></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/3d50495/src/utils.ts#L86">src/utils.ts:86</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/340df35/src/utils.ts#L86">src/utils.ts:86</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

diff --git a/docs/functions/getBounceDirection.html b/docs/functions/getBounceDirection.html
@@ -28,7 +28,7 @@ <h5>body: <a href="../interfaces/Vector.html" class="tsd-signature-type" data-ts
 <h5>collider: <a href="../interfaces/Vector.html" class="tsd-signature-type" data-tsd-kind="Interface">Vector</a></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="../interfaces/Vector.html" class="tsd-signature-type" data-tsd-kind="Interface">Vector</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/3d50495/src/utils.ts#L257">src/utils.ts:257</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/340df35/src/utils.ts#L257">src/utils.ts:257</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

diff --git a/docs/functions/intersectLineCircle.html b/docs/functions/intersectLineCircle.html
@@ -26,7 +26,7 @@ <h5>line: <a href="../classes/Line.html" class="tsd-signature-type" data-tsd-kin
 <h5>circle: <a href="../classes/Circle.html" class="tsd-signature-type" data-tsd-kind="Class">Circle</a></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="../interfaces/Vector.html" class="tsd-signature-type" data-tsd-kind="Interface">Vector</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/3d50495/src/utils.ts#L147">src/utils.ts:147</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/340df35/src/utils.ts#L147">src/utils.ts:147</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

diff --git a/docs/functions/intersectLineLine.html b/docs/functions/intersectLineLine.html
@@ -26,7 +26,7 @@ <h5>line1: <a href="../classes/Line.html" class="tsd-signature-type" data-tsd-ki
 <h5>line2: <a href="../classes/Line.html" class="tsd-signature-type" data-tsd-kind="Class">Line</a></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="../interfaces/Vector.html" class="tsd-signature-type" data-tsd-kind="Interface">Vector</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/3d50495/src/utils.ts#L179">src/utils.ts:179</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/Prozi/detect-collisions/blob/340df35/src/utils.ts#L179">src/utils.ts:179</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">