org.cloudburstmc.protocol.bedrock.codec.compat

Class BedrockCompat

java.lang.Object

org.cloudburstmc.protocol.bedrock.codec.compat.BedrockCompat

public class BedrockCompat
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static BedrockCodec	CODEC This is for servers when figuring out the protocol of a client joining.
static BedrockCodec	CODEC_v291 A legacy version of the compat codec which does not use DisconnectFailReason in DisconnectPacket.
static BedrockCodec	CODEC_v622 A legacy version of the compat codec which does not use filteredMessage in DisconnectPacket.

Constructor Summary

Constructors

Constructor and Description
BedrockCompat()

Method Summary

Modifier and Type	Method and Description
static BedrockCodec	disconnectCompat(int protocolVersion) Certain older protocols have outdated DisconnectPacket formats.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CODEC

public static BedrockCodec CODEC

This is for servers when figuring out the protocol of a client joining. Certain protocols that are older will need to use disconnectCompat(int) before disconnecting, in order for the client to see a proper disconnect message.

CODEC_v291

public static BedrockCodec CODEC_v291

A legacy version of the compat codec which does not use DisconnectFailReason in DisconnectPacket. Use this for protocols lower than v622

CODEC_v622

public static BedrockCodec CODEC_v622

A legacy version of the compat codec which does not use filteredMessage in DisconnectPacket. Use this for protocols equal to or greater than v622, but less than v712

Constructor Detail

BedrockCompat

public BedrockCompat()

Method Detail

disconnectCompat

public static BedrockCodec disconnectCompat(int protocolVersion)

Certain older protocols have outdated DisconnectPacket formats. Using the codec provided by this method before disconnecting a client will always ensure they receive a well-formed DisconnectPacket.

Note that this compat codec should only be used if disconnecting the client upon receiving its protocol version. Otherwise, use a proper codec that targets the specific protocol.

Parameters:

protocolVersion - the client's protocol version

Returns:

a compat codec suitable for disconnecting