net.minecraft.potion

Class Potion

java.lang.Object

net.minecraftforge.registries.ForgeRegistryEntry<Potion>

net.minecraft.potion.Potion

All Implemented Interfaces:

IForgeRegistryEntry<Potion>

Direct Known Subclasses:

PotionAbsorption, PotionAttackDamage, PotionHealthBoost, PotionInstant

public class Potion
extends ForgeRegistryEntry<Potion>

Field Summary

Fields inherited from class net.minecraftforge.registries.ForgeRegistryEntry

delegate

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Potion(boolean isBadEffectIn, int liquidColorIn)

Method Summary

Modifier and Type	Method and Description
void	affectEntity(Entity source, Entity indirectSource, EntityLivingBase entityLivingBaseIn, int amplifier, double health)
void	applyAttributesModifiersToEntity(EntityLivingBase entityLivingBaseIn, AbstractAttributeMap attributeMapIn, int amplifier)
double	getAttributeModifierAmount(int amplifier, AttributeModifier modifier)
java.util.Map<IAttribute,AttributeModifier>	getAttributeModifierMap()
java.util.List<ItemStack>	getCurativeItems() Get a fresh list of items that can cure this Potion.
ITextComponent	getDisplayName()
int	getGuiSortColor(PotionEffect potionEffect) Used for determining PotionEffect sort order in GUIs.
static int	getIdFromPotion(Potion potionIn)
int	getLiquidColor()
java.lang.String	getName()
protected java.lang.String	getOrCreateDescriptionId()
static Potion	getPotionById(int potionID)
int	getStatusIconIndex()
boolean	hasStatusIcon()
boolean	isBadEffect()
boolean	isBeneficial()
boolean	isInstant()
boolean	isReady(int duration, int amplifier)
void	performEffect(EntityLivingBase entityLivingBaseIn, int amplifier)
Potion	registerPotionAttributeModifier(IAttribute attribute, java.lang.String uniqueId, double ammount, int operation)
static void	registerPotions()
void	removeAttributesModifiersFromEntity(EntityLivingBase entityLivingBaseIn, AbstractAttributeMap attributeMapIn, int amplifier)
void	renderHUDEffect(PotionEffect effect, Gui gui, int x, int y, float z, float alpha) Called to draw the this Potion onto the player's ingame HUD when it's active.
void	renderInventoryEffect(PotionEffect effect, Gui gui, int x, int y, float z) Called to draw the this Potion onto the player's inventory when it's active.
Potion	setBeneficial()
protected Potion	setEffectiveness(double effectivenessIn)
protected Potion	setIconIndex(int p_76399_1_, int p_76399_2_)
boolean	shouldRender(PotionEffect effect) If the Potion effect should be displayed in the players inventory
boolean	shouldRenderHUD(PotionEffect effect) If the Potion effect should be displayed in the player's ingame HUD
boolean	shouldRenderInvText(PotionEffect effect) If the standard PotionEffect text (name and duration) should be drawn when this potion is active.

Methods inherited from class net.minecraftforge.registries.ForgeRegistryEntry

getRegistryName, getRegistryType, setRegistryName, setRegistryName, setRegistryName

Methods inherited from class java.lang.Object

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

Constructor Detail

Potion

protected Potion(boolean isBadEffectIn,
                 int liquidColorIn)

Method Detail

getPotionById

@Nullable
public static Potion getPotionById(int potionID)

getIdFromPotion

public static int getIdFromPotion(Potion potionIn)

setIconIndex

protected Potion setIconIndex(int p_76399_1_,
                              int p_76399_2_)

performEffect

public void performEffect(EntityLivingBase entityLivingBaseIn,
                          int amplifier)

affectEntity

public void affectEntity(@Nullable
                         Entity source,
                         @Nullable
                         Entity indirectSource,
                         EntityLivingBase entityLivingBaseIn,
                         int amplifier,
                         double health)

isReady

public boolean isReady(int duration,
                       int amplifier)

isInstant

public boolean isInstant()

getOrCreateDescriptionId

protected java.lang.String getOrCreateDescriptionId()

getName

public java.lang.String getName()

getDisplayName

public ITextComponent getDisplayName()

hasStatusIcon

public boolean hasStatusIcon()

getStatusIconIndex

public int getStatusIconIndex()

isBadEffect

public boolean isBadEffect()

setEffectiveness

protected Potion setEffectiveness(double effectivenessIn)

getLiquidColor

public int getLiquidColor()

registerPotionAttributeModifier

public Potion registerPotionAttributeModifier(IAttribute attribute,
                                              java.lang.String uniqueId,
                                              double ammount,
                                              int operation)

getAttributeModifierMap

public java.util.Map<IAttribute,AttributeModifier> getAttributeModifierMap()

removeAttributesModifiersFromEntity

public void removeAttributesModifiersFromEntity(EntityLivingBase entityLivingBaseIn,
                                                AbstractAttributeMap attributeMapIn,
                                                int amplifier)

applyAttributesModifiersToEntity

public void applyAttributesModifiersToEntity(EntityLivingBase entityLivingBaseIn,
                                             AbstractAttributeMap attributeMapIn,
                                             int amplifier)

getAttributeModifierAmount

public double getAttributeModifierAmount(int amplifier,
                                         AttributeModifier modifier)

isBeneficial

public boolean isBeneficial()

setBeneficial

public Potion setBeneficial()

registerPotions

public static void registerPotions()

shouldRender

public boolean shouldRender(PotionEffect effect)

If the Potion effect should be displayed in the players inventory

Parameters:

effect - the active PotionEffect

Returns:

true to display it (default), false to hide it.

shouldRenderInvText

public boolean shouldRenderInvText(PotionEffect effect)

If the standard PotionEffect text (name and duration) should be drawn when this potion is active.

Parameters:

effect - the active PotionEffect

Returns:

true to draw the standard text

shouldRenderHUD

public boolean shouldRenderHUD(PotionEffect effect)

If the Potion effect should be displayed in the player's ingame HUD

Parameters:

effect - the active PotionEffect

Returns:

true to display it (default), false to hide it.

renderInventoryEffect

public void renderInventoryEffect(PotionEffect effect,
                                  Gui gui,
                                  int x,
                                  int y,
                                  float z)

Called to draw the this Potion onto the player's inventory when it's active. This can be used to e.g. render Potion icons from your own texture.

Parameters:

effect - the active PotionEffect

gui - the gui instance

x - the x coordinate

y - the y coordinate

z - the z level

renderHUDEffect

public void renderHUDEffect(PotionEffect effect,
                            Gui gui,
                            int x,
                            int y,
                            float z,
                            float alpha)

Called to draw the this Potion onto the player's ingame HUD when it's active. This can be used to e.g. render Potion icons from your own texture.

Parameters:

effect - the active PotionEffect

gui - the gui instance

x - the x coordinate

y - the y coordinate

z - the z level

alpha - the alpha value, blinks when the potion is about to run out

getCurativeItems

public java.util.List<ItemStack> getCurativeItems()

Get a fresh list of items that can cure this Potion. All new PotionEffects created from this Potion will call this to initialize the default curative items

Returns:

A list of items that can cure this Potion

See Also:

PotionEffect.getCurativeItems()

getGuiSortColor

public int getGuiSortColor(PotionEffect potionEffect)

Used for determining PotionEffect sort order in GUIs. Defaults to the PotionEffect's liquid color.

Parameters:

potionEffect - the PotionEffect instance containing the potion

Returns:

a value used to sort PotionEffects in GUIs