silk-network/net.silkmc.silk.network.packet/ClientToClientPacketDefinition

ClientToClientPacketDefinition

class ClientToClientPacketDefinition<T : Any>(id: ResourceLocation, binaryFormat: BinaryFormat, deserializer: KSerializer<T>) : AbstractPacketDefinition<T, ClientPacketContext> (source)

See c2cPacket function, which constructs this packet definition class.

Constructors

constructor(id: ResourceLocation, binaryFormat: BinaryFormat, deserializer: KSerializer<T>)

Types

SerializedPacket

@JvmInline

value class SerializedPacket(val bytes: ByteArray)

A wrapper around a byte array containing packet data. This wrapper will be used when forwarding packets on the server, since deserialization should only happen when requested.

Properties

binaryFormat

val binaryFormat: BinaryFormat

val id: ResourceLocation

streamCodec

val streamCodec: StreamCodec<FriendlyByteBuf, SilkPacketPayload>

type

val type: CustomPacketPayload.Type<SilkPacketPayload>

Functions

deserialize

fun ClientToClientPacketDefinition.SerializedPacket.deserialize(): T

Deserializes this serialized packet to an instance of its original class.

forwardOnServer

fun forwardOnServer(forwarder: ServerPacketForwarder<T>)

Specifies the forward logic (on the server, as it is the instance which forwards this packet). The returned player will receive the packet. Return null if you do not wish to forward this packet.

receiveOnClient

fun receiveOnClient(receiver: suspend (packet: T, context: ClientPacketContext) -> Unit)

Executes the given receiver as a callback when this packet is received on the client-side.

send

fun send(value: T)

Sends the given value as a packet to the server, which will then forward it to players selected by the forwarder. You can specify the forwarder using forwardOnServer.