Files
Paper/paper-api/src/main/java/org/bukkit/potion/PotionBrewer.java
2021-10-07 14:34:59 -07:00

80 lines
2.5 KiB
Java

package org.bukkit.potion;
import java.util.Collection;
import org.jetbrains.annotations.NotNull;
/**
* Used to manage custom {@link io.papermc.paper.potion.PotionMix}s.
*/
public interface PotionBrewer {
// Paper start
/**
* Adds a new potion mix recipe.
*
* @param potionMix the potion mix to add
*/
void addPotionMix(@NotNull io.papermc.paper.potion.PotionMix potionMix);
/**
* Removes a potion mix recipe.
*
* @param key the key of the mix to remove
*/
void removePotionMix(@NotNull org.bukkit.NamespacedKey key);
/**
* Resets potion mixes to their default, removing all custom ones.
*/
void resetPotionMixes();
// Paper end
/**
* Creates a {@link PotionEffect} from the given {@link PotionEffectType},
* applying duration modifiers and checks.
*
* @param potion The type of potion
* @param duration The duration in ticks
* @param amplifier The amplifier of the effect
* @return The resulting potion effect
* @deprecated use {@link PotionEffectType#createEffect(int, int)} instead.
*/
@Deprecated(forRemoval = true, since = "1.20.5") // Paper
@NotNull
// Paper start - make default
default PotionEffect createEffect(@NotNull PotionEffectType potion, int duration, int amplifier) {
return potion.createEffect(duration, amplifier);
}
// Paper end
/**
* Returns a collection of {@link PotionEffect} that would be applied from
* a potion with the given data value.
*
* @param damage The data value of the potion
* @return The list of effects
* @deprecated Non-Functional
*/
@Deprecated(since = "1.6.2", forRemoval = true) // Paper
@NotNull
// Paper start - make default
default Collection<PotionEffect> getEffectsFromDamage(final int damage) {
return new java.util.ArrayList<>();
}
// Paper end
/**
* Returns a collection of {@link PotionEffect} that would be applied from
* a potion with the given type.
*
* @param type The type of the potion
* @param upgraded Whether the potion is upgraded
* @param extended Whether the potion is extended
* @return The list of effects
* @deprecated Upgraded / extended potions are now their own {@link PotionType} use {@link PotionType#getPotionEffects()} instead
*/
@NotNull
@Deprecated(since = "1.20.2", forRemoval = true) // Paper
public Collection<PotionEffect> getEffects(@NotNull PotionType type, boolean upgraded, boolean extended);
}