Record Class CustomPotionEffect

java.lang.Object

java.lang.Record

net.minestom.server.potion.CustomPotionEffect

public record CustomPotionEffect(@NotNull PotionEffect id, @NotNull CustomPotionEffect.Settings settings)
extends Record

Represents a custom effect in DataComponents.POTION_CONTENTS.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	CustomPotionEffect.Settings

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
CustomPotionEffect(@NotNull PotionEffect id, int amplifier, int duration, boolean isAmbient, boolean showParticles, boolean showIcon)
CustomPotionEffect(@NotNull PotionEffect id, @NotNull CustomPotionEffect.Settings settings)	Creates an instance of a CustomPotionEffect record class.

Method Summary

Modifier and Type	Method	Description
int	amplifier()
int	duration()
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.
@NotNull PotionEffect	id()	Returns the value of the id record component.
boolean	isAmbient()
@NotNull CustomPotionEffect.Settings	settings()	Returns the value of the settings record component.
boolean	showIcon()
boolean	showParticles()
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Field Details

NETWORK_TYPE

public static final NetworkBuffer.Type<CustomPotionEffect> NETWORK_TYPE

CODEC

public static final Codec<CustomPotionEffect> CODEC

Constructor Details

CustomPotionEffect

public CustomPotionEffect(@NotNull
 @NotNull PotionEffect id,
 int amplifier,
 int duration,
 boolean isAmbient,
 boolean showParticles,
 boolean showIcon)

CustomPotionEffect

public CustomPotionEffect(@NotNull
 @NotNull PotionEffect id,
 @NotNull
 @NotNull CustomPotionEffect.Settings settings)

Creates an instance of a CustomPotionEffect record class.

Parameters:

id - the value for the id record component

settings - the value for the settings record component

Method Details

amplifier

public int amplifier()

duration

public int duration()

isAmbient

public boolean isAmbient()

showParticles

public boolean showParticles()

showIcon

public boolean showIcon()

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.

id

@NotNull
public @NotNull PotionEffect id()

Returns the value of the id record component.

Returns:

the value of the id record component

settings

@NotNull
public @NotNull CustomPotionEffect.Settings settings()

Returns the value of the settings record component.

Returns:

the value of the settings record component