Package org.geysermc.mcprotocollib.protocol.data.game.item.component

Record Class Consumable

java.lang.Object

java.lang.Record

org.geysermc.mcprotocollib.protocol.data.game.item.component.Consumable

public record Consumable(float consumeSeconds, Consumable.ItemUseAnimation animation, Sound sound, boolean hasConsumeParticles, List<ConsumeEffect> onConsumeEffects)
extends Record

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Consumable.ConsumableBuilder
static enum	Consumable.ItemUseAnimation

Constructor Summary

Constructors

Constructor	Description
Consumable(float consumeSeconds, Consumable.ItemUseAnimation animation, Sound sound, boolean hasConsumeParticles, List<ConsumeEffect> onConsumeEffects)	Creates an instance of a Consumable record class.

Method Summary

Modifier and Type	Method	Description
Consumable.ItemUseAnimation	animation()	Returns the value of the animation record component.
static @NonNull Consumable.ConsumableBuilder	builder()
float	consumeSeconds()	Returns the value of the consumeSeconds 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.
List<ConsumeEffect>	onConsumeEffects()	Returns the value of the onConsumeEffects record component.
Sound	sound()	Returns the value of the sound record component.
@NonNull Consumable.ConsumableBuilder	toBuilder()
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

Constructor Details

Consumable

public Consumable(float consumeSeconds,
 Consumable.ItemUseAnimation animation,
 Sound sound,
 boolean hasConsumeParticles,
 List<ConsumeEffect> onConsumeEffects)

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

onConsumeEffects - the value for the onConsumeEffects record component

Method Details

builder

public static @NonNull Consumable.ConsumableBuilder builder()

toBuilder

public @NonNull Consumable.ConsumableBuilder toBuilder()

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

public Consumable.ItemUseAnimation animation()

Returns the value of the animation record component.

Returns:

the value of the animation record component

sound

public Sound 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

onConsumeEffects

public List<ConsumeEffect> onConsumeEffects()

Returns the value of the onConsumeEffects record component.

Returns:

the value of the onConsumeEffects record component