Skip to content

Commit

Permalink
docs: update docs v1.4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
JadlionHD committed May 29, 2024
1 parent 0640ffb commit 3187cd7
Show file tree
Hide file tree
Showing 40 changed files with 898 additions and 630 deletions.
2 changes: 1 addition & 1 deletion docs/assets/search.js

Large diffs are not rendered by default.

41 changes: 21 additions & 20 deletions docs/classes/Client.html

Large diffs are not rendered by default.

15 changes: 8 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/4843739/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/bf97d01/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/4843739/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/bf97d01/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/4843739/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/bf97d01/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/4843739/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/bf97d01/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/4843739/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/bf97d01/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/4843739/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/bf97d01/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/4843739/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/bf97d01/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 @@ -163,6 +163,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<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/DataObject.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Data<wbr/>Object</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/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>
Expand Down
Loading

0 comments on commit 3187cd7

Please sign in to comment.