Record Class PotionContents

java.lang.Object

java.lang.Record

net.minecraft.world.item.alchemy.PotionContents

All Implemented Interfaces:

ConsumableListener, TooltipProvider

public record PotionContents(Optional<Holder<Potion>> potion, Optional<Integer> customColor, List<MobEffectInstance> customEffects, Optional<String> customName)
extends Record
implements ConsumableListener, TooltipProvider

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BASE_POTION_COLOR
static final com.mojang.serialization.Codec<PotionContents>	CODEC
private final Optional<Integer>	customColor	The field for the customColor record component.
private final List<MobEffectInstance>	customEffects	The field for the customEffects record component.
private final Optional<String>	customName	The field for the customName record component.
static final PotionContents	EMPTY
private static final com.mojang.serialization.Codec<PotionContents>	FULL_CODEC
private static final Component	NO_EFFECT
private final Optional<Holder<Potion>>	potion	The field for the potion record component.
static final StreamCodec<RegistryFriendlyByteBuf, PotionContents>	STREAM_CODEC

Constructor Summary

Constructors

Constructor	Description
PotionContents(Optional<Holder<Potion>> potion, Optional<Integer> customColor, List<MobEffectInstance> customEffects, Optional<String> customName)	Creates an instance of a PotionContents record class.
PotionContents(Holder<Potion> potion)

Method Summary

Modifier and Type	Method	Description
static void	addPotionTooltip(Iterable<MobEffectInstance> effects, Consumer<Component> lines, float durationScale, float tickrate)
void	addToTooltip(Item.TooltipContext context, Consumer<Component> consumer, TooltipFlag flag, DataComponentGetter components)
void	applyToLivingEntity(LivingEntity entity, float durationScale)
static ItemStack	createItemStack(Item item, Holder<Potion> potion)
Optional<Integer>	customColor()	Returns the value of the customColor record component.
List<MobEffectInstance>	customEffects()	Returns the value of the customEffects record component.
Optional<String>	customName()	Returns the value of the customName record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
void	forEachEffect(Consumer<MobEffectInstance> consumer, float durationScale)
Iterable<MobEffectInstance>	getAllEffects()
int	getColor()
static OptionalInt	getColorOptional(Iterable<MobEffectInstance> effects)
int	getColorOr(int defaultColor)
Component	getName(String prefix)
static MutableComponent	getPotionDescription(Holder<MobEffect> mobEffect, int amplifier)
boolean	hasEffects()
final int	hashCode()	Returns a hash code value for this object.
boolean	is(Holder<Potion> potion)
void	onConsume(Level level, LivingEntity user, ItemStack stack, Consumable consumable)
Optional<Holder<Potion>>	potion()	Returns the value of the potion record component.
final String	toString()	Returns a string representation of this record class.
PotionContents	withEffectAdded(MobEffectInstance effect)
PotionContents	withPotion(Holder<Potion> potion)

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

potion

private final Optional<Holder<Potion>> potion

The field for the potion record component.

customColor

private final Optional<Integer> customColor

The field for the customColor record component.

customEffects

private final List<MobEffectInstance> customEffects

The field for the customEffects record component.

customName

private final Optional<String> customName

The field for the customName record component.

EMPTY

public static final PotionContents EMPTY

NO_EFFECT

private static final Component NO_EFFECT

BASE_POTION_COLOR

public static final int BASE_POTION_COLOR

See Also:

• Constant Field Values

FULL_CODEC

private static final com.mojang.serialization.Codec<PotionContents> FULL_CODEC

CODEC

public static final com.mojang.serialization.Codec<PotionContents> CODEC

STREAM_CODEC

public static final StreamCodec<RegistryFriendlyByteBuf, PotionContents> STREAM_CODEC

Constructor Details

PotionContents

public PotionContents(Holder<Potion> potion)

PotionContents

public PotionContents(Optional<Holder<Potion>> potion,
 Optional<Integer> customColor,
 List<MobEffectInstance> customEffects,
 Optional<String> customName)

Creates an instance of a PotionContents record class.

Parameters:

potion - the value for the potion record component

customColor - the value for the customColor record component

customEffects - the value for the customEffects record component

customName - the value for the customName record component

Method Details

createItemStack

public static ItemStack createItemStack(Item item,
 Holder<Potion> potion)

is

public boolean is(Holder<Potion> potion)

getAllEffects

public Iterable<MobEffectInstance> getAllEffects()

forEachEffect

public void forEachEffect(Consumer<MobEffectInstance> consumer,
 float durationScale)

withPotion

public PotionContents withPotion(Holder<Potion> potion)

withEffectAdded

public PotionContents withEffectAdded(MobEffectInstance effect)

getColor

public int getColor()

getColorOr

public int getColorOr(int defaultColor)

getName

public Component getName(String prefix)

getColorOptional

public static OptionalInt getColorOptional(Iterable<MobEffectInstance> effects)

hasEffects

public boolean hasEffects()

customEffects

public List<MobEffectInstance> customEffects()

Returns the value of the customEffects record component.

Returns:

the value of the customEffects record component

applyToLivingEntity

public void applyToLivingEntity(LivingEntity entity,
 float durationScale)

addPotionTooltip

public static void addPotionTooltip(Iterable<MobEffectInstance> effects,
 Consumer<Component> lines,
 float durationScale,
 float tickrate)

getPotionDescription

public static MutableComponent getPotionDescription(Holder<MobEffect> mobEffect,
 int amplifier)

onConsume

public void onConsume(Level level,
 LivingEntity user,
 ItemStack stack,
 Consumable consumable)

Specified by:

onConsume in interface ConsumableListener

addToTooltip

public void addToTooltip(Item.TooltipContext context,
 Consumer<Component> consumer,
 TooltipFlag flag,
 DataComponentGetter components)

Specified by:

addToTooltip in interface TooltipProvider

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

potion

public Optional<Holder<Potion>> potion()

Returns the value of the potion record component.

Returns:

the value of the potion record component

customColor

public Optional<Integer> customColor()

Returns the value of the customColor record component.

Returns:

the value of the customColor record component

customName

public Optional<String> customName()

Returns the value of the customName record component.

Returns:

the value of the customName record component