Cynthia Yantis / Bukkit / b252cf058ae

Commits

Doc authored and md_5 committed b252cf058ae 08 Feb 2024

SPIGOT-7576, #970: Add methods in MushroomCow to change stew effects

src/main/java/org/bukkit/entity/MushroomCow.java

Modified

-1
+package org.bukkit.entity;
-2
-+
+import java.util.List;
-+
+import org.bukkit.potion.PotionEffect;
-+
+import org.bukkit.potion.PotionEffectType;
-6
+import org.jetbrains.annotations.NotNull;
-7
-8
+/**
-9
+ * Represents a mushroom {@link Cow}
-10
+ */
-11
+public interface MushroomCow extends Cow {
-12
-+
+    /**
-+
+     * Checks for the presence of custom potion effects to be applied to the
-+
+     * next suspicious stew received from milking this {@link MushroomCow}.
-+
+     *
-+
+     * @return true if custom potion effects are applied to the stew
-+
+     */
-+
+    boolean hasEffectsForNextStew();
-+
-+
+    /**
-+
+     * Gets an immutable list containing all custom potion effects applied to
-+
+     * the next suspicious stew received from milking this {@link MushroomCow}.
-+
+     * <p>
-+
+     * Plugins should check that hasCustomEffects() returns true before calling
-+
+     * this method.
-+
+     *
-+
+     * @return an immutable list of custom potion effects
-+
+     */
-+
+    @NotNull
-+
+    List<PotionEffect> getEffectsForNextStew();
-+
-+
+    /**
-+
+     * Adds a custom potion effect to be applied to the next suspicious stew
-+
+     * received from milking this {@link MushroomCow}.
-+
+     *
-+
+     * @param effect the potion effect to add
-+
+     * @param overwrite true if any existing effect of the same type should be
-+
+     * overwritten
-+
+     * @return true if the effects to be applied to the suspicious stew changed
-+
+     * as a result of this call
-+
+     */
-+
+    boolean addEffectToNextStew(@NotNull PotionEffect effect, boolean overwrite);
-+
-+
+    /**
-+
+     * Removes a custom potion effect from being applied to the next suspicious
-+
+     * stew received from milking this {@link MushroomCow}.
-+
+     *
-+
+     * @param type the potion effect type to remove
-+
+     * @return true if the effects to be applied to the suspicious stew changed
-+
+     * as a result of this call
-+
+     */
-+
+    boolean removeEffectFromNextStew(@NotNull PotionEffectType type);
-+
-+
+    /**
-+
+     * Checks for a specific custom potion effect type to be applied to the next
-+
+     * suspicious stew received from milking this {@link MushroomCow}.
-+
+     *
-+
+     * @param type the potion effect type to check for
-+
+     * @return true if the suspicious stew to be generated has this effect
-+
+     */
-+
+    boolean hasEffectForNextStew(@NotNull PotionEffectType type);
-+
-+
+    /**
-+
+     * Removes all custom potion effects to be applied to the next suspicious
-+
+     * stew received from milking this {@link MushroomCow}.
-+
+     */
-+
+    void clearEffectsForNextStew();
-+
-70
+    /**
-71
+     * Get the variant of this cow.
-72
+     *
-73
+     * @return cow variant
-74
+     */
-75
+    @NotNull
-76
+    public Variant getVariant();
-77
-78
+    /**
-79
+     * Set the variant of this cow.

Bukkit

Commits

Jira Issues

Add shortcut