Record Class CustomPotionEffect.Settings

java.lang.Object

java.lang.Record

net.minestom.server.potion.CustomPotionEffect.Settings

Enclosing class:

CustomPotionEffect

public static record CustomPotionEffect.Settings(int amplifier, int duration, boolean isAmbient, boolean showParticles, boolean showIcon, @Nullable CustomPotionEffect.Settings hiddenEffect)
extends Record

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
Settings(int amplifier, int duration, boolean isAmbient, boolean showParticles, boolean showIcon, @Nullable CustomPotionEffect.Settings hiddenEffect)	Creates an instance of a Settings record class.

Method Summary

Modifier and Type	Method	Description
int	amplifier()	Returns the value of the amplifier record component.
int	duration()	Returns the value of the duration 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 CustomPotionEffect.Settings	hiddenEffect()	Returns the value of the hiddenEffect record component.
boolean	isAmbient()	Returns the value of the isAmbient record component.
boolean	showIcon()	Returns the value of the showIcon record component.
boolean	showParticles()	Returns the value of the showParticles 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

NETWORK_TYPE

public static final NetworkBuffer.Type<CustomPotionEffect.Settings> NETWORK_TYPE

CODEC

public static final Codec<CustomPotionEffect.Settings> CODEC

Constructor Details

Settings

public Settings(int amplifier,
 int duration,
 boolean isAmbient,
 boolean showParticles,
 boolean showIcon,
 @Nullable
 @Nullable CustomPotionEffect.Settings hiddenEffect)

Creates an instance of a Settings record class.

Parameters:

amplifier - the value for the amplifier record component

duration - the value for the duration record component

isAmbient - the value for the isAmbient record component

showParticles - the value for the showParticles record component

showIcon - the value for the showIcon record component

hiddenEffect - the value for the hiddenEffect record component

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

amplifier

public int amplifier()

Returns the value of the amplifier record component.

Returns:

the value of the amplifier record component

duration

public int duration()

Returns the value of the duration record component.

Returns:

the value of the duration record component

isAmbient

public boolean isAmbient()

Returns the value of the isAmbient record component.

Returns:

the value of the isAmbient record component

showParticles

public boolean showParticles()

Returns the value of the showParticles record component.

Returns:

the value of the showParticles record component

showIcon

public boolean showIcon()

Returns the value of the showIcon record component.

Returns:

the value of the showIcon record component

hiddenEffect

@Nullable
public @Nullable CustomPotionEffect.Settings hiddenEffect()

Returns the value of the hiddenEffect record component.

Returns:

the value of the hiddenEffect record component