Package org.geysermc.mcprotocollib.protocol.packet.ingame.clientbound.scoreboard

Class ClientboundSetObjectivePacket

java.lang.Object
org.geysermc.mcprotocollib.protocol.packet.ingame.clientbound.scoreboard.ClientboundSetObjectivePacket
All Implemented Interfaces:
Packet, MinecraftPacket
public class ClientboundSetObjectivePacket extends Object implements MinecraftPacket

  • Constructor Details

    • ClientboundSetObjectivePacket

      public ClientboundSetObjectivePacket(@NonNull @NonNull String name)
      Constructs a ServerScoreboardObjectivePacket for removing an objective.
      Parameters:
      name - Name of the objective.

    • ClientboundSetObjectivePacket

      public ClientboundSetObjectivePacket(@NonNull @NonNull String name, @NonNull @NonNull ObjectiveAction action, @Nullable net.kyori.adventure.text.Component displayName, @Nullable ScoreType type, @Nullable NumberFormat numberFormat)
      Constructs a ServerScoreboardObjectivePacket for adding or updating an objective.
      Parameters:
      name - Name of the objective.
      action - Action to perform.
      displayName - Display name of the objective.
      type - Type of score.
      numberFormat - Number formatting.

    • ClientboundSetObjectivePacket

      public ClientboundSetObjectivePacket(io.netty.buffer.ByteBuf in)

  • Method Details

    • serialize

      public void serialize(io.netty.buffer.ByteBuf out)
      Specified by:
      serialize in interface MinecraftPacket

    • shouldRunOnGameThread

      public boolean shouldRunOnGameThread()
      Description copied from interface: Packet
      Gets whether the packet should run on an async game thread rather than blocking the network (Netty) thread. Packets that qualify for this are usually packets with an ensureRunningOnSameThread call at the top of their packet listener method in the Minecraft code. Packets which need extra attention because they aren't "fully" handled async are marked using // GAME THREAD DETAIL comments in the MCProtocolLib code.
      Specified by:
      shouldRunOnGameThread in interface Packet
      Returns:
      Whether the packet be handled async from the Netty thread.

    • getName

      @NonNull public @NonNull String getName()

    • getAction

      @NonNull public @NonNull ObjectiveAction getAction()

    • getDisplayName

      public @Nullable net.kyori.adventure.text.Component getDisplayName()
      Not null if getAction() is ObjectiveAction.ADD or ObjectiveAction.UPDATE

    • getType

      public @Nullable ScoreType getType()
      Not null if getAction() is ObjectiveAction.ADD or ObjectiveAction.UPDATE

    • getNumberFormat

      public @Nullable NumberFormat getNumberFormat()

    • equals

      public boolean equals(@Nullable Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(@Nullable Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public @NonNull String toString()
      Overrides:
      toString in class Object

    • withName

      public @NonNull ClientboundSetObjectivePacket withName(@NonNull @NonNull String name)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withAction

      public @NonNull ClientboundSetObjectivePacket withAction(@NonNull @NonNull ObjectiveAction action)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withDisplayName

      public @NonNull ClientboundSetObjectivePacket withDisplayName(@Nullable net.kyori.adventure.text.Component displayName)
      Not null if getAction() is ObjectiveAction.ADD or ObjectiveAction.UPDATE
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withType

      public @NonNull ClientboundSetObjectivePacket withType(@Nullable ScoreType type)
      Not null if getAction() is ObjectiveAction.ADD or ObjectiveAction.UPDATE
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withNumberFormat

      public @NonNull ClientboundSetObjectivePacket withNumberFormat(@Nullable NumberFormat numberFormat)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).