Paper/patches/api/0320-Bucketable-API.patch

From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Owen1212055 <23108066+Owen1212055@users.noreply.github.com>
Date: Sun, 26 Dec 2021 14:03:11 -0500
Subject: [PATCH] Bucketable API


diff --git a/src/main/java/io/papermc/paper/entity/Bucketable.java b/src/main/java/io/papermc/paper/entity/Bucketable.java
new file mode 100644
index 0000000000000000000000000000000000000000..a63c3d0fe50f5808215ed169b81269112f76ec1b
--- /dev/null
+++ b/src/main/java/io/papermc/paper/entity/Bucketable.java
@@ -0,0 +1,41 @@
+package io.papermc.paper.entity;
+
+import org.bukkit.Sound;
+import org.bukkit.entity.Entity;
+import org.bukkit.inventory.ItemStack;
+import org.jspecify.annotations.NullMarked;
+
+/**
+ * Represents an entity that can be bucketed.
+ */
+@NullMarked
+public interface Bucketable extends Entity {
+
+    /**
+     * Gets if this entity originated from a bucket.
+     *
+     * @return originated from bucket
+     */
+    boolean isFromBucket();
+
+    /**
+     * Sets if this entity originated from a bucket.
+     *
+     * @param fromBucket is from a bucket
+     */
+    void setFromBucket(boolean fromBucket);
+
+    /**
+     * Gets the base itemstack of this entity in a bucket form.
+     *
+     * @return bucket form
+     */
+    ItemStack getBaseBucketItem();
+
+    /**
+     * Gets the sound that is played when this entity
+     * is picked up in a bucket.
+     * @return bucket pickup sound
+     */
+    Sound getPickupSound();
+}
diff --git a/src/main/java/org/bukkit/entity/Axolotl.java b/src/main/java/org/bukkit/entity/Axolotl.java
index 9763f3b9ac8f32c082a476f4b50a32622b2720a0..c8c738b1b72e9ad89d97b7a1f5450d58045a72ca 100644
--- a/src/main/java/org/bukkit/entity/Axolotl.java
+++ b/src/main/java/org/bukkit/entity/Axolotl.java
@@ -5,7 +5,7 @@ import org.jetbrains.annotations.NotNull;
 /**
  * An Axolotl.
  */
-public interface Axolotl extends Animals {
+public interface Axolotl extends Animals, io.papermc.paper.entity.Bucketable { // Paper - Bucketable API
 
     /**
      * Gets if this axolotl is playing dead.
diff --git a/src/main/java/org/bukkit/entity/Fish.java b/src/main/java/org/bukkit/entity/Fish.java
index 82e390b2152e7c881006ca30f2527d160c01f8a1..86da8dc401ed7db19a39bc682721055cd341ccde 100644
--- a/src/main/java/org/bukkit/entity/Fish.java
+++ b/src/main/java/org/bukkit/entity/Fish.java
@@ -3,4 +3,4 @@ package org.bukkit.entity;
 /**
  * Represents a fish entity.
  */
-public interface Fish extends WaterMob { }
+public interface Fish extends WaterMob, io.papermc.paper.entity.Bucketable { } // Paper - Bucketable API