Skip to content

Commit

Permalink
[skip ci]: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JadlionHD committed Jul 6, 2024
1 parent a0c7786 commit 9cbc7f7
Show file tree
Hide file tree
Showing 34 changed files with 998 additions and 380 deletions.
28 changes: 14 additions & 14 deletions docs/assets/highlight.css
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@
--dark-hl-1: #D4D4D4;
--light-hl-2: #A31515;
--dark-hl-2: #CE9178;
--light-hl-3: #0000FF;
--dark-hl-3: #569CD6;
--light-hl-4: #0070C1;
--dark-hl-4: #4FC1FF;
--light-hl-5: #001080;
--dark-hl-5: #9CDCFE;
--light-hl-6: #000000FF;
--dark-hl-6: #D4D4D4;
--light-hl-7: #EE0000;
--dark-hl-7: #D7BA7D;
--light-hl-8: #098658;
--dark-hl-8: #B5CEA8;
--light-hl-9: #AF00DB;
--dark-hl-9: #C586C0;
--light-hl-3: #AF00DB;
--dark-hl-3: #C586C0;
--light-hl-4: #001080;
--dark-hl-4: #9CDCFE;
--light-hl-5: #0000FF;
--dark-hl-5: #569CD6;
--light-hl-6: #0070C1;
--dark-hl-6: #4FC1FF;
--light-hl-7: #000000FF;
--dark-hl-7: #D4D4D4;
--light-hl-8: #EE0000;
--dark-hl-8: #D7BA7D;
--light-hl-9: #098658;
--dark-hl-9: #B5CEA8;
--light-hl-10: #008000;
--dark-hl-10: #6A9955;
--light-code-background: #FFFFFF;
Expand Down
2 changes: 1 addition & 1 deletion docs/assets/search.js

Large diffs are not rendered by default.

64 changes: 34 additions & 30 deletions docs/classes/Client.html

Large diffs are not rendered by default.

18 changes: 11 additions & 7 deletions docs/classes/GrowApi.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">GrowApi</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/a51670e/src/structures/GrowApi.ts#L4">src/structures/GrowApi.ts:4</a></li></ul></aside>
<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/a0c7786/src/structures/GrowApi.ts#L4">src/structures/GrowApi.ts:4</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">
Expand Down Expand Up @@ -50,14 +50,14 @@ <h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <a href="GrowApi.html" class="tsd-signature-type tsd-kind-class">GrowApi</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/a51670e/src/structures/GrowApi.ts#L7">src/structures/GrowApi.ts:7</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/a0c7786/src/structures/GrowApi.ts#L7">src/structures/GrowApi.ts:7</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="client" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>client</span><a href="#client" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></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/a51670e/src/structures/GrowApi.ts#L5">src/structures/GrowApi.ts:5</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/a0c7786/src/structures/GrowApi.ts#L5">src/structures/GrowApi.ts:5</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="init" class="tsd-anchor"></a>
Expand All @@ -72,7 +72,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5><span class="tsd-kind-parameter">client</span>: <a href="Client.html" class="tsd-signature-type tsd-kind-class">Client</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/JadlionHD/growtopia.js/blob/a51670e/src/structures/GrowApi.ts#L9">src/structures/GrowApi.ts:9</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/a0c7786/src/structures/GrowApi.ts#L9">src/structures/GrowApi.ts:9</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="onConnect" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>on<wbr/>Connect</span><a href="#onConnect" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand All @@ -85,7 +85,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<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 <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/a51670e/src/structures/GrowApi.ts#L13">src/structures/GrowApi.ts:13</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/a0c7786/src/structures/GrowApi.ts#L13">src/structures/GrowApi.ts:13</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="onDisconnect" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>on<wbr/>Disconnect</span><a href="#onDisconnect" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand All @@ -98,7 +98,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<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 <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/a51670e/src/structures/GrowApi.ts#L14">src/structures/GrowApi.ts:14</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/a0c7786/src/structures/GrowApi.ts#L14">src/structures/GrowApi.ts:14</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="onRaw" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>on<wbr/>Raw</span><a href="#onRaw" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand All @@ -113,7 +113,7 @@ <h5><span class="tsd-kind-parameter">netID</span>: <span class="tsd-signature-ty
<h5><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type ">Buffer</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/JadlionHD/growtopia.js/blob/a51670e/src/structures/GrowApi.ts#L15">src/structures/GrowApi.ts:15</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/JadlionHD/growtopia.js/blob/a0c7786/src/structures/GrowApi.ts#L15">src/structures/GrowApi.ts:15</a></li></ul></aside></li></ul></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down Expand Up @@ -153,10 +153,14 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="../interfaces/Caching.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Caching</span></a></li>
<li><a href="../interfaces/ClientOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Client<wbr/>Options</span></a></li>
<li><a href="../interfaces/ClientType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Client<wbr/>Type</span></a></li>
<li><a href="../interfaces/ENetServerOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>ENet<wbr/>Server<wbr/>Options</span></a></li>
<li><a href="../interfaces/ExtendString.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Extend<wbr/>String</span></a></li>
<li><a href="../interfaces/HTTPSServerOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>HTTPSServer<wbr/>Options</span></a></li>
<li><a href="../interfaces/ItemDefinition.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Item<wbr/>Definition</span></a></li>
<li><a href="../interfaces/ItemsDatMeta.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Items<wbr/>Dat<wbr/>Meta</span></a></li>
<li><a href="../interfaces/LoginInfo.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Login<wbr/>Info</span></a></li>
<li><a href="../interfaces/NativePeerAddress.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Native<wbr/>Peer<wbr/>Address</span></a></li>
<li><a href="../interfaces/NativePeerMethod.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Native<wbr/>Peer<wbr/>Method</span></a></li>
<li><a href="../interfaces/PeerData.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Peer<wbr/>Data</span></a></li>
<li><a href="../interfaces/StringOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>String<wbr/>Options</span></a></li>
<li><a href="../interfaces/Tank.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Tank</span></a></li>
Expand Down
Loading

0 comments on commit 9cbc7f7

Please sign in to comment.