Record Class ConsumeEffect.ApplyEffects

java.lang.Object

java.lang.Record

net.minestom.server.item.component.ConsumeEffect.ApplyEffects

All Implemented Interfaces:

ConsumeEffect

Enclosing interface:

ConsumeEffect

public static record ConsumeEffect.ApplyEffects(List<CustomPotionEffect> effects, float probability)
extends Record
implements ConsumeEffect

Nested Class Summary

Nested classes/interfaces inherited from interface ConsumeEffect

ConsumeEffect.ApplyEffects, ConsumeEffect.ClearAllEffects, ConsumeEffect.PlaySound, ConsumeEffect.RemoveEffects, ConsumeEffect.TeleportRandomly

Field Summary

Fields

Modifier and Type	Field	Description
static final StructCodec<ConsumeEffect.ApplyEffects>	CODEC
static final NetworkBuffer.Type<ConsumeEffect.ApplyEffects>	NETWORK_TYPE

Constructor Summary

Constructors

Constructor	Description
ApplyEffects(List<CustomPotionEffect> effects, float probability)	Creates an instance of a ApplyEffects record class.
ApplyEffects(CustomPotionEffect effect, float probability)

Method Summary

Modifier and Type	Method	Description
List<CustomPotionEffect>	effects()	Returns the value of the effects 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.
float	probability()	Returns the value of the probability 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<ConsumeEffect.ApplyEffects> NETWORK_TYPE

CODEC

public static final StructCodec<ConsumeEffect.ApplyEffects> CODEC

Constructor Details

ApplyEffects

public ApplyEffects(List<CustomPotionEffect> effects,
 float probability)

Creates an instance of a ApplyEffects record class.

Parameters:

effects - the value for the effects record component

probability - the value for the probability record component

ApplyEffects

public ApplyEffects(CustomPotionEffect effect,
 float probability)

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.

effects

public List<CustomPotionEffect> effects()

Returns the value of the effects record component.

Returns:

the value of the effects record component

probability

public float probability()

Returns the value of the probability record component.

Returns:

the value of the probability record component