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

Record Class ScoreboardObjectivePacket

java.lang.Object
java.lang.Record
net.minestom.server.network.packet.server.play.ScoreboardObjectivePacket
All Implemented Interfaces:
ComponentHolder<ServerPacket>, NetworkBuffer.Writer, ComponentHoldingServerPacket, SendablePacket, ServerPacket
public record ScoreboardObjectivePacket(@NotNull String objectiveName, byte mode, @Nullable net.kyori.adventure.text.Component objectiveValue, @Nullable ScoreboardObjectivePacket.Type type, Sidebar.NumberFormat numberFormat) extends Record implements ComponentHoldingServerPacket

  • Constructor Details

    • ScoreboardObjectivePacket

      public ScoreboardObjectivePacket(@NotNull @NotNull NetworkBuffer reader)

    • ScoreboardObjectivePacket

      public ScoreboardObjectivePacket(@NotNull @NotNull String objectiveName, byte mode, @Nullable @Nullable net.kyori.adventure.text.Component objectiveValue, @Nullable @Nullable ScoreboardObjectivePacket.Type type, @Nullable Sidebar.NumberFormat numberFormat)
      Creates an instance of a ScoreboardObjectivePacket record class.
      Parameters:
      objectiveName - the value for the objectiveName record component
      mode - the value for the mode record component
      objectiveValue - the value for the objectiveValue record component
      type - the value for the type record component
      numberFormat - the value for the numberFormat record component

  • Method Details

    • write

      public void write(@NotNull @NotNull NetworkBuffer writer)
      Specified by:
      write in interface NetworkBuffer.Writer

    • getId

      public int getId(@NotNull @NotNull ConnectionState state)
      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

    • components

      @NotNull public @NotNull Collection<net.kyori.adventure.text.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<net.kyori.adventure.text.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

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

    • objectiveName

      @NotNull public @NotNull String objectiveName()
      Returns the value of the objectiveName record component.
      Returns:
      the value of the objectiveName record component

    • mode

      public byte mode()
      Returns the value of the mode record component.
      Returns:
      the value of the mode record component

    • objectiveValue

      @Nullable public @Nullable net.kyori.adventure.text.Component objectiveValue()
      Returns the value of the objectiveValue record component.
      Returns:
      the value of the objectiveValue record component

    • type

      @Nullable public @Nullable ScoreboardObjectivePacket.Type type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • numberFormat

      @Nullable public Sidebar.NumberFormat numberFormat()
      Returns the value of the numberFormat record component.
      Returns:
      the value of the numberFormat record component