Package net.minestom.server.item.component

Record Class Consumable

java.lang.Object

java.lang.Record

net.minestom.server.item.component.Consumable

public record Consumable(float consumeSeconds, @NotNull ItemAnimation animation, @NotNull SoundEvent sound, boolean hasConsumeParticles, @NotNull List<ConsumeEffect> effects)
extends Record

Field Summary

Fields

Modifier and Type	Field	Description
static final Codec<Consumable>	CODEC
static final float	DEFAULT_CONSUME_SECONDS
static final NetworkBuffer.Type<Consumable>	NETWORK_TYPE

Constructor Summary

Constructors

Constructor	Description
Consumable(float consumeSeconds, @NotNull ItemAnimation animation, @NotNull SoundEvent sound, boolean hasConsumeParticles, @NotNull List<ConsumeEffect> effects)	Creates an instance of a Consumable record class.

Method Summary

Modifier and Type	Method	Description
@NotNull ItemAnimation	animation()	Returns the value of the animation record component.
float	consumeSeconds()	Returns the value of the consumeSeconds record component.
int	consumeTicks()
@NotNull List<ConsumeEffect>	effects()	Returns the value of the effects record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
boolean	hasConsumeParticles()	Returns the value of the hasConsumeParticles record component.
final int	hashCode()	Returns a hash code value for this object.
@NotNull SoundEvent	sound()	Returns the value of the sound record component.
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

DEFAULT_CONSUME_SECONDS

public static final float DEFAULT_CONSUME_SECONDS

See Also:

• Constant Field Values

NETWORK_TYPE

public static final NetworkBuffer.Type<Consumable> NETWORK_TYPE

CODEC

public static final Codec<Consumable> CODEC

Constructor Details

Consumable

public Consumable(float consumeSeconds,
 @NotNull
 @NotNull ItemAnimation animation,
 @NotNull
 @NotNull SoundEvent sound,
 boolean hasConsumeParticles,
 @NotNull
 @NotNull List<ConsumeEffect> effects)

Creates an instance of a Consumable record class.

Parameters:

consumeSeconds - the value for the consumeSeconds record component

animation - the value for the animation record component

sound - the value for the sound record component

hasConsumeParticles - the value for the hasConsumeParticles record component

effects - the value for the effects record component

Method Details

consumeTicks

public int consumeTicks()

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 '=='.

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.

consumeSeconds

public float consumeSeconds()

Returns the value of the consumeSeconds record component.

Returns:

the value of the consumeSeconds record component

animation

@NotNull
public @NotNull ItemAnimation animation()

Returns the value of the animation record component.

Returns:

the value of the animation record component

sound

@NotNull
public @NotNull SoundEvent sound()

Returns the value of the sound record component.

Returns:

the value of the sound record component

hasConsumeParticles

public boolean hasConsumeParticles()

Returns the value of the hasConsumeParticles record component.

Returns:

the value of the hasConsumeParticles record component

effects

@NotNull
public @NotNull List<ConsumeEffect> effects()

Returns the value of the effects record component.

Returns:

the value of the effects record component