Package net.minestom.server.network.packet.server.play

Record Class SoundEffectPacket

java.lang.Object
java.lang.Record
net.minestom.server.network.packet.server.play.SoundEffectPacket
All Implemented Interfaces:
SendablePacket, ServerPacket, Writeable
public record SoundEffectPacket(int soundId, @NotNull Sound.Source source, int x, int y, int z, float volume, float pitch) extends Record implements ServerPacket

  • Constructor Summary

    Constructors
    Constructor
    Description
    SoundEffectPacket(int soundId, @NotNull Sound.Source source, int x, int y, int z, float volume, float pitch)
    Creates an instance of a SoundEffectPacket record class.
    SoundEffectPacket(@NotNull SoundEvent sound, @NotNull Sound.Source source, @NotNull Point position, float volume, float pitch)
     
    SoundEffectPacket(BinaryReader reader)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    int
    getId()
    Gets the id of this packet.
    final int
    hashCode()
    Returns a hash code value for this object.
    float
    pitch()
    Returns the value of the pitch record component.
    int
    soundId()
    Returns the value of the soundId record component.
    @NotNull 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.
    void
    write(@NotNull BinaryWriter writer)
    Writes into a BinaryWriter.
    int
    x()
    Returns the value of the x record component.
    int
    y()
    Returns the value of the y record component.
    int
    z()
    Returns the value of the z record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • SoundEffectPacket

      public SoundEffectPacket(BinaryReader reader)

    • SoundEffectPacket

      public SoundEffectPacket(@NotNull @NotNull SoundEvent sound, @NotNull @NotNull Sound.Source source, @NotNull @NotNull Point position, float volume, float pitch)

    • SoundEffectPacket

      public SoundEffectPacket(int soundId, @NotNull @NotNull Sound.Source source, int x, int y, int z, float volume, float pitch)
      Creates an instance of a SoundEffectPacket record class.
      Parameters:
      soundId - the value for the soundId record component
      source - the value for the source record component
      x - the value for the x record component
      y - the value for the y record component
      z - the value for the z record component
      volume - the value for the volume record component
      pitch - the value for the pitch record component

  • Method Details

    • write

      public void write(@NotNull @NotNull BinaryWriter writer)
      Description copied from interface: Writeable
      Writes into a BinaryWriter.
      Specified by:
      write in interface Writeable
      Parameters:
      writer - the writer to write to

    • getId

      public int getId()
      Description copied from interface: ServerPacket
      Gets the id of this packet.

      Written in the final buffer header so it needs to match the client id.

      Specified by:
      getId in interface ServerPacket
      Returns:
      the id of this packet

    • 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.

    • soundId

      public int soundId()
      Returns the value of the soundId record component.
      Returns:
      the value of the soundId record component

    • source

      @NotNull public @NotNull Sound.Source source()
      Returns the value of the source record component.
      Returns:
      the value of the source record component

    • x

      public int x()
      Returns the value of the x record component.
      Returns:
      the value of the x record component

    • y

      public int y()
      Returns the value of the y record component.
      Returns:
      the value of the y record component

    • z

      public int z()
      Returns the value of the z record component.
      Returns:
      the value of the z 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