Record Class PlaySoundConsumeEffect

java.lang.Object

java.lang.Record

net.minecraft.world.item.consume_effects.PlaySoundConsumeEffect

All Implemented Interfaces:

ConsumeEffect

public record PlaySoundConsumeEffect(Holder<SoundEvent> sound)
extends Record
implements ConsumeEffect

Nested Class Summary

Nested classes/interfaces inherited from interface ConsumeEffect

ConsumeEffect.Type<T>

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.MapCodec<PlaySoundConsumeEffect>	CODEC
private final Holder<SoundEvent>	sound	The field for the sound record component.
static final StreamCodec<RegistryFriendlyByteBuf, PlaySoundConsumeEffect>	STREAM_CODEC

Constructor Summary

Constructors

Constructor	Description
PlaySoundConsumeEffect(Holder<SoundEvent> sound)	Creates an instance of a PlaySoundConsumeEffect record class.

Method Summary

Modifier and Type	Method	Description
boolean	apply(Level level, ItemStack stack, LivingEntity user)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
ConsumeEffect.Type<PlaySoundConsumeEffect>	getType()
final int	hashCode()	Returns a hash code value for this object.
Holder<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 Object

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

Field Details

sound

private final Holder<SoundEvent> sound

The field for the sound record component.

CODEC

public static final com.mojang.serialization.MapCodec<PlaySoundConsumeEffect> CODEC

STREAM_CODEC

public static final StreamCodec<RegistryFriendlyByteBuf, PlaySoundConsumeEffect> STREAM_CODEC

Constructor Details

PlaySoundConsumeEffect

public PlaySoundConsumeEffect(Holder<SoundEvent> sound)

Creates an instance of a PlaySoundConsumeEffect record class.

Parameters:

sound - the value for the sound record component

Method Details

getType

public ConsumeEffect.Type<PlaySoundConsumeEffect> getType()

Specified by:

getType in interface ConsumeEffect

apply

public boolean apply(Level level,
 ItemStack stack,
 LivingEntity user)

Specified by:

apply in interface ConsumeEffect

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.

sound

public Holder<SoundEvent> sound()

Returns the value of the sound record component.

Returns:

the value of the sound record component