net.minecraft.potion

Class Potion

java.lang.Object

net.minecraftforge.fml.common.registry.IForgeRegistryEntry.Impl<Potion>

net.minecraft.potion.Potion

All Implemented Interfaces:

IForgeRegistryEntry<Potion>

Direct Known Subclasses:

PotionAbsorption, PotionAttackDamage, PotionHealth, PotionHealthBoost

public class Potion
extends IForgeRegistryEntry.Impl<Potion>

Nested Class Summary

Nested classes/interfaces inherited from interface net.minecraftforge.fml.common.registry.IForgeRegistryEntry

IForgeRegistryEntry.Impl<T extends IForgeRegistryEntry<T>>

Field Summary

Fields

Modifier and Type	Field and Description
static RegistryNamespaced<ResourceLocation,Potion>	REGISTRY

Fields inherited from class net.minecraftforge.fml.common.registry.IForgeRegistryEntry.Impl

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.
static int	getIdFromPotion(Potion potionIn) Gets the numeric Id associated with a potion.
int	getLiquidColor() Returns the color of the potion liquid.
java.lang.String	getName() returns the name of the potion
static Potion	getPotionById(int potionID) Gets a Potion from the potion registry using a numeric Id.
static java.lang.String	getPotionDurationString(PotionEffect p_188410_0_, float p_188410_1_)
static Potion	getPotionFromResourceLocation(java.lang.String location)
int	getStatusIconIndex() Returns the index for the icon to display when the potion is active.
boolean	hasStatusIcon() Returns true if the potion has a associated status icon to display in then inventory when active.
boolean	isBadEffect() This method returns true if the potion effect is bad - negative - for the entity.
boolean	isBeneficial() Get if the potion is beneficial to the player.
boolean	isInstant() Returns true if the potion has an instant effect instead of a continuous one (eg Harming)
boolean	isReady(int duration, int amplifier) checks if Potion effect is ready to be applied this tick.
void	performEffect(EntityLivingBase entityLivingBaseIn, int p_76394_2_)
Potion	registerPotionAttributeModifier(IAttribute attribute, java.lang.String uniqueId, double ammount, int operation) Used by potions to register the attribute they modify.
static void	registerPotions()
void	removeAttributesModifiersFromEntity(EntityLivingBase entityLivingBaseIn, AbstractAttributeMap attributeMapIn, int amplifier)
void	renderHUDEffect(int x, int y, PotionEffect effect, Minecraft mc, float alpha) Called to draw the this Potion onto the player's ingame HUD when it's active.
void	renderInventoryEffect(int x, int y, PotionEffect effect, Minecraft mc) Called to draw the this Potion onto the player's inventory when it's active.
Potion	setBeneficial() Set that the potion is beneficial to the player.
protected Potion	setEffectiveness(double effectivenessIn)
protected Potion	setIconIndex(int p_76399_1_, int p_76399_2_) Sets the index for the icon displayed in the player's inventory when the status is active.
Potion	setPotionName(java.lang.String nameIn) Set the potion name.
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.fml.common.registry.IForgeRegistryEntry.Impl

getRegistryName, getRegistryType, setRegistryName, setRegistryName, setRegistryName

Methods inherited from class java.lang.Object

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

Field Detail

REGISTRY

public static final RegistryNamespaced<ResourceLocation,Potion> REGISTRY

Constructor Detail

Potion

protected Potion(boolean isBadEffectIn,
                 int liquidColorIn)

Method Detail

getPotionById

public static Potion getPotionById(int potionID)

Gets a Potion from the potion registry using a numeric Id.

getIdFromPotion

public static int getIdFromPotion(Potion potionIn)

Gets the numeric Id associated with a potion.

getPotionFromResourceLocation

public static Potion getPotionFromResourceLocation(java.lang.String location)

setIconIndex

protected Potion setIconIndex(int p_76399_1_,
                              int p_76399_2_)

Sets the index for the icon displayed in the player's inventory when the status is active.

performEffect

public void performEffect(EntityLivingBase entityLivingBaseIn,
                          int p_76394_2_)

affectEntity

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

isReady

public boolean isReady(int duration,
                       int amplifier)

checks if Potion effect is ready to be applied this tick.

isInstant

public boolean isInstant()

Returns true if the potion has an instant effect instead of a continuous one (eg Harming)

setPotionName

public Potion setPotionName(java.lang.String nameIn)

Set the potion name.

getName

public java.lang.String getName()

returns the name of the potion

setEffectiveness

protected Potion setEffectiveness(double effectivenessIn)

hasStatusIcon

public boolean hasStatusIcon()

Returns true if the potion has a associated status icon to display in then inventory when active.

getStatusIconIndex

public int getStatusIconIndex()

Returns the index for the icon to display when the potion is active.

isBadEffect

public boolean isBadEffect()

This method returns true if the potion effect is bad - negative - for the entity.

getPotionDurationString

public static java.lang.String getPotionDurationString(PotionEffect p_188410_0_,
                                                       float p_188410_1_)

getLiquidColor

public int getLiquidColor()

Returns the color of the potion liquid.

registerPotionAttributeModifier

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

Used by potions to register the attribute they modify.

removeAttributesModifiersFromEntity

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

getAttributeModifierMap

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

applyAttributesModifiersToEntity

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

getAttributeModifierAmount

public double getAttributeModifierAmount(int amplifier,
                                         AttributeModifier modifier)

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(int x,
                                  int y,
                                  PotionEffect effect,
                                  Minecraft mc)

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:

x - the x coordinate

y - the y coordinate

effect - the active PotionEffect

mc - the Minecraft instance, for convenience

renderHUDEffect

public void renderHUDEffect(int x,
                            int y,
                            PotionEffect effect,
                            Minecraft mc,
                            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:

x - the x coordinate

y - the y coordinate

effect - the active PotionEffect

mc - the Minecraft instance, for convenience

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()

isBeneficial

public boolean isBeneficial()

Get if the potion is beneficial to the player. Beneficial potions are shown on the first row of the HUD

setBeneficial

public Potion setBeneficial()

Set that the potion is beneficial to the player. Beneficial potions are shown on the first row of the HUD

registerPotions

public static void registerPotions()