update javadocs

This commit is contained in:
2022-07-25 23:26:54 -05:00
parent 34d9a2326e
commit e8e82fbc95
3047 changed files with 210375 additions and 2825 deletions

View File

@ -34,6 +34,7 @@ loadScripts(document, 'script');</script>
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/PlayerProfile.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
@ -158,7 +159,7 @@ extends <a href="../../../../org/bukkit/profile/PlayerProfile.html" title="inter
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#hasTextures()" class="member-name-link">hasTextures</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Whether or not this Profile has textures associated to it</div>
<div class="block">Whether this Profile has textures associated to it</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isComplete()" class="member-name-link">isComplete</a>()</code></div>
@ -205,6 +206,11 @@ extends <a href="../../../../org/bukkit/profile/PlayerProfile.html" title="inter
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Copies the given textures.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a>&lt;<a href="PlayerProfile.html" title="interface in com.destroystokyo.paper.profile">PlayerProfile</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#update()" class="member-name-link">update</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Produces an updated player profile based on this profile.</div>
</div>
</div>
</div>
</div>
@ -213,7 +219,7 @@ extends <a href="../../../../org/bukkit/profile/PlayerProfile.html" title="inter
<code><a href="../../../../org/bukkit/configuration/serialization/ConfigurationSerializable.html#serialize()">serialize</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.bukkit.profile.PlayerProfile">Methods inherited from interface&nbsp;org.bukkit.profile.<a href="../../../../org/bukkit/profile/PlayerProfile.html" title="interface in org.bukkit.profile">PlayerProfile</a></h3>
<code><a href="../../../../org/bukkit/profile/PlayerProfile.html#clone()">clone</a>, <a href="../../../../org/bukkit/profile/PlayerProfile.html#getUniqueId()">getUniqueId</a>, <a href="../../../../org/bukkit/profile/PlayerProfile.html#update()">update</a></code></div>
<code><a href="../../../../org/bukkit/profile/PlayerProfile.html#clone()">clone</a>, <a href="../../../../org/bukkit/profile/PlayerProfile.html#getUniqueId()">getUniqueId</a></code></div>
</section>
</li>
</ul>
@ -525,13 +531,53 @@ extends <a href="../../../../org/bukkit/profile/PlayerProfile.html" title="inter
</section>
</li>
<li>
<section class="detail" id="update()">
<h3>update</h3>
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a>&lt;<a href="PlayerProfile.html" title="interface in com.destroystokyo.paper.profile">PlayerProfile</a>&gt;</span>&nbsp;<span class="element-name">update</span>()</div>
<div class="block">Produces an updated player profile based on this profile.
<p>
This tries to produce a completed profile by filling in missing
properties (name, unique id, textures, etc.), and updates existing
properties (e.g. name, textures, etc.) to their official and up-to-date
values. This operation does not alter the current profile, but produces a
new updated <a href="PlayerProfile.html" title="interface in com.destroystokyo.paper.profile"><code>PlayerProfile</code></a>.
<p>
If no player exists for the unique id or name of this profile, this
operation yields a profile that is equal to the current profile, which
might not be complete.
<p>
This is an asynchronous operation: Updating the profile can result in an
outgoing connection in another thread in order to fetch the latest
profile properties. The returned <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link"><code>CompletableFuture</code></a> will be
completed once the updated profile is available. In order to not block
the server's main thread, you should not wait for the result of the
returned CompletableFuture on the server's main thread. Instead, if you
want to do something with the updated player profile on the server's main
thread once it is available, you could do something like this:
<pre>
profile.update().thenAcceptAsync(updatedProfile -> {
// Do something with the updated profile:
// ...
}, runnable -> Bukkit.getScheduler().runTask(plugin, runnable));
</pre></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../../../org/bukkit/profile/PlayerProfile.html#update()">update</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/bukkit/profile/PlayerProfile.html" title="interface in org.bukkit.profile">PlayerProfile</a></code></dd>
<dt>Returns:</dt>
<dd>a completable future that gets completed with the updated
PlayerProfile once it is available</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="hasTextures()">
<h3>hasTextures</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">hasTextures</span>()</div>
<div class="block">Whether or not this Profile has textures associated to it</div>
<div class="block">Whether this Profile has textures associated to it</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>If has a textures property</dd>
<dd>If it has a textures property</dd>
</dl>
</section>
</li>