Record Class ParticlePacket

java.lang.Object
java.lang.Record
net.minestom.server.network.packet.server.play.ParticlePacket
All Implemented Interfaces:
NetworkBuffer.Writer, SendablePacket, ServerPacket

public record ParticlePacket(int particleId, boolean longDistance, double x, double y, double z, float offsetX, float offsetY, float offsetZ, float particleData, int particleCount, byte[] data) extends Record implements ServerPacket
  • Constructor Summary

    Constructors
    Constructor
    Description
    ParticlePacket(int particleId, boolean longDistance, double x, double y, double z, float offsetX, float offsetY, float offsetZ, float particleData, int particleCount, byte[] data)
    Creates an instance of a ParticlePacket record class.
    ParticlePacket(@NotNull NetworkBuffer reader)
     
  • Method Summary

    Modifier and Type
    Method
    Description
    byte[]
    Returns the value of the data record component.
    final boolean
    Indicates whether some other object is "equal to" this one.
    int
    Gets the id of this packet.
    final int
    Returns a hash code value for this object.
    boolean
    Returns the value of the longDistance record component.
    float
    Returns the value of the offsetX record component.
    float
    Returns the value of the offsetY record component.
    float
    Returns the value of the offsetZ record component.
    int
    Returns the value of the particleCount record component.
    float
    Returns the value of the particleData record component.
    int
    Returns the value of the particleId record component.
    final String
    Returns a string representation of this record class.
    void
    write(@NotNull NetworkBuffer writer)
     
    double
    x()
    Returns the value of the x record component.
    double
    y()
    Returns the value of the y record component.
    double
    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

    • ParticlePacket

      public ParticlePacket(@NotNull @NotNull NetworkBuffer reader)
    • ParticlePacket

      public ParticlePacket(int particleId, boolean longDistance, double x, double y, double z, float offsetX, float offsetY, float offsetZ, float particleData, int particleCount, byte[] data)
      Creates an instance of a ParticlePacket record class.
      Parameters:
      particleId - the value for the particleId record component
      longDistance - the value for the longDistance 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
      offsetX - the value for the offsetX record component
      offsetY - the value for the offsetY record component
      offsetZ - the value for the offsetZ record component
      particleData - the value for the particleData record component
      particleCount - the value for the particleCount record component
      data - the value for the data record component
  • Method Details

    • write

      public void write(@NotNull @NotNull NetworkBuffer writer)
      Specified by:
      write in interface NetworkBuffer.Writer
    • 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.
    • particleId

      public int particleId()
      Returns the value of the particleId record component.
      Returns:
      the value of the particleId record component
    • longDistance

      public boolean longDistance()
      Returns the value of the longDistance record component.
      Returns:
      the value of the longDistance record component
    • x

      public double x()
      Returns the value of the x record component.
      Returns:
      the value of the x record component
    • y

      public double y()
      Returns the value of the y record component.
      Returns:
      the value of the y record component
    • z

      public double z()
      Returns the value of the z record component.
      Returns:
      the value of the z record component
    • offsetX

      public float offsetX()
      Returns the value of the offsetX record component.
      Returns:
      the value of the offsetX record component
    • offsetY

      public float offsetY()
      Returns the value of the offsetY record component.
      Returns:
      the value of the offsetY record component
    • offsetZ

      public float offsetZ()
      Returns the value of the offsetZ record component.
      Returns:
      the value of the offsetZ record component
    • particleData

      public float particleData()
      Returns the value of the particleData record component.
      Returns:
      the value of the particleData record component
    • particleCount

      public int particleCount()
      Returns the value of the particleCount record component.
      Returns:
      the value of the particleCount record component
    • data

      public byte[] data()
      Returns the value of the data record component.
      Returns:
      the value of the data record component