Package org.geysermc.mcprotocollib.protocol.packet.common.clientbound

Class ClientboundCustomPayloadPacket

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

  • Constructor Details

    • ClientboundCustomPayloadPacket

      public ClientboundCustomPayloadPacket(io.netty.buffer.ByteBuf in, MinecraftCodecHelper helper)

    • ClientboundCustomPayloadPacket

      public ClientboundCustomPayloadPacket(@NonNull @NonNull net.kyori.adventure.key.Key channel, byte @NonNull [] data)

  • Method Details

    • serialize

      public void serialize(io.netty.buffer.ByteBuf out, MinecraftCodecHelper helper)
      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.

    • getChannel

      @NonNull public @NonNull net.kyori.adventure.key.Key getChannel()

    • getData

      public byte @NonNull [] getData()

    • 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

    • withChannel

      public @NonNull ClientboundCustomPayloadPacket withChannel(@NonNull @NonNull net.kyori.adventure.key.Key channel)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withData

      public @NonNull ClientboundCustomPayloadPacket withData(byte @NonNull [] data)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).