Record Class SetVersionPacket

java.lang.Object

java.lang.Record

dev.jorel.commandapi.network.packets.SetVersionPacket

Record Components:

protocolVersion - The CommandAPIProtocol.PROTOCOL_VERSION to send in this packet.

All Implemented Interfaces:

CommandAPIPacket

public record SetVersionPacket(int protocolVersion)
extends Record
implements CommandAPIPacket

A packet that conveys what CommandAPIProtocol.PROTOCOL_VERSION a connected instance of the CommandAPI is using.

This packet may be sent in any direction. It should be sent whenever a Player connects to a Server from the CommandAPI instances on both sides (if they exist). If this packet is never received, the protocol version defaults to 0.

Constructor Summary

Constructors

Constructor	Description
SetVersionPacket(int protocolVersion)	Creates an instance of a SetVersionPacket record class.

Method Summary

Modifier and Type	Method	Description
static SetVersionPacket	deserialize(FriendlyByteBuffer buffer)	Reads the bytes from the given FriendlyByteBuffer to create a new SetVersionPacket.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
int	protocolVersion()	Returns the value of the protocolVersion record component.
final String	toString()	Returns a string representation of this record class.
void	write(FriendlyByteBuffer buffer, Object target, int protocolVersion)	Writes the data of this packet to a FriendlyByteBuffer.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SetVersionPacket

public SetVersionPacket(int protocolVersion)

Creates an instance of a SetVersionPacket record class.

Parameters:

protocolVersion - the value for the protocolVersion record component

Method Details

deserialize

public static SetVersionPacket deserialize(FriendlyByteBuffer buffer)

Reads the bytes from the given FriendlyByteBuffer to create a new SetVersionPacket.

Parameters:

buffer - The buffer to read bytes from.

Returns:

The SetVersionPacket sent to this plugin.

write

public void write(FriendlyByteBuffer buffer,
 Object target,
 int protocolVersion)

Description copied from interface: CommandAPIPacket

Writes the data of this packet to a FriendlyByteBuffer.

Specified by:

write in interface CommandAPIPacket

Parameters:

buffer - The byte buffer to write to.

target - The OutputChannel this packet is being sent to.

protocolVersion - The CommandAPIProtocol.PROTOCOL_VERSION of the CommandAPI instance this packet is being sent to. Implementations of this method should make sure not to send any data the receiving instance can not understand. If this packet simply cannot be sent to the receiving version, it is appropriate to throw an ProtocolVersionTooOldException.

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. All components in this record class are compared with the compare method from their corresponding wrapper classes.

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.

protocolVersion

public int protocolVersion()

Returns the value of the protocolVersion record component.

Returns:

the value of the protocolVersion record component