Record Class SoundEffectPacket

java.lang.Object

java.lang.Record

net.minestom.server.network.packet.server.play.SoundEffectPacket

All Implemented Interfaces:

SendablePacket, ServerPacket, ServerPacket.Play

public record SoundEffectPacket(SoundEvent soundEvent, Sound.Source source, Point origin, float volume, float pitch, long seed)
extends Record
implements ServerPacket.Play

Nested Class Summary

Nested classes/interfaces inherited from interface ServerPacket

ServerPacket.ComponentHolding, ServerPacket.Configuration, ServerPacket.Login, ServerPacket.Play, ServerPacket.Status

Field Summary

Fields

Modifier and Type	Field	Description
static final NetworkBuffer.Type<SoundEffectPacket>	SERIALIZER

Constructor Summary

Constructors

Constructor	Description
SoundEffectPacket(SoundEvent soundEvent, Sound.Source source, int x, int y, int z, float volume, float pitch, long seed)	Deprecated, for removal: This API element is subject to removal in a future version. Use SoundEffectPacket(SoundEvent, Source, Point, float, float, long)
SoundEffectPacket(SoundEvent soundEvent, Sound.Source source, Point origin, float volume, float pitch, long seed)	Creates an instance of a SoundEffectPacket record class.

Method Summary

Modifier and Type	Method	Description
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.
Point	origin()	Returns the value of the origin record component.
float	pitch()	Returns the value of the pitch record component.
long	seed()	Returns the value of the seed record component.
SoundEvent	soundEvent()	Returns the value of the soundEvent record component.
Sound.Source	source()	Returns the value of the source record component.
final String	toString()	Returns a string representation of this record class.
float	volume()	Returns the value of the volume record component.
int	x()	Deprecated, for removal: This API element is subject to removal in a future version. Use origin() with Point.blockX() instead.
int	y()	Deprecated, for removal: This API element is subject to removal in a future version. Use origin() with Point.blockY() instead.
int	z()	Deprecated, for removal: This API element is subject to removal in a future version. Use origin() with Point.blockZ() instead.

Methods inherited from class Object

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

Field Details

SERIALIZER

public static final NetworkBuffer.Type<SoundEffectPacket> SERIALIZER

Constructor Details

SoundEffectPacket

@Deprecated(forRemoval=true)
public SoundEffectPacket(SoundEvent soundEvent,
 Sound.Source source,
 int x,
 int y,
 int z,
 float volume,
 float pitch,
 long seed)

Deprecated, for removal: This API element is subject to removal in a future version.

Use SoundEffectPacket(SoundEvent, Source, Point, float, float, long)

SoundEffectPacket

public SoundEffectPacket(SoundEvent soundEvent,
 Sound.Source source,
 Point origin,
 float volume,
 float pitch,
 long seed)

Creates an instance of a SoundEffectPacket record class.

Parameters:

soundEvent - the value for the soundEvent record component

source - the value for the source record component

origin - the value for the origin record component

volume - the value for the volume record component

pitch - the value for the pitch record component

seed - the value for the seed record component

Method Details

x

@Deprecated(forRemoval=true)
public int x()

Deprecated, for removal: This API element is subject to removal in a future version.

Use origin() with Point.blockX() instead.

y

@Deprecated(forRemoval=true)
public int y()

Deprecated, for removal: This API element is subject to removal in a future version.

Use origin() with Point.blockY() instead.

z

@Deprecated(forRemoval=true)
public int z()

Deprecated, for removal: This API element is subject to removal in a future version.

Use origin() with Point.blockZ() instead.

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.

soundEvent

public SoundEvent soundEvent()

Returns the value of the soundEvent record component.

Returns:

the value of the soundEvent record component

source

public Sound.Source source()

Returns the value of the source record component.

Returns:

the value of the source record component

origin

public Point origin()

Returns the value of the origin record component.

Returns:

the value of the origin record component

volume

public float volume()

Returns the value of the volume record component.

Returns:

the value of the volume record component

pitch

public float pitch()

Returns the value of the pitch record component.

Returns:

the value of the pitch record component

seed

public long seed()

Returns the value of the seed record component.

Returns:

the value of the seed record component