Record Class PlayerListHeaderAndFooterPacket

java.lang.Object
java.lang.Record
net.minestom.server.network.packet.server.play.PlayerListHeaderAndFooterPacket
All Implemented Interfaces:
ComponentHolder<ServerPacket>, ComponentHoldingServerPacket, SendablePacket, ServerPacket, Writeable

public record PlayerListHeaderAndFooterPacket(@NotNull Component header, @NotNull Component footer) extends Record implements ComponentHoldingServerPacket
  • Constructor Details

    • PlayerListHeaderAndFooterPacket

      public PlayerListHeaderAndFooterPacket(BinaryReader reader)
    • PlayerListHeaderAndFooterPacket

      public PlayerListHeaderAndFooterPacket(@NotNull @NotNull Component header, @NotNull @NotNull Component footer)
      Creates an instance of a PlayerListHeaderAndFooterPacket record class.
      Parameters:
      header - the value for the header record component
      footer - the value for the footer 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
    • components

      @NotNull public @NotNull Collection<Component> components()
      Description copied from interface: ComponentHolder
      Gets the components held by this object.
      Specified by:
      components in interface ComponentHolder<ServerPacket>
      Returns:
      the components
    • copyWithOperator

      @NotNull public @NotNull ServerPacket copyWithOperator(@NotNull @NotNull UnaryOperator<Component> operator)
      Description copied from interface: ComponentHolder
      Returns a copy of this object. For each component this object holds, the operator is applied to the copy before returning.
      Specified by:
      copyWithOperator in interface ComponentHolder<ServerPacket>
      Parameters:
      operator - the operator
      Returns:
      the copy
    • 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. 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.
    • header

      @NotNull public @NotNull Component header()
      Returns the value of the header record component.
      Returns:
      the value of the header record component
    • footer

      @NotNull public @NotNull Component footer()
      Returns the value of the footer record component.
      Returns:
      the value of the footer record component