Update Javadocs

alpine-client · Aug 22, 2024 · 86a62b9 · 86a62b9
1 parent e72f527
commit 86a62b9
Show file tree

Hide file tree

Showing 36 changed files with 136 additions and 108 deletions.
diff --git a/docs/allclasses-frame.html b/docs/allclasses-frame.html
@@ -3,7 +3,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>All Classes (Alpine Client API 1.3.0 API)</title>
+<title>All Classes (Alpine Client API 1.3.1 API)</title>
 <link rel="stylesheet" type="text/css" href="dracula-stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/docs/allclasses-noframe.html b/docs/allclasses-noframe.html
@@ -3,7 +3,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>All Classes (Alpine Client API 1.3.0 API)</title>
+<title>All Classes (Alpine Client API 1.3.1 API)</title>
 <link rel="stylesheet" type="text/css" href="dracula-stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/docs/com/alpineclient/plugin/api/AlpineClientApi.html b/docs/com/alpineclient/plugin/api/AlpineClientApi.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>AlpineClientApi (Alpine Client API 1.3.0 API)</title>
+<title>AlpineClientApi (Alpine Client API 1.3.1 API)</title>
 <link rel="stylesheet" type="text/css" href="../../../../dracula-stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="AlpineClientApi (Alpine Client API 1.3.0 API)";
+            parent.document.title="AlpineClientApi (Alpine Client API 1.3.1 API)";
         }
     }
     catch(err) {
@@ -262,7 +262,7 @@ <h4>isPlayerConnected</h4>
 <h4>getPlayer</h4>
 <pre>@NotNull
 public static&nbsp;@NotNull java.util.Optional&lt;<a href="../../../../com/alpineclient/plugin/api/objects/AlpinePlayer.html" title="class in com.alpineclient.plugin.api.objects">AlpinePlayer</a>&gt;&nbsp;getPlayer(@NotNull
-                                                                            @NotNull org.bukkit.entity.Player&nbsp;player)</pre>
+                                                                           @NotNull org.bukkit.entity.Player&nbsp;player)</pre>
 <div class="block">Get a player connected via Alpine Client.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
@@ -282,7 +282,7 @@ <h4>getPlayer</h4>
 <h4>getPlayer</h4>
 <pre>@NotNull
 public static&nbsp;@NotNull java.util.Optional&lt;<a href="../../../../com/alpineclient/plugin/api/objects/AlpinePlayer.html" title="class in com.alpineclient.plugin.api.objects">AlpinePlayer</a>&gt;&nbsp;getPlayer(@NotNull
-                                                                            @NotNull java.util.UUID&nbsp;id)</pre>
+                                                                           @NotNull java.util.UUID&nbsp;id)</pre>
 <div class="block">Get a player connected via Alpine Client.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>

diff --git a/docs/com/alpineclient/plugin/api/event/ClientDisconnectEvent.html b/docs/com/alpineclient/plugin/api/event/ClientDisconnectEvent.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>ClientDisconnectEvent (Alpine Client API 1.3.0 API)</title>
+<title>ClientDisconnectEvent (Alpine Client API 1.3.1 API)</title>
 <link rel="stylesheet" type="text/css" href="../../../../../dracula-stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="ClientDisconnectEvent (Alpine Client API 1.3.0 API)";
+            parent.document.title="ClientDisconnectEvent (Alpine Client API 1.3.1 API)";
         }
     }
     catch(err) {
@@ -220,7 +220,7 @@ <h3>Constructor Detail</h3>
 <h4>ClientDisconnectEvent</h4>
 <pre>@ApiStatus.Internal
 public&nbsp;ClientDisconnectEvent(@NotNull
-                                                  @NotNull <a href="../../../../../com/alpineclient/plugin/api/objects/AlpinePlayer.html" title="class in com.alpineclient.plugin.api.objects">AlpinePlayer</a>&nbsp;player)</pre>
+                                                 @NotNull <a href="../../../../../com/alpineclient/plugin/api/objects/AlpinePlayer.html" title="class in com.alpineclient.plugin.api.objects">AlpinePlayer</a>&nbsp;player)</pre>
 </li>
 </ul>
 </li>

diff --git a/docs/com/alpineclient/plugin/api/event/ClientHandshakeEvent.html b/docs/com/alpineclient/plugin/api/event/ClientHandshakeEvent.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>ClientHandshakeEvent (Alpine Client API 1.3.0 API)</title>
+<title>ClientHandshakeEvent (Alpine Client API 1.3.1 API)</title>
 <link rel="stylesheet" type="text/css" href="../../../../../dracula-stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="ClientHandshakeEvent (Alpine Client API 1.3.0 API)";
+            parent.document.title="ClientHandshakeEvent (Alpine Client API 1.3.1 API)";
         }
     }
     catch(err) {
@@ -220,7 +220,7 @@ <h3>Constructor Detail</h3>
 <h4>ClientHandshakeEvent</h4>
 <pre>@ApiStatus.Internal
 public&nbsp;ClientHandshakeEvent(@NotNull
-                                                 @NotNull <a href="../../../../../com/alpineclient/plugin/api/objects/AlpinePlayer.html" title="class in com.alpineclient.plugin.api.objects">AlpinePlayer</a>&nbsp;player)</pre>
+                                                @NotNull <a href="../../../../../com/alpineclient/plugin/api/objects/AlpinePlayer.html" title="class in com.alpineclient.plugin.api.objects">AlpinePlayer</a>&nbsp;player)</pre>
 </li>
 </ul>
 </li>

diff --git a/docs/com/alpineclient/plugin/api/event/package-frame.html b/docs/com/alpineclient/plugin/api/event/package-frame.html
@@ -3,7 +3,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>com.alpineclient.plugin.api.event (Alpine Client API 1.3.0 API)</title>
+<title>com.alpineclient.plugin.api.event (Alpine Client API 1.3.1 API)</title>
 <link rel="stylesheet" type="text/css" href="../../../../../dracula-stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 </head>

diff --git a/docs/com/alpineclient/plugin/api/event/package-summary.html b/docs/com/alpineclient/plugin/api/event/package-summary.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>com.alpineclient.plugin.api.event (Alpine Client API 1.3.0 API)</title>
+<title>com.alpineclient.plugin.api.event (Alpine Client API 1.3.1 API)</title>
 <link rel="stylesheet" type="text/css" href="../../../../../dracula-stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="com.alpineclient.plugin.api.event (Alpine Client API 1.3.0 API)";
+            parent.document.title="com.alpineclient.plugin.api.event (Alpine Client API 1.3.1 API)";
         }
     }
     catch(err) {

diff --git a/docs/com/alpineclient/plugin/api/event/package-tree.html b/docs/com/alpineclient/plugin/api/event/package-tree.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>com.alpineclient.plugin.api.event Class Hierarchy (Alpine Client API 1.3.0 API)</title>
+<title>com.alpineclient.plugin.api.event Class Hierarchy (Alpine Client API 1.3.1 API)</title>
 <link rel="stylesheet" type="text/css" href="../../../../../dracula-stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="com.alpineclient.plugin.api.event Class Hierarchy (Alpine Client API 1.3.0 API)";
+            parent.document.title="com.alpineclient.plugin.api.event Class Hierarchy (Alpine Client API 1.3.1 API)";
         }
     }
     catch(err) {

diff --git a/docs/com/alpineclient/plugin/api/objects/AlpinePlayer.html b/docs/com/alpineclient/plugin/api/objects/AlpinePlayer.html
@@ -3,22 +3,22 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>AlpinePlayer (Alpine Client API 1.3.0 API)</title>
+<title>AlpinePlayer (Alpine Client API 1.3.1 API)</title>
 <link rel="stylesheet" type="text/css" href="../../../../../dracula-stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="AlpinePlayer (Alpine Client API 1.3.0 API)";
+            parent.document.title="AlpinePlayer (Alpine Client API 1.3.1 API)";
         }
     }
     catch(err) {
     }
 //-->
-var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10};
-var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
+var methods = {"i0":10,"i1":10,"i2":10,"i3":42,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10};
+var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
 var tableTab = "tableTab";
@@ -137,10 +137,9 @@ <h3>Constructor Summary</h3>
             @NotNull com.alpineclient.plugin.util.object.HandshakeData&nbsp;data)</code>&nbsp;</td>
 </tr>
 <tr class="rowColor">
-<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/alpineclient/plugin/api/objects/AlpinePlayer.html#AlpinePlayer-org.bukkit.entity.Player-java.lang.String-java.lang.String-java.util.List-">AlpinePlayer</a></span>(@NotNull org.bukkit.entity.Player&nbsp;bukkitPlayer,
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/alpineclient/plugin/api/objects/AlpinePlayer.html#AlpinePlayer-org.bukkit.entity.Player-java.lang.String-java.lang.String-">AlpinePlayer</a></span>(@NotNull org.bukkit.entity.Player&nbsp;bukkitPlayer,
             @NotNull java.lang.String&nbsp;platform,
-            @NotNull java.lang.String&nbsp;version,
-            @NotNull java.util.List&lt;java.lang.String&gt;&nbsp;mods)</code>&nbsp;</td>
+            @NotNull java.lang.String&nbsp;version)</code>&nbsp;</td>
 </tr>
 </table>
 </li>
@@ -152,7 +151,7 @@ <h3>Constructor Summary</h3>
 </a>
 <h3>Method Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
-<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Method and Description</th>
@@ -179,7 +178,9 @@ <h3>Method Summary</h3>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code>@NotNull java.util.List&lt;java.lang.String&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/alpineclient/plugin/api/objects/AlpinePlayer.html#getMods--">getMods</a></span>()</code>
-<div class="block">Get all the user's loaded mod IDs.</div>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
+<div class="block"><span class="deprecationComment">functionality removed; no replacement</span></div>
+</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
@@ -242,26 +243,24 @@ <h3>Constructor Detail</h3>
 <h4>AlpinePlayer</h4>
 <pre>@ApiStatus.Internal
 public&nbsp;AlpinePlayer(@NotNull
-                                         @NotNull org.bukkit.entity.Player&nbsp;bukkitPlayer,
-                                         @NotNull
-                                         @NotNull com.alpineclient.plugin.util.object.HandshakeData&nbsp;data)</pre>
+                                        @NotNull org.bukkit.entity.Player&nbsp;bukkitPlayer,
+                                        @NotNull
+                                        @NotNull com.alpineclient.plugin.util.object.HandshakeData&nbsp;data)</pre>
 </li>
 </ul>
-<a name="AlpinePlayer-org.bukkit.entity.Player-java.lang.String-java.lang.String-java.util.List-">
+<a name="AlpinePlayer-org.bukkit.entity.Player-java.lang.String-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>AlpinePlayer</h4>
 <pre>@ApiStatus.Internal
 public&nbsp;AlpinePlayer(@NotNull
-                                         @NotNull org.bukkit.entity.Player&nbsp;bukkitPlayer,
-                                         @NotNull
-                                         @NotNull java.lang.String&nbsp;platform,
-                                         @NotNull
-                                         @NotNull java.lang.String&nbsp;version,
-                                         @NotNull
-                                         @NotNull java.util.List&lt;java.lang.String&gt;&nbsp;mods)</pre>
+                                        @NotNull org.bukkit.entity.Player&nbsp;bukkitPlayer,
+                                        @NotNull
+                                        @NotNull java.lang.String&nbsp;platform,
+                                        @NotNull
+                                        @NotNull java.lang.String&nbsp;version)</pre>
 </li>
 </ul>
 </li>
@@ -327,8 +326,11 @@ <h4>getVersion</h4>
 <ul class="blockList">
 <li class="blockList">
 <h4>getMods</h4>
-<pre>@NotNull
+<pre>@Deprecated
+ @ApiStatus.ScheduledForRemoval(inVersion="1.4.0")
+ @NotNull
 public&nbsp;@NotNull java.util.List&lt;java.lang.String&gt;&nbsp;getMods()</pre>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">functionality removed; no replacement</span></div>
 <div class="block">Get all the user's loaded mod IDs.
  <p>
  e.g. <code>["sodium", "lithium", "alpineclient"]</code></div>
@@ -349,7 +351,7 @@ <h4>getClientBrand</h4>
 <div class="block">Get the full client brand consisting of their version
  and platform.
  <p>
- e.g. <code>1.20-fabric</code></div>
+ e.g. <code>1.18.2-fabric</code></div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the client brand</dd>

diff --git a/docs/com/alpineclient/plugin/api/objects/Capability.html b/docs/com/alpineclient/plugin/api/objects/Capability.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>Capability (Alpine Client API 1.3.0 API)</title>
+<title>Capability (Alpine Client API 1.3.1 API)</title>
 <link rel="stylesheet" type="text/css" href="../../../../../dracula-stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="Capability (Alpine Client API 1.3.0 API)";
+            parent.document.title="Capability (Alpine Client API 1.3.1 API)";
         }
     }
     catch(err) {
@@ -290,7 +290,7 @@ <h4>fromId</h4>
 <pre>@ApiStatus.Internal
  @Nullable
 public static&nbsp;@Nullable <a href="../../../../../com/alpineclient/plugin/api/objects/Capability.html" title="enum in com.alpineclient.plugin.api.objects">Capability</a>&nbsp;fromId(@NotNull
-                                                                           @NotNull java.lang.String&nbsp;id)</pre>
+                                                                         @NotNull java.lang.String&nbsp;id)</pre>
 </li>
 </ul>
 </li>

diff --git a/docs/com/alpineclient/plugin/api/objects/ClientResource.Type.html b/docs/com/alpineclient/plugin/api/objects/ClientResource.Type.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>ClientResource.Type (Alpine Client API 1.3.0 API)</title>
+<title>ClientResource.Type (Alpine Client API 1.3.1 API)</title>
 <link rel="stylesheet" type="text/css" href="../../../../../dracula-stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="ClientResource.Type (Alpine Client API 1.3.0 API)";
+            parent.document.title="ClientResource.Type (Alpine Client API 1.3.1 API)";
         }
     }
     catch(err) {

diff --git a/docs/com/alpineclient/plugin/api/objects/ClientResource.html b/docs/com/alpineclient/plugin/api/objects/ClientResource.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>ClientResource (Alpine Client API 1.3.0 API)</title>
+<title>ClientResource (Alpine Client API 1.3.1 API)</title>
 <link rel="stylesheet" type="text/css" href="../../../../../dracula-stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="ClientResource (Alpine Client API 1.3.0 API)";
+            parent.document.title="ClientResource (Alpine Client API 1.3.1 API)";
         }
     }
     catch(err) {
@@ -292,7 +292,7 @@ <h4>hashCode</h4>
 <h4>internal</h4>
 <pre>@NotNull
 public static&nbsp;@NotNull <a href="../../../../../com/alpineclient/plugin/api/objects/ClientResource.html" title="class in com.alpineclient.plugin.api.objects">ClientResource</a>&nbsp;internal(@NotNull
-                                                         @NotNull java.lang.String&nbsp;value)</pre>
+                                                        @NotNull java.lang.String&nbsp;value)</pre>
 <div class="block">Compiles an internal resource.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
@@ -312,7 +312,7 @@ <h4>internal</h4>
 <h4>external</h4>
 <pre>@NotNull
 public static&nbsp;@NotNull <a href="../../../../../com/alpineclient/plugin/api/objects/ClientResource.html" title="class in com.alpineclient.plugin.api.objects">ClientResource</a>&nbsp;external(@NotNull
-                                                         @NotNull java.lang.String&nbsp;value)</pre>
+                                                        @NotNull java.lang.String&nbsp;value)</pre>
 <div class="block">Compiles an external resource.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>