Add Shearable API

This commit is contained in:
Owen1212055 2021-10-17 15:39:41 -04:00
parent 767d4e3e6f
commit 39c27c3661
6 changed files with 58 additions and 4 deletions

View File

@ -0,0 +1,44 @@
package io.papermc.paper.entity;
import net.kyori.adventure.sound.Sound;
import org.bukkit.entity.Entity;
import org.jspecify.annotations.NullMarked;
/**
* Represents an entity that can be sheared.
*/
@NullMarked
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.
* <p>
* 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.
* <p>
* Some shearing behavior may cause the entity to no longer be valid
* due to it being replaced by a different entity.
* <p>
* 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(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();
}

View File

@ -6,7 +6,7 @@ import org.jetbrains.annotations.ApiStatus;
* Represents a Bogged Skeleton. * Represents a Bogged Skeleton.
*/ */
@ApiStatus.Experimental @ApiStatus.Experimental
public interface Bogged extends AbstractSkeleton, Shearable { public interface Bogged extends AbstractSkeleton, Shearable, io.papermc.paper.entity.Shearable { // Paper - Shear API
/** /**
* Gets whether the bogged is in its sheared state. * Gets whether the bogged is in its sheared state.

View File

@ -8,7 +8,7 @@ import org.jetbrains.annotations.NotNull;
/** /**
* Represents a mushroom {@link Cow} * 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 * Checks for the presence of custom potion effects to be applied to the

View File

@ -2,20 +2,30 @@ package org.bukkit.entity;
/** /**
* Represents an entity which can be shorn with shears. * Represents an entity which can be shorn with shears.
* @deprecated Spigots shearable API miserably fails at capturing all entities that may be sheared by a player, like
* mushroom cows which, once sheared, convert into normal cows. For such entities, methods like
* {@link #setSheared(boolean)} or {@link #isSheared()} make no sense, making this API and interface dead API from
* the get-go.
*/ */
@Deprecated(forRemoval = true, since = "1.21")
public interface Shearable { public interface Shearable {
/** /**
* Gets whether the entity is in its sheared state. * Gets whether the entity is in its sheared state.
* *
* @return Whether the entity is sheared. * @return Whether the entity is sheared.
* @deprecated Use {@link io.papermc.paper.entity.Shearable#readyToBeSheared()} instead.
*/ */
@Deprecated(forRemoval = true, since = "1.21")
boolean isSheared(); boolean isSheared();
/** /**
* Sets whether the entity is in its sheared state. * Sets whether the entity is in its sheared state.
* *
* @param flag Whether to shear the entity * @param flag Whether to shear the entity
* @deprecated Use {@link io.papermc.paper.entity.Shearable#shear()} instead if applicable.
* Some entities cannot be "unsheared".
*/ */
@Deprecated(forRemoval = true, since = "1.21")
void setSheared(boolean flag); void setSheared(boolean flag);
} }

View File

@ -5,7 +5,7 @@ import org.bukkit.material.Colorable;
/** /**
* Represents a Sheep. * Represents a Sheep.
*/ */
public interface Sheep extends Animals, Colorable, Shearable { public interface Sheep extends Animals, Colorable, Shearable, io.papermc.paper.entity.Shearable { // Paper - Shear API
/** /**
* Gets whether the sheep is in its sheared state. * Gets whether the sheep is in its sheared state.

View File

@ -5,7 +5,7 @@ import com.destroystokyo.paper.entity.RangedEntity;
/** /**
* Represents a snowman entity * 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 * Gets whether this snowman is in "derp mode", meaning it is not wearing a