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

Package-level declarations

Utilities for creating client-to-server and server-to-client packets

Types

sealed class AbstractPacketDefinition<T : Any, C>

Abstraction of server-to-client and client-to-server packets. See ServerToClientPacketDefinition and ClientToServerPacketDefinition. Additionally, this class is partially the basis of ClientToClientPacketDefinition.

ClientPacketContext

class ClientPacketContext(val client: Minecraft = Minecraft.getInstance())

ClientToClientPacketDefinition

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

See c2cPacket function, which constructs this packet definition class.

ClientToServerPacketDefinition

class ClientToServerPacketDefinition<T : Any>(id: ResourceLocation, binaryFormat: BinaryFormat, deserializer: KSerializer<T>) : AbstractPacketDefinition<T, ServerPacketContext>

See c2sPacket function, which constructs this packet definition class.

ServerPacketContext

class ServerPacketContext(val server: MinecraftServer, val player: ServerPlayer, val handler: ServerGamePacketListenerImpl)

ServerPacketForwarder

typealias ServerPacketForwarder<T> = suspend ClientToClientPacketDefinition<T>.(packet: ClientToClientPacketDefinition.SerializedPacket, context: ServerPacketContext) -> Collection<ServerPlayer>

Used by the ClientToClientPacketDefinition, which requires a server-side forwarder.

ServerToClientPacketDefinition

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

See s2cPacket function, which constructs this packet definition class.

Functions

c2cPacket

inline fun <T : Any> c2cPacket(id: ResourceLocation, format: BinaryFormat = Cbor): ClientToClientPacketDefinition<T>

Creates a new ClientToClientPacketDefinition. This packet can only be sent from the client to another client. The server will act as the middle man, it is responsible for forwarding this packet. The packet can only be sent in a typesafe way. The type is specified by T.

c2sPacket

inline fun <T : Any> c2sPacket(id: ResourceLocation, format: BinaryFormat = Cbor): ClientToServerPacketDefinition<T>

Creates a new ClientToServerPacketDefinition. This packet can only be sent from the client to the current server. The packet can only be sent in a typesafe way. The type is specified by T.

s2cPacket

inline fun <T : Any> s2cPacket(id: ResourceLocation, format: BinaryFormat = Cbor): ServerToClientPacketDefinition<T>

Creates a new ServerToClientPacketDefinition. This packet can only be sent from the server to one or multiple clients. The packet can only be sent in a typesafe way. The type is specified by T.