From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001 From: Owen1212055 <23108066+Owen1212055@users.noreply.github.com> Date: Sun, 17 Oct 2021 15:39:41 -0400 Subject: [PATCH] Add Shearable API diff --git a/src/main/java/io/papermc/paper/entity/Shearable.java b/src/main/java/io/papermc/paper/entity/Shearable.java new file mode 100644 index 0000000000000000000000000000000000000000..0d5793790ab6a47525ad33033517361205756338 --- /dev/null +++ b/src/main/java/io/papermc/paper/entity/Shearable.java @@ -0,0 +1,43 @@ +package io.papermc.paper.entity; + +import net.kyori.adventure.sound.Sound; +import org.bukkit.entity.Entity; +import org.jetbrains.annotations.NotNull; + +/** + * Represents an entity that can be sheared. + */ +public interface Shearable extends Entity { + + /** + * Forces the entity to be sheared and then play the effect as if it were sheared by a player. + * This will cause the entity to be sheared, even if {@link Shearable#readyToBeSheared()} is false. + *

+ * Some shearing behavior may cause the entity to no longer be valid + * due to it being replaced by a different entity. + */ + default void shear() { + this.shear(Sound.Source.PLAYER); + } + + /** + * Forces the entity to be sheared and then play the effect as if it were sheared by the provided source. + * This will cause the entity to be sheared, even if {@link Shearable#readyToBeSheared()} is false. + *

+ * Some shearing behavior may cause the entity to no longer be valid + * due to it being replaced by a different entity. + *

+ * This simulates the behavior of an actual shearing, which may cause events like EntityTransformEvent to be called + * for mooshrooms, and EntityDropItemEvent to be called for sheep. + * + * @param source Sound source to play any sound effects on + */ + void shear(@NotNull Sound.Source source); + + /** + * Gets if the entity would be able to be sheared or not naturally using shears. + * + * @return if the entity can be sheared + */ + boolean readyToBeSheared(); +} diff --git a/src/main/java/org/bukkit/entity/Bogged.java b/src/main/java/org/bukkit/entity/Bogged.java index a89f104aa2b2244c075a72c698a9b616c57eaf7c..a36bb84c17120bc578ab01d45f6f12fb1faf9548 100644 --- a/src/main/java/org/bukkit/entity/Bogged.java +++ b/src/main/java/org/bukkit/entity/Bogged.java @@ -6,5 +6,5 @@ import org.jetbrains.annotations.ApiStatus; * Represents a Bogged Skeleton. */ @ApiStatus.Experimental -public interface Bogged extends AbstractSkeleton { +public interface Bogged extends AbstractSkeleton, io.papermc.paper.entity.Shearable { // Paper - Shear API } diff --git a/src/main/java/org/bukkit/entity/MushroomCow.java b/src/main/java/org/bukkit/entity/MushroomCow.java index cef1700834643fe28ed5737578d91ecefbe99e2f..86c0043ef4e1288b6fe2f68a9b6d01c3de2c3454 100644 --- a/src/main/java/org/bukkit/entity/MushroomCow.java +++ b/src/main/java/org/bukkit/entity/MushroomCow.java @@ -8,7 +8,7 @@ import org.jetbrains.annotations.NotNull; /** * Represents a mushroom {@link Cow} */ -public interface MushroomCow extends Cow { +public interface MushroomCow extends Cow, io.papermc.paper.entity.Shearable { // Paper /** * Checks for the presence of custom potion effects to be applied to the diff --git a/src/main/java/org/bukkit/entity/Sheep.java b/src/main/java/org/bukkit/entity/Sheep.java index f4ce312ccd927a8b64f4266b35a0a53b85e591f3..97388d46cee225dedc0b61a12e7b60b3424732c8 100644 --- a/src/main/java/org/bukkit/entity/Sheep.java +++ b/src/main/java/org/bukkit/entity/Sheep.java @@ -5,7 +5,7 @@ import org.bukkit.material.Colorable; /** * Represents a Sheep. */ -public interface Sheep extends Animals, Colorable { +public interface Sheep extends Animals, Colorable, io.papermc.paper.entity.Shearable { // Paper - Shear API /** * @return Whether the sheep is sheared. diff --git a/src/main/java/org/bukkit/entity/Snowman.java b/src/main/java/org/bukkit/entity/Snowman.java index 10f8f6d45ae9280651c3ebddd1f90acbd7d6ff29..7fbfdb07585c7b28acea1f0c1f58ada0cc744441 100644 --- a/src/main/java/org/bukkit/entity/Snowman.java +++ b/src/main/java/org/bukkit/entity/Snowman.java @@ -5,7 +5,7 @@ import com.destroystokyo.paper.entity.RangedEntity; /** * Represents a snowman entity */ -public interface Snowman extends Golem, RangedEntity { // Paper +public interface Snowman extends Golem, RangedEntity, io.papermc.paper.entity.Shearable { // Paper /** * Gets whether this snowman is in "derp mode", meaning it is not wearing a