regenerate docs

StileDevs · May 30, 2023 · 47ce4c9 · 47ce4c9
1 parent edc19c2
commit 47ce4c9
Show file tree

Hide file tree

Showing 30 changed files with 645 additions and 442 deletions.
diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/classes/Client.html b/docs/classes/Client.html
diff --git a/docs/classes/Peer.html b/docs/classes/Peer.html
@@ -25,7 +25,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">Peer</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/38bc1c2/src/structures/Peer.ts#L6">src/structures/Peer.ts:6</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/edc19c2/src/structures/Peer.ts#L6">src/structures/Peer.ts:6</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">
@@ -67,19 +67,19 @@ <h5><span class="tsd-kind-parameter">client</span>: <a href="Client.html" class=
 <h5><span class="tsd-kind-parameter">netID</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="Peer.html" class="tsd-signature-type tsd-kind-class">Peer</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/38bc1c2/src/structures/Peer.ts#L9">src/structures/Peer.ts:9</a></li></ul></aside></li></ul></section></section>
+<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/edc19c2/src/structures/Peer.ts#L9">src/structures/Peer.ts:9</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Properties</h2>
 <section class="tsd-panel tsd-member tsd-is-private"><a id="client" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>client</span><a href="#client" 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"><span class="tsd-kind-property">client</span><span class="tsd-signature-symbol">:</span> <a href="Client.html" class="tsd-signature-type tsd-kind-class">Client</a></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/38bc1c2/src/structures/Peer.ts#L9">src/structures/Peer.ts:9</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/edc19c2/src/structures/Peer.ts#L9">src/structures/Peer.ts:9</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="data" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>data</span><a href="#data" 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"><span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type tsd-kind-type-parameter">T</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/38bc1c2/src/structures/Peer.ts#L7">src/structures/Peer.ts:7</a></li></ul></aside></section></section>
+<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/edc19c2/src/structures/Peer.ts#L7">src/structures/Peer.ts:7</a></li></ul></aside></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Methods</h2>
 <section class="tsd-panel tsd-member"><a id="disconnect" class="tsd-anchor"></a>
@@ -98,7 +98,7 @@ <h5><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-typ
 </div></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/JadlionHD/growtopia.js/blob/38bc1c2/src/structures/Peer.ts#L58">src/structures/Peer.ts:58</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/edc19c2/src/structures/Peer.ts#L58">src/structures/Peer.ts:58</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member"><a id="send" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>send</span><a href="#send" 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>
 <ul class="tsd-signatures">
@@ -115,7 +115,7 @@ <h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-sym
 </div></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/JadlionHD/growtopia.js/blob/38bc1c2/src/structures/Peer.ts#L20">src/structures/Peer.ts:20</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/edc19c2/src/structures/Peer.ts#L20">src/structures/Peer.ts:20</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member"><a id="send-2" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>send</span><a href="#send-2" 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>
 <ul class="tsd-signatures">
@@ -140,7 +140,7 @@ <h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-sym
 </div></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/JadlionHD/growtopia.js/blob/38bc1c2/src/structures/Peer.ts#L30">src/structures/Peer.ts:30</a></li></ul></aside></li></ul></section></section></div>
+<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/edc19c2/src/structures/Peer.ts#L30">src/structures/Peer.ts:30</a></li></ul></aside></li></ul></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">
@@ -186,11 +186,13 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
 <li><a href="../interfaces/ActionEvent.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>Action<wbr/>Event</span></a></li>
 <li><a href="../interfaces/ClientOptions.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Client<wbr/>Options</span></a></li>
 <li><a href="../interfaces/ClientType.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Client<wbr/>Type</span></a></li>
+<li><a href="../interfaces/DataObject.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Data<wbr/>Object</span></a></li>
 <li><a href="../interfaces/LoginInfo.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Login<wbr/>Info</span></a></li>
 <li><a href="../interfaces/Tank.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Tank</span></a></li>
 <li><a href="../interfaces/VariantOptions.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Variant<wbr/>Options</span></a></li>
 <li><a href="../types/Sendable.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4194304-path"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)" id="icon-4194304-text"></path></svg><span>Sendable</span></a></li>
-<li><a href="../types/VariantArg.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Variant<wbr/>Arg</span></a></li></ul></nav></div></div></div>
+<li><a href="../types/VariantArg.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Variant<wbr/>Arg</span></a></li>
+<li><a href="../functions/parseAction.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-64-path"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)" id="icon-64-text"></path></svg><span>parse<wbr/>Action</span></a></li></ul></nav></div></div></div>
 <div class="tsd-generator">
 <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
 <div class="overlay"></div></body></html>
diff --git a/docs/classes/TankPacket.html b/docs/classes/TankPacket.html
@@ -23,7 +23,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">TankPacket</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/38bc1c2/src/packets/TankPacket.ts#L8">src/packets/TankPacket.ts:8</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/edc19c2/src/packets/TankPacket.ts#L8">src/packets/TankPacket.ts:8</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">
@@ -61,7 +61,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
 </div></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="TankPacket.html" class="tsd-signature-type tsd-kind-class">TankPacket</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/38bc1c2/src/packets/TankPacket.ts#L13">src/packets/TankPacket.ts:13</a></li></ul></aside></li></ul></section></section>
+<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/edc19c2/src/packets/TankPacket.ts#L13">src/packets/TankPacket.ts:13</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Properties</h2>
 <section class="tsd-panel tsd-member"><a id="data" class="tsd-anchor"></a>
@@ -70,7 +70,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
 <div class="tsd-comment tsd-typography"><p>The tankpacket header and data.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/38bc1c2/src/packets/TankPacket.ts#L13">src/packets/TankPacket.ts:13</a></li></ul></aside></section></section>
+<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/edc19c2/src/packets/TankPacket.ts#L13">src/packets/TankPacket.ts:13</a></li></ul></aside></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Methods</h2>
 <section class="tsd-panel tsd-member"><a id="parse" class="tsd-anchor"></a>
@@ -82,7 +82,7 @@ <h3 class="tsd-anchor-link"><span>parse</span><a href="#parse" aria-label="Perma
 </div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Buffer</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/38bc1c2/src/packets/TankPacket.ts#L55">src/packets/TankPacket.ts:55</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/edc19c2/src/packets/TankPacket.ts#L55">src/packets/TankPacket.ts:55</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member"><a id="from" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from</span><a href="#from" 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>
 <ul class="tsd-signatures">
@@ -99,7 +99,7 @@ <h5><span class="tsd-kind-parameter">data</span>: <a href="../interfaces/Tank.ht
 </div></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="TankPacket.html" class="tsd-signature-type tsd-kind-class">TankPacket</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/38bc1c2/src/packets/TankPacket.ts#L19">src/packets/TankPacket.ts:19</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/edc19c2/src/packets/TankPacket.ts#L19">src/packets/TankPacket.ts:19</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member"><a id="fromBuffer" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Buffer</span><a href="#fromBuffer" 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>
 <ul class="tsd-signatures">
@@ -116,7 +116,7 @@ <h5><span class="tsd-kind-parameter">buf</span>: <span class="tsd-signature-type
 </div></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="TankPacket.html" class="tsd-signature-type tsd-kind-class">TankPacket</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/38bc1c2/src/packets/TankPacket.ts#L27">src/packets/TankPacket.ts:27</a></li></ul></aside></li></ul></section></section></div>
+<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/edc19c2/src/packets/TankPacket.ts#L27">src/packets/TankPacket.ts:27</a></li></ul></aside></li></ul></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">
@@ -161,11 +161,13 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
 <li><a href="../interfaces/ActionEvent.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>Action<wbr/>Event</span></a></li>
 <li><a href="../interfaces/ClientOptions.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Client<wbr/>Options</span></a></li>
 <li><a href="../interfaces/ClientType.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Client<wbr/>Type</span></a></li>
+<li><a href="../interfaces/DataObject.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Data<wbr/>Object</span></a></li>
 <li><a href="../interfaces/LoginInfo.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Login<wbr/>Info</span></a></li>
 <li><a href="../interfaces/Tank.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Tank</span></a></li>
 <li><a href="../interfaces/VariantOptions.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Variant<wbr/>Options</span></a></li>
 <li><a href="../types/Sendable.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4194304-path"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)" id="icon-4194304-text"></path></svg><span>Sendable</span></a></li>
-<li><a href="../types/VariantArg.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Variant<wbr/>Arg</span></a></li></ul></nav></div></div></div>
+<li><a href="../types/VariantArg.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Variant<wbr/>Arg</span></a></li>
+<li><a href="../functions/parseAction.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-64-path"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)" id="icon-64-text"></path></svg><span>parse<wbr/>Action</span></a></li></ul></nav></div></div></div>
 <div class="tsd-generator">
 <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
 <div class="overlay"></div></body></html>