Record Class EntityEffect.PlaySound

java.lang.Object

java.lang.Record

net.minestom.server.item.enchant.EntityEffect.PlaySound

All Implemented Interfaces:

Enchantment.Effect, EntityEffect, LocationEffect

Enclosing interface:

EntityEffect

public static record EntityEffect.PlaySound(@NotNull SoundEvent soundEvent, Codec.RawValue volume, Codec.RawValue pitch)
extends Record
implements EntityEffect, LocationEffect

Nested Class Summary

Nested classes/interfaces inherited from interface net.minestom.server.item.enchant.EntityEffect

EntityEffect.AllOf, EntityEffect.ApplyPotionEffect, EntityEffect.ChangeItemDamage, EntityEffect.DamageEntity, EntityEffect.Explode, EntityEffect.Ignite, EntityEffect.PlaySound, EntityEffect.ReplaceBlock, EntityEffect.ReplaceDisc, EntityEffect.RunFunction, EntityEffect.SetBlockProperties, EntityEffect.SpawnParticles, EntityEffect.SummonEntity

Nested classes/interfaces inherited from interface net.minestom.server.item.enchant.LocationEffect

LocationEffect.AllOf

Field Summary

Fields

Modifier and Type	Field	Description
static final StructCodec<EntityEffect.PlaySound>	CODEC

Constructor Summary

Constructors

Constructor	Description
PlaySound(@NotNull SoundEvent soundEvent, Codec.RawValue volume, Codec.RawValue pitch)	Creates an instance of a PlaySound record class.

Method Summary

Modifier and Type	Method	Description
@NotNull StructCodec<EntityEffect.PlaySound>	codec()
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.
Codec.RawValue	pitch()	Returns the value of the pitch record component.
@NotNull SoundEvent	soundEvent()	Returns the value of the soundEvent record component.
final String	toString()	Returns a string representation of this record class.
Codec.RawValue	volume()	Returns the value of the volume record component.

Methods inherited from class java.lang.Object

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

Field Details

CODEC

public static final StructCodec<EntityEffect.PlaySound> CODEC

Constructor Details

PlaySound

public PlaySound(@NotNull
 @NotNull SoundEvent soundEvent,
 @NotNull
 Codec.RawValue volume,
 @NotNull
 Codec.RawValue pitch)

Creates an instance of a PlaySound record class.

Parameters:

soundEvent - the value for the soundEvent record component

volume - the value for the volume record component

pitch - the value for the pitch record component

Method Details

codec

@NotNull
public @NotNull StructCodec<EntityEffect.PlaySound> codec()

Specified by:

codec in interface EntityEffect

Specified by:

codec in interface LocationEffect

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.

soundEvent

@NotNull
public @NotNull SoundEvent soundEvent()

Returns the value of the soundEvent record component.

Returns:

the value of the soundEvent record component

volume

@NotNull
public Codec.RawValue volume()

Returns the value of the volume record component.

Returns:

the value of the volume record component

pitch

@NotNull
public Codec.RawValue pitch()

Returns the value of the pitch record component.

Returns:

the value of the pitch record component