Interface VersionedPacketTransformer<C extends ClientboundPacketType,S extends ServerboundPacketType>

Method Details

• send

  boolean send(PacketWrapper packet) throws InformativeException

  Sends a packet to the user or server, depending on the packet type given by PacketWrapper.getPacketType(). Returns false if the packet has been cancelled at some point, but does not indicate whether a replacement has been constructed.

  Returns:

  whether this packet specifically has been sent, false if cancelled

  Throws:

  IllegalArgumentException - if the packet type is not of the expected clientbound or serverbound packets class

  IllegalArgumentException - if PacketWrapper.user() returns null

  RuntimeException - if no path from the input version to the required client version exists

  InformativeException - if an error occurred while transforming or sending the packet

• send

  boolean send(UserConnection connection, C packetType, Consumer<PacketWrapper> packetWriter) throws InformativeException

  Throws:

  InformativeException

  See Also:

  • send(PacketWrapper)

• send

  boolean send(UserConnection connection, S packetType, Consumer<PacketWrapper> packetWriter) throws InformativeException

  Throws:

  InformativeException

  See Also:

  • send(PacketWrapper)

• scheduleSend

  boolean scheduleSend(PacketWrapper packet) throws InformativeException

  Sends a packet to the user or server, depending on the packet type given by PacketWrapper.getPacketType(), submitted to the netty event loop. Returns false if the packet has been cancelled at some point, but does not indicate whether a replacement has been constructed.

  Parameters:

  packet - packet wrapper

  Returns:

  whether this packet specifically has been sent, false if cancelled

  Throws:

  IllegalArgumentException - if the packet type is not of the expected clientbound or serverbound packets class

  IllegalArgumentException - if PacketWrapper.user() returns null

  RuntimeException - if no path from the input version to the required client version exists

  InformativeException - if an error occurred while transforming or sending the packet

• scheduleSend

  boolean scheduleSend(UserConnection connection, C packetType, Consumer<PacketWrapper> packetWriter) throws InformativeException

  Throws:

  InformativeException

  See Also:

  • scheduleSend(PacketWrapper)

• scheduleSend

  boolean scheduleSend(UserConnection connection, S packetType, Consumer<PacketWrapper> packetWriter) throws InformativeException

  Throws:

  InformativeException

  See Also:

  • scheduleSend(PacketWrapper)

• transform

  @Nullable PacketWrapper transform(PacketWrapper packet) throws InformativeException

  Transforms a packet to the protocol version of the given connection or server, or null if cancelled at some point. The target version is given by ProtocolInfo.getProtocolVersion() or ProtocolInfo.getServerProtocolVersion().

  Parameters:

  packet - packet wrapper

  Returns:

  created and transformed packet wrapper, or null if cancelled at some point

  Throws:

  IllegalArgumentException - if the packet type is not of the expected clientbound or serverbound packets class

  IllegalArgumentException - if PacketWrapper.user() returns null

  RuntimeException - if no path from the input version to the required client version exists

  InformativeException - if an error occurred while transforming the packet

• transform

  @Nullable PacketWrapper transform(UserConnection connection, C packetType, Consumer<PacketWrapper> packetWriter) throws InformativeException

  Throws:

  InformativeException

  See Also:

  • transform(PacketWrapper)

• transform

  @Nullable PacketWrapper transform(UserConnection connection, S packetType, Consumer<PacketWrapper> packetWriter) throws InformativeException

  Throws:

  InformativeException

  See Also:

  • transform(PacketWrapper)