31699ae9a8
* Updated Upstream (Bukkit/CraftBukkit) Upstream has released updates that appear to apply and compile correctly. This update has not been tested by PaperMC and as with ANY update, please do your own testing Bukkit Changes: a6a9d2a4 Remove some old ApiStatus.Experimental annotations be72314c SPIGOT-7300, PR-829: Add new DamageSource API providing enhanced information about entity damage b252cf05 SPIGOT-7576, PR-970: Add methods in MushroomCow to change stew effects b1c689bd PR-902: Add Server#isLoggingIPs to get log-ips configuration 08f86d1c PR-971: Add Player methods for client-side potion effects 2e3024a9 PR-963: Add API for in-world structures a23292a7 SPIGOT-7530, PR-948: Improve Resource Pack API with new 1.20.3 functionality 1851857b SPIGOT-3071, PR-969: Add entity spawn method with spawn reason cde4c52a SPIGOT-5553, PR-964: Add EntityKnockbackEvent CraftBukkit Changes: 38fd4bd50 Fix accidentally renamed internal damage method 80f0ce4be SPIGOT-7300, PR-1180: Add new DamageSource API providing enhanced information about entity damage 7e43f3b16 SPIGOT-7581: Fix typo in BlockMushroom ea14b7d90 SPIGOT-7576, PR-1347: Add methods in MushroomCow to change stew effects 4c687f243 PR-1259: Add Server#isLoggingIPs to get log-ips configuration 22a541a29 Improve support for per-world game rules cb7dccce2 PR-1348: Add Player methods for client-side potion effects b8d6109f0 PR-1335: Add API for in-world structures 4398a1b5b SPIGOT-7577: Make CraftWindCharge#explode discard the entity e74107678 Fix Crafter maximum stack size 0bb0f4f6a SPIGOT-7530, PR-1314: Improve Resource Pack API with new 1.20.3 functionality 4949f556d SPIGOT-3071, PR-1345: Add entity spawn method with spawn reason 20ac73ca2 PR-1353: Fix Structure#place not working as documented with 0 palette 3c1b77871 SPIGOT-6911, PR-1349: Change max book length in CraftMetaBook 333701839 SPIGOT-7572: Bee nests generated without bees f48f4174c SPIGOT-5553, PR-1336: Add EntityKnockbackEvent
212 lines
11 KiB
Diff
212 lines
11 KiB
Diff
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
|
|
From: Jedediah Smith <jedediah@silencegreys.com>
|
|
Date: Sat, 4 Apr 2015 22:59:54 -0400
|
|
Subject: [PATCH] Complete resource pack API
|
|
|
|
|
|
diff --git a/src/main/java/org/bukkit/entity/Player.java b/src/main/java/org/bukkit/entity/Player.java
|
|
index ba58936116ce1e2e805a03251bb19484058e4f0f..6a8f5720ef33b54b3a89d4299462827ab304e0d9 100644
|
|
--- a/src/main/java/org/bukkit/entity/Player.java
|
|
+++ b/src/main/java/org/bukkit/entity/Player.java
|
|
@@ -2163,6 +2163,180 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
|
|
void setResourcePack(@NotNull UUID uuid, @NotNull String url, byte @Nullable [] hash, net.kyori.adventure.text.@Nullable Component prompt, boolean force);
|
|
// Paper end
|
|
|
|
+ // Paper start - more resource pack API
|
|
+ /**
|
|
+ * Request that the player's client download and switch resource packs.
|
|
+ * <p>
|
|
+ * The player's client will download the new resource pack asynchronously
|
|
+ * in the background, and will automatically switch to it once the
|
|
+ * download is complete. If the client has downloaded and cached the same
|
|
+ * resource pack in the past, it will perform a quick timestamp check
|
|
+ * over the network to determine if the resource pack has changed and
|
|
+ * needs to be downloaded again. When this request is sent for the very
|
|
+ * first time from a given server, the client will first display a
|
|
+ * confirmation GUI to the player before proceeding with the download.
|
|
+ * <p>
|
|
+ * Notes:
|
|
+ * <ul>
|
|
+ * <li>Players can disable server resources on their client, in which
|
|
+ * case this method will have no affect on them.
|
|
+ * <li>To remove a resource pack you can use
|
|
+ * {@link #removeResourcePacks(UUID, UUID...)} or {@link #clearResourcePacks()}.
|
|
+ * </ul>
|
|
+ *
|
|
+ * @param url The URL from which the client will download the resource
|
|
+ * pack. The string must contain only US-ASCII characters and should
|
|
+ * be encoded as per RFC 1738.
|
|
+ * @param hash A 40 character hexadecimal and lowercase SHA-1 digest of
|
|
+ * the resource pack file.
|
|
+ * @throws IllegalArgumentException Thrown if the URL is null.
|
|
+ * @throws IllegalArgumentException Thrown if the URL is too long. The
|
|
+ * length restriction is an implementation specific arbitrary value.
|
|
+ */
|
|
+ default void setResourcePack(final @NotNull String url, final @NotNull String hash) {
|
|
+ this.setResourcePack(url, hash, false);
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Request that the player's client download and switch resource packs.
|
|
+ * <p>
|
|
+ * The player's client will download the new resource pack asynchronously
|
|
+ * in the background, and will automatically switch to it once the
|
|
+ * download is complete. If the client has downloaded and cached the same
|
|
+ * resource pack in the past, it will perform a quick timestamp check
|
|
+ * over the network to determine if the resource pack has changed and
|
|
+ * needs to be downloaded again. When this request is sent for the very
|
|
+ * first time from a given server, the client will first display a
|
|
+ * confirmation GUI to the player before proceeding with the download.
|
|
+ * <p>
|
|
+ * Notes:
|
|
+ * <ul>
|
|
+ * <li>Players can disable server resources on their client, in which
|
|
+ * case this method will have no affect on them.
|
|
+ * <li>To remove a resource pack you can use
|
|
+ * {@link #removeResourcePacks(UUID, UUID...)} or {@link #clearResourcePacks()}.
|
|
+ * </ul>
|
|
+ *
|
|
+ * @param url The URL from which the client will download the resource
|
|
+ * pack. The string must contain only US-ASCII characters and should
|
|
+ * be encoded as per RFC 1738.
|
|
+ * @param hash A 40 character hexadecimal and lowercase SHA-1 digest of
|
|
+ * the resource pack file.
|
|
+ * @param required Marks if the resource pack should be required by the client
|
|
+ * @throws IllegalArgumentException Thrown if the URL is null.
|
|
+ * @throws IllegalArgumentException Thrown if the URL is too long. The
|
|
+ * length restriction is an implementation specific arbitrary value.
|
|
+ */
|
|
+ default void setResourcePack(final @NotNull String url, final @NotNull String hash, final boolean required) {
|
|
+ this.setResourcePack(url, hash, required, null);
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Request that the player's client download and switch resource packs.
|
|
+ * <p>
|
|
+ * The player's client will download the new resource pack asynchronously
|
|
+ * in the background, and will automatically switch to it once the
|
|
+ * download is complete. If the client has downloaded and cached the same
|
|
+ * resource pack in the past, it will perform a quick timestamp check
|
|
+ * over the network to determine if the resource pack has changed and
|
|
+ * needs to be downloaded again. When this request is sent for the very
|
|
+ * first time from a given server, the client will first display a
|
|
+ * confirmation GUI to the player before proceeding with the download.
|
|
+ * <p>
|
|
+ * Notes:
|
|
+ * <ul>
|
|
+ * <li>Players can disable server resources on their client, in which
|
|
+ * case this method will have no affect on them.
|
|
+ * <li>To remove a resource pack you can use
|
|
+ * {@link #removeResourcePacks(UUID, UUID...)} or {@link #clearResourcePacks()}.
|
|
+ * </ul>
|
|
+ *
|
|
+ * @param url The URL from which the client will download the resource
|
|
+ * pack. The string must contain only US-ASCII characters and should
|
|
+ * be encoded as per RFC 1738.
|
|
+ * @param hash A 40 character hexadecimal and lowercase SHA-1 digest of
|
|
+ * the resource pack file.
|
|
+ * @param required Marks if the resource pack should be required by the client
|
|
+ * @param resourcePackPrompt A Prompt to be displayed in the client request
|
|
+ * @throws IllegalArgumentException Thrown if the URL is null.
|
|
+ * @throws IllegalArgumentException Thrown if the URL is too long. The
|
|
+ * length restriction is an implementation specific arbitrary value.
|
|
+ */
|
|
+ default void setResourcePack(final @NotNull String url, final @NotNull String hash, final boolean required, final net.kyori.adventure.text.@Nullable Component resourcePackPrompt) {
|
|
+ this.setResourcePack(UUID.nameUUIDFromBytes(url.getBytes(java.nio.charset.StandardCharsets.UTF_8)), url, hash, resourcePackPrompt, required);
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Request that the player's client download and switch resource packs.
|
|
+ * <p>
|
|
+ * The player's client will download the new resource pack asynchronously
|
|
+ * in the background, and will automatically switch to it once the
|
|
+ * download is complete. If the client has downloaded and cached the same
|
|
+ * resource pack in the past, it will perform a quick timestamp check
|
|
+ * over the network to determine if the resource pack has changed and
|
|
+ * needs to be downloaded again. When this request is sent for the very
|
|
+ * first time from a given server, the client will first display a
|
|
+ * confirmation GUI to the player before proceeding with the download.
|
|
+ * <p>
|
|
+ * Notes:
|
|
+ * <ul>
|
|
+ * <li>Players can disable server resources on their client, in which
|
|
+ * case this method will have no affect on them.
|
|
+ * <li>To remove a resource pack you can use
|
|
+ * {@link #removeResourcePacks(UUID, UUID...)} or {@link #clearResourcePacks()}.
|
|
+ * </ul>
|
|
+ *
|
|
+ * @param uuid Unique resource pack ID.
|
|
+ * @param url The URL from which the client will download the resource
|
|
+ * pack. The string must contain only US-ASCII characters and should
|
|
+ * be encoded as per RFC 1738.
|
|
+ * @param hash A 40 character hexadecimal and lowercase SHA-1 digest of
|
|
+ * the resource pack file.
|
|
+ * @param resourcePackPrompt A Prompt to be displayed in the client request
|
|
+ * @param required Marks if the resource pack should be required by the client
|
|
+ * @throws IllegalArgumentException Thrown if the URL is null.
|
|
+ * @throws IllegalArgumentException Thrown if the URL is too long. The
|
|
+ * length restriction is an implementation specific arbitrary value.
|
|
+ */
|
|
+ default void setResourcePack(final @NotNull UUID uuid, final @NotNull String url, final @NotNull String hash, final net.kyori.adventure.text.@Nullable Component resourcePackPrompt, final boolean required) {
|
|
+ this.sendResourcePacks(net.kyori.adventure.resource.ResourcePackRequest.resourcePackRequest()
|
|
+ .required(required)
|
|
+ .replace(true)
|
|
+ .prompt(resourcePackPrompt)
|
|
+ .packs(net.kyori.adventure.resource.ResourcePackInfo.resourcePackInfo(uuid, java.net.URI.create(url), hash))
|
|
+ );
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Gets the most recent resource pack status from the player.
|
|
+ *
|
|
+ * @return the most recent status or null
|
|
+ */
|
|
+ org.bukkit.event.player.PlayerResourcePackStatusEvent.@Nullable Status getResourcePackStatus();
|
|
+
|
|
+ /**
|
|
+ * Gets the most recent pack hash from the player.
|
|
+ *
|
|
+ * @return the most recent hash or null
|
|
+ * @deprecated This is no longer sent from the client and will always be null
|
|
+ */
|
|
+ @Deprecated(forRemoval = true)
|
|
+ @org.jetbrains.annotations.Contract("-> null")
|
|
+ default @Nullable String getResourcePackHash() {
|
|
+ return null;
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Gets if the last resource pack status from the player
|
|
+ * was {@link org.bukkit.event.player.PlayerResourcePackStatusEvent.Status#SUCCESSFULLY_LOADED}.
|
|
+ *
|
|
+ * @return true if last status was successfully loaded
|
|
+ */
|
|
+ default boolean hasResourcePack() {
|
|
+ return this.getResourcePackStatus() == org.bukkit.event.player.PlayerResourcePackStatusEvent.Status.SUCCESSFULLY_LOADED;
|
|
+ }
|
|
+ // Paper end - more resource pack API
|
|
+
|
|
/**
|
|
* Request that the player's client download and include another resource pack.
|
|
* <p>
|
|
diff --git a/src/main/java/org/bukkit/event/player/PlayerResourcePackStatusEvent.java b/src/main/java/org/bukkit/event/player/PlayerResourcePackStatusEvent.java
|
|
index e2c4f9a0456cef345772d57b4d9c6e7d9598dd53..e4c32b21ab013703a6a1b07a1ad564d914ebe83f 100644
|
|
--- a/src/main/java/org/bukkit/event/player/PlayerResourcePackStatusEvent.java
|
|
+++ b/src/main/java/org/bukkit/event/player/PlayerResourcePackStatusEvent.java
|
|
@@ -21,6 +21,16 @@ public class PlayerResourcePackStatusEvent extends PlayerEvent {
|
|
this.status = resourcePackStatus;
|
|
}
|
|
|
|
+ // Paper start - add hash (not used anymore)
|
|
+ /**
|
|
+ * @deprecated Hash does not seem to ever be set
|
|
+ */
|
|
+ @Deprecated(forRemoval = true)
|
|
+ public String getHash() {
|
|
+ return null;
|
|
+ }
|
|
+ // Paper end
|
|
+
|
|
/**
|
|
* Gets the unique ID of this pack.
|
|
*
|