Package org.bukkit.potion

Class PotionEffectTypeWrapper

java.lang.Object

org.bukkit.potion.PotionEffectType

org.bukkit.potion.PotionEffectTypeWrapper

All Implemented Interfaces:

FeatureDependant, Keyed, Translatable, Keyed, Translatable

@Deprecated(since="1.20.3",
            forRemoval=true)
public abstract class PotionEffectTypeWrapper
extends PotionEffectType

Deprecated, for removal: This API element is subject to removal in a future version.

only for backwards compatibility, PotionEffectTypeWrapper is no longer used.

Nested Class Summary

Nested classes/interfaces inherited from class org.bukkit.potion.PotionEffectType

PotionEffectType.Category

Field Summary

Fields inherited from class org.bukkit.potion.PotionEffectType

ABSORPTION, BAD_OMEN, BLINDNESS, CONDUIT_POWER, DARKNESS, DOLPHINS_GRACE, FIRE_RESISTANCE, GLOWING, HASTE, HEALTH_BOOST, HERO_OF_THE_VILLAGE, HUNGER, INFESTED, INSTANT_DAMAGE, INSTANT_HEALTH, INVISIBILITY, JUMP_BOOST, LEVITATION, LUCK, MINING_FATIGUE, NAUSEA, NIGHT_VISION, OOZING, POISON, RAID_OMEN, REGENERATION, RESISTANCE, SATURATION, SLOW_FALLING, SLOWNESS, SPEED, STRENGTH, TRIAL_OMEN, UNLUCK, WATER_BREATHING, WEAKNESS, WEAVING, WIND_CHARGED, WITHER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PotionEffectTypeWrapper()	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
double	getAttributeModifierAmount(Attribute attribute, int effectAmplifier)	Deprecated, for removal: This API element is subject to removal in a future version. Gets the true modifier amount based on the effect amplifier.
Color	getColor()	Deprecated, for removal: This API element is subject to removal in a future version. Returns the color of this effect type.
Map<Attribute,AttributeModifier>	getEffectAttributes()	Deprecated, for removal: This API element is subject to removal in a future version. Gets the effect attributes in an immutable map.
PotionEffectType.Category	getEffectCategory()	Deprecated, for removal: This API element is subject to removal in a future version. Gets the category of this effect
NamespacedKey	getKey()	Deprecated, for removal: This API element is subject to removal in a future version. Return the namespaced identifier for this object.
@NotNull PotionEffectType	getType()	Deprecated, for removal: This API element is subject to removal in a future version. Get the potion type bound to this wrapper.
boolean	isInstant()	Deprecated, for removal: This API element is subject to removal in a future version. Returns whether the effect of this type happens once, immediately.
@NotNull String	translationKey()	Deprecated, for removal: This API element is subject to removal in a future version. Gets the translation key.

Methods inherited from class org.bukkit.potion.PotionEffectType

createEffect, getById, getByKey, getByName, getCategory, getDurationModifier, getId, getName, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.papermc.paper.world.flag.FeatureDependant

requiredFeatures

Methods inherited from interface org.bukkit.Keyed

key

Methods inherited from interface org.bukkit.Translatable

getTranslationKey

Constructor Details

PotionEffectTypeWrapper

protected PotionEffectTypeWrapper()

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

getType

@NotNull
public @NotNull PotionEffectType getType()

Deprecated, for removal: This API element is subject to removal in a future version.

Get the potion type bound to this wrapper.

Returns:

The potion effect type

isInstant

public boolean isInstant()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: PotionEffectType

Returns whether the effect of this type happens once, immediately.

Specified by:

isInstant in class PotionEffectType

Returns:

whether this type is normally instant

getColor

@NotNull
public Color getColor()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: PotionEffectType

Returns the color of this effect type.

Specified by:

getColor in class PotionEffectType

Returns:

the color

getKey

@NotNull
public NamespacedKey getKey()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: Keyed

Return the namespaced identifier for this object.

Returns:

this object's key

getEffectAttributes

@NotNull
public Map<Attribute,AttributeModifier> getEffectAttributes()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: PotionEffectType

Gets the effect attributes in an immutable map.

Specified by:

getEffectAttributes in class PotionEffectType

Returns:

the attribute map

getAttributeModifierAmount

public double getAttributeModifierAmount(@NotNull
 Attribute attribute,
 int effectAmplifier)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: PotionEffectType

Gets the true modifier amount based on the effect amplifier.

Specified by:

getAttributeModifierAmount in class PotionEffectType

Parameters:

attribute - the attribute

effectAmplifier - the effect amplifier (0 indexed)

Returns:

the modifier amount

getEffectCategory

@NotNull
public PotionEffectType.Category getEffectCategory()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: PotionEffectType

Gets the category of this effect

Specified by:

getEffectCategory in class PotionEffectType

Returns:

the category

translationKey

@NotNull
public @NotNull String translationKey()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: net.kyori.adventure.translation.Translatable

Gets the translation key.

Returns:

the translation key