Record Class PotionContents

java.lang.Object

java.lang.Record

net.minestom.server.item.component.PotionContents

public record PotionContents(@Nullable PotionType potion, @Nullable RGBLike customColor, List<CustomPotionEffect> customEffects, @Nullable String customName)
extends Record

Field Summary

Fields

Modifier and Type	Field	Description
static final Codec<PotionContents>	CODEC
static final PotionContents	EMPTY
static final NetworkBuffer.Type<PotionContents>	NETWORK_TYPE

Constructor Summary

Constructors

Constructor	Description
PotionContents(List<CustomPotionEffect> customEffects)
PotionContents(@Nullable PotionType potion, @Nullable RGBLike customColor, List<CustomPotionEffect> customEffects)
PotionContents(@Nullable PotionType potion, @Nullable RGBLike customColor, List<CustomPotionEffect> customEffects, @Nullable String customName)	Creates an instance of a PotionContents record class.
PotionContents(CustomPotionEffect customEffect)
PotionContents(PotionType potion)
PotionContents(PotionType potion, RGBLike customColor)

Method Summary

Modifier and Type	Method	Description
@Nullable RGBLike	customColor()	Returns the value of the customColor record component.
List<CustomPotionEffect>	customEffects()	Returns the value of the customEffects record component.
@Nullable 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.
final int	hashCode()	Returns a hash code value for this object.
@Nullable PotionType	potion()	Returns the value of the potion record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Field Details

EMPTY

public static final PotionContents EMPTY

NETWORK_TYPE

public static final NetworkBuffer.Type<PotionContents> NETWORK_TYPE

CODEC

public static final Codec<PotionContents> CODEC

Constructor Details

PotionContents

public PotionContents(@Nullable
 @Nullable PotionType potion,
 @Nullable
 @Nullable RGBLike customColor,
 List<CustomPotionEffect> customEffects,
 @Nullable
 @Nullable 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

PotionContents

public PotionContents(PotionType potion)

PotionContents

public PotionContents(PotionType potion,
 RGBLike customColor)

PotionContents

public PotionContents(List<CustomPotionEffect> customEffects)

PotionContents

public PotionContents(CustomPotionEffect customEffect)

PotionContents

public PotionContents(@Nullable
 @Nullable PotionType potion,
 @Nullable
 @Nullable RGBLike customColor,
 List<CustomPotionEffect> customEffects)

Method Details

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

@Nullable
public @Nullable PotionType potion()

Returns the value of the potion record component.

Returns:

the value of the potion record component

customColor

@Nullable
public @Nullable RGBLike customColor()

Returns the value of the customColor record component.

Returns:

the value of the customColor record component

customEffects

public List<CustomPotionEffect> customEffects()

Returns the value of the customEffects record component.

Returns:

the value of the customEffects record component

customName

@Nullable
public @Nullable String customName()

Returns the value of the customName record component.

Returns:

the value of the customName record component