Class NetworkPacket<T>`Abstract`

Represents the network packet (aka DataPacket). This is just a serialization layer to include the packet header and to reduce redundancy in the packet classes. https://mojang.github.io/bedrock-protocol-docs/html/packetHeader.html

Type Parameters

T

Index

Constructors

Properties

senderSubClientId targetSubClientId

Accessors

Methods

deserialize deserializePayload getPacketData serialize serializePayload

Constructors

constructor

new NetworkPacket<T>(packetData?: null | T): NetworkPacket<T>
Constructs a new network packet.
Type Parameters
- T
Parameters
- packetData: null | T = null
  The packet data to include in the network packet.
Returns NetworkPacket<T>
- Defined in packages/protocol/src/NetworkPacket.ts:28

Properties

senderSubClientId

senderSubClientId: number = 0

targetSubClientId

targetSubClientId: number = 0

Accessors

`Abstract`id

get id(): number
Returns number
- Defined in packages/protocol/src/NetworkPacket.ts:10

Methods

deserialize

deserialize(stream: NetworkBinaryStream): T
Deserializes the network packet from a binary stream.
Parameters
- stream: NetworkBinaryStream
  The binary stream to deserialize from.
Returns T
- Defined in packages/protocol/src/NetworkPacket.ts:65

`Protected` `Abstract`deserializePayload

deserializePayload(stream: NetworkBinaryStream): T
Deserializes the payload of the network packet from a binary stream.
Parameters
- stream: NetworkBinaryStream
  The binary stream to deserialize from.
Returns T
- Defined in packages/protocol/src/NetworkPacket.ts:59

getPacketData

getPacketData(): null | T
Gets the packet data. Probably will be removed in the future.

Returns null | T
The packet data.
- Defined in packages/protocol/src/NetworkPacket.ts:86

serialize

serialize(stream: NetworkBinaryStream): Buffer
Serializes the network packet into a binary stream.
Parameters
- stream: NetworkBinaryStream
  The binary stream to serialize into.
Returns Buffer
The serialized network packet as a Buffer.
- Defined in packages/protocol/src/NetworkPacket.ts:42

`Protected` `Abstract`serializePayload

serializePayload(stream: NetworkBinaryStream, packetData: T): void
Serializes the payload of the network packet into a binary stream.
Parameters
- stream: NetworkBinaryStream
  The binary stream to serialize into.
- packetData: T
  The packet data to serialize.
Returns void
- Defined in packages/protocol/src/NetworkPacket.ts:35