JSPrismarine

API reference / @jsprismarine/protocol / ClientboundAttributeLayerSyncPacket

Class: ClientboundAttributeLayerSyncPacket ​

Defined in: protocol/src/packet/ClientboundAttributeLayerSyncPacket.ts:86

Syncs the server's environment attribute layers (fog, lighting and similar per-dimension attributes blended by priority and weight) to the client.

Protocol 2193 layout, in wire order: Data as a Cereal tagged variant, a varuint32 selector (the AttributeLayerSyncDataType value) followed by the alternative's fields. Every list is a varuint32 count then its items. UpdateAttributeLayersData is Attribute Layers, a list of AttributeLayerData. The other three alternatives open with Attribute Layer Name (string) and Attribute Layer Dimension (ZigZag varint32), then UpdateAttributeLayerSettingsData continues with Attributes Layer Settings as an AttributeLayerSettings, UpdateEnvironmentAttributesData with Attributes as a list of EnvironmentAttributeData, and RemoveEnvironmentAttributesData with Attributes as a list of strings.

Mojang merged four earlier drafts (ClientboundAttributeLayerPacket, ClientboundAttributeLayerSettingsPacket, ClientboundEnvironmentAttributeUpdatePacket and ClientboundEnvironmentAttributeRemovePacket) into this one variant. The 1.26.51 schema marks the packet "Currently disabled", so no release client has been seen to handle it. Protocol 2207 restructures EnvironmentAttributeData and drops NoiseName.

Extends ​

Constructors ​

Constructor ​

new ClientboundAttributeLayerSyncPacket(packetData?, buffer?): ClientboundAttributeLayerSyncPacket

Defined in: protocol/src/NetworkPacket.ts:61

Constructs a new network packet.

Parameters ​

packetData? ​

ClientboundAttributeLayerSync | null = null

The packet data to include in the network packet.

buffer? ​

Buffer<ArrayBufferLike>

Returns ​

ClientboundAttributeLayerSyncPacket

Inherited from ​

NetworkPacket.constructor

Properties ​

codecProtocol ​

codecProtocol: number = protocolVersion

Defined in: protocol/src/NetworkPacket.ts:53

Version stamped by the connection codec for version-gated payloads.

Inherited from ​

NetworkPacket.codecProtocol

senderSubClientId ​

senderSubClientId: number = 0

Defined in: protocol/src/NetworkPacket.ts:50

Inherited from ​

NetworkPacket.senderSubClientId

targetSubClientId ​

targetSubClientId: number = 0

Defined in: protocol/src/NetworkPacket.ts:51

Inherited from ​

NetworkPacket.targetSubClientId

Accessors ​

id ​

Get Signature ​

get id(): number

Defined in: protocol/src/packet/ClientboundAttributeLayerSyncPacket.ts:87

Returns ​

number

Methods ​

clear() ​

clear(): void

Defined in: binaryutils/src/BinaryStream.ts:977

Clears the whole BinaryStream instance.

The write buffer and its capacity are kept, so any view previously returned by getWriteBuffer is invalidated. See resetWrite.

Returns ​

void

Inherited from ​

NetworkPacket.clear

copyInto() ​

copyInto(target, offset?): number

Defined in: binaryutils/src/BinaryStream.ts:856

Copies the encoded bytes into a caller-owned buffer at offset and returns the offset just past them. Lets many packets be encoded into one arena with no per-packet allocation at all.

Parameters ​

target ​

Buffer

offset? ​

number = 0

Returns ​

number

the new offset

Inherited from ​

NetworkPacket.copyInto

copyOut() ​

copyOut(): Buffer

Defined in: binaryutils/src/BinaryStream.ts:840

Returns the encoded bytes as an exactly-sized, standalone Buffer.

Unlike getWriteBuffer the result does not alias this stream, so it survives resetWrite, and it does not pin a pool chunk: because Buffer.allocUnsafe is pool-backed (Buffer.poolSize is 64 KB on current Node), holding on to a handful of small slices from getWriteBuffer can keep megabytes alive.

Returns ​

Buffer

Inherited from ​

NetworkPacket.copyOut

decode() ​

decode(context?): void

Defined in: protocol/src/NetworkPacket.ts:125

Decodes a packet from this instance's read buffer.

Parameters ​

context? ​

ProtocolContext

Versioned registries and captured data for this connection.

Returns ​

void

Inherited from ​

NetworkPacket.decode

decodeHeader() ​

decodeHeader(): void

Defined in: protocol/src/NetworkPacket.ts:141

Reads and validates the Bedrock packet header from this instance's read buffer.

Returns ​

void

Inherited from ​

NetworkPacket.decodeHeader

decodePayload() ​

decodePayload(_context?): void

Defined in: protocol/src/NetworkPacket.ts:186

Legacy mutable-field body hook implemented by FieldNetworkPacket.

Parameters ​

_context? ​

ProtocolContext

Versioned registries and captured data for this connection.

Returns ​

void

Inherited from ​

NetworkPacket.decodePayload

deserialize() ​

deserialize(stream, context?): ClientboundAttributeLayerSync

Defined in: protocol/src/NetworkPacket.ts:194

Deserializes the network packet from a binary stream.

Parameters ​

stream ​

NetworkBinaryStream

The stream containing the packet header and body.

context? ​

ProtocolContext

Optional protocol data supplied for the connection.

Returns ​

ClientboundAttributeLayerSync

The typed packet body.

Inherited from ​

NetworkPacket.deserialize

encode() ​

encode(context?): void

Defined in: protocol/src/NetworkPacket.ts:101

Encodes the packet into this instance's write buffer for callers that queue packet objects.

Parameters ​

context? ​

ProtocolContext

Versioned registries and captured data for this connection.

Returns ​

void

Inherited from ​

NetworkPacket.encode

encodeHeader() ​

encodeHeader(): void

Defined in: protocol/src/NetworkPacket.ts:136

Writes the Bedrock packet header to this instance's write buffer.

Returns ​

void

Inherited from ​

NetworkPacket.encodeHeader

encodePayload() ​

encodePayload(_context?): void

Defined in: protocol/src/NetworkPacket.ts:157

Legacy mutable-field body hook implemented by FieldNetworkPacket.

Parameters ​

_context? ​

ProtocolContext

Versioned registries and captured data for this connection.

Returns ​

void

Inherited from ​

NetworkPacket.encodePayload

encodeTransient() ​

encodeTransient(context?): Buffer

Defined in: protocol/src/NetworkPacket.ts:114

Encodes this packet into a fresh stream and returns its backing view for immediate batch assembly. Use encode when the packet bytes need to be retained independently of the batch.

Parameters ​

context? ​

ProtocolContext

Versioned registries and captured data for this connection.

Returns ​

Buffer

A view over the encoded bytes.

Inherited from ​

NetworkPacket.encodeTransient

feof() ​

feof(): boolean

Defined in: binaryutils/src/BinaryStream.ts:875

Returns whatever or not the read offset is at end of line.

Returns ​

boolean

Inherited from ​

NetworkPacket.feof

getBuffer() ​

getBuffer(): Buffer

Defined in: binaryutils/src/BinaryStream.ts:912

Returns the encoded buffer.

Beware: when a read buffer is present this returns that, discarding everything written. On a stream used for both reading and writing it never returns your output.

Returns ​

Buffer

Deprecated ​

See getReadBuffer and getWriteBuffer.

Inherited from ​

NetworkPacket.getBuffer

getEncoded() ​

getEncoded(): boolean

Defined in: protocol/src/NetworkPacket.ts:93

Returns ​

boolean

Whether this packet already has encoded bytes in its stream.

Inherited from ​

NetworkPacket.getEncoded

getId() ​

getId(): number

Defined in: protocol/src/NetworkPacket.ts:80

Gets the wire id stamped by a version codec, or the packet class's default id.

Returns ​

number

The packet id for this instance.

Inherited from ​

NetworkPacket.getId

getName() ​

getName(): string

Defined in: protocol/src/NetworkPacket.ts:72

The class name used by the server's packet handlers and traffic logs.

Returns ​

string

The concrete packet class name.

Inherited from ​

NetworkPacket.getName

getPacketData() ​

getPacketData(): ClientboundAttributeLayerSync | null

Defined in: protocol/src/NetworkPacket.ts:209

Returns the packet body object supplied to the constructor or produced by deserialize.

Returns ​

ClientboundAttributeLayerSync | null

The typed payload, or null before one has been supplied or decoded.

Inherited from ​

NetworkPacket.getPacketData

getReadBuffer() ​

getReadBuffer(): Buffer<ArrayBufferLike> | null

Defined in: binaryutils/src/BinaryStream.ts:920

Returns the read buffer if available.

Returns ​

Buffer<ArrayBufferLike> | null

Inherited from ​

NetworkPacket.getReadBuffer

getReadIndex() ​

getReadIndex(): number

Defined in: binaryutils/src/BinaryStream.ts:1019

Retuns the read index.

Returns ​

number

Inherited from ​

NetworkPacket.getReadIndex

getWriteBuffer() ​

getWriteBuffer(): Buffer

Defined in: binaryutils/src/BinaryStream.ts:936

Returns the encoded bytes as a view over this stream's internal buffer.

The view is only valid until the next write: resetWrite, clear and reuse all rewind the cursor without reallocating, so a previously returned buffer is silently overwritten by the next packet. If you queue the result - a send queue, a resend window - use copyOut or copyInto instead.

It also keeps the whole pooled 64 KB chunk it was carved from alive; retaining a scattered handful of small packets this way can pin megabytes.

Returns ​

Buffer

Inherited from ​

NetworkPacket.getWriteBuffer

getWriteIndex() ​

getWriteIndex(): number

Defined in: binaryutils/src/BinaryStream.ts:1027

Returns the write index.

Returns ​

number

Inherited from ​

NetworkPacket.getWriteIndex

read() ​

read(len): Buffer

Defined in: binaryutils/src/BinaryStream.ts:62

Reads a slice of buffer by the given length.

Parameters ​

len ​

number

How many bytes to read: a nonnegative integer.

Returns ​

Buffer

Throws ​

AssertionError when len is negative or not an integer, or runs past the end.

Inherited from ​

NetworkPacket.read

readBoolean() ​

readBoolean(): boolean

Defined in: binaryutils/src/BinaryStream.ts:179

Reads a boolean (true or false).

Returns ​

boolean

Inherited from ​

NetworkPacket.readBoolean

readByte() ​

readByte(): number

Defined in: binaryutils/src/BinaryStream.ts:143

Reads an unsigned byte (0 to 255).

Returns ​

number

Inherited from ​

NetworkPacket.readByte

readDouble() ​

readDouble(): number

Defined in: binaryutils/src/BinaryStream.ts:481

Returns a 64 bit (8 bytes) big-endian flating point number.

Returns ​

number

Inherited from ​

NetworkPacket.readDouble

readDoubleLE() ​

readDoubleLE(): number

Defined in: binaryutils/src/BinaryStream.ts:501

Returns a 64 bit (8 bytes) little-endian flating point number.

Returns ​

number

Inherited from ​

NetworkPacket.readDoubleLE

readFloat() ​

readFloat(): number

Defined in: binaryutils/src/BinaryStream.ts:441

Returns a 32 bit (4 bytes) big-endian flating point number.

Returns ​

number

Inherited from ​

NetworkPacket.readFloat

readFloatLE() ​

readFloatLE(): number

Defined in: binaryutils/src/BinaryStream.ts:461

Returns a 32 bit (4 bytes) big-endian flating point number.

Returns ​

number

Inherited from ​

NetworkPacket.readFloatLE

readInt() ​

readInt(): number

Defined in: binaryutils/src/BinaryStream.ts:361

Reads a 32 bit (4 bytes) big-endian signed number.

Returns ​

number

Inherited from ​

NetworkPacket.readInt

readIntLE() ​

readIntLE(): number

Defined in: binaryutils/src/BinaryStream.ts:381

Reads a 32 bit (4 bytes) signed number.

Returns ​

number

Inherited from ​

NetworkPacket.readIntLE

readLengthPrefixed() ​

readLengthPrefixed(): Buffer

Defined in: binaryutils/src/BinaryStream.ts:107

Reads a varuint32 byte length, then that many bytes.

Returns ​

Buffer

The bytes, a view into the stream's buffer.

Inherited from ​

NetworkPacket.readLengthPrefixed

readLong() ​

readLong(): bigint

Defined in: binaryutils/src/BinaryStream.ts:521

Returns a 64 bit (8 bytes) signed big-endian number.

Returns ​

bigint

Inherited from ​

NetworkPacket.readLong

readLongLE() ​

readLongLE(): bigint

Defined in: binaryutils/src/BinaryStream.ts:540

Returns a 64 bit (8 bytes) signed little-endian number.

Returns ​

bigint

Inherited from ​

NetworkPacket.readLongLE

readRemaining() ​

readRemaining(): Buffer

Defined in: binaryutils/src/BinaryStream.ts:888

Reads the remaining bytes and returns the buffer slice.

Returns ​

Buffer

Inherited from ​

NetworkPacket.readRemaining

readShort() ​

readShort(): number

Defined in: binaryutils/src/BinaryStream.ts:197

Reads a 16 bit (2 bytes) signed big-endian number.

Returns ​

number

Inherited from ​

NetworkPacket.readShort

readShortLE() ​

readShortLE(): number

Defined in: binaryutils/src/BinaryStream.ts:217

Reads a 16 bit (2 bytes) signed little-endian number.

Returns ​

number

Inherited from ​

NetworkPacket.readShortLE

readSignedByte() ​

readSignedByte(): number

Defined in: binaryutils/src/BinaryStream.ts:161

Reads a signed byte (-128 to 127).

Returns ​

number

Inherited from ​

NetworkPacket.readSignedByte

readTriad() ​

readTriad(): number

Defined in: binaryutils/src/BinaryStream.ts:277

Reads a 24 bit (3 bytes) signed big-endian number.

Returns ​

number

Inherited from ​

NetworkPacket.readTriad

readTriadLE() ​

readTriadLE(): number

Defined in: binaryutils/src/BinaryStream.ts:298

Reads a 24 bit (3 bytes) little-endian number.

Returns ​

number

Inherited from ​

NetworkPacket.readTriadLE

readUnsignedInt() ​

readUnsignedInt(): number

Defined in: binaryutils/src/BinaryStream.ts:401

Reads a 32 bit (4 bytes) big-endian unsigned number.

Returns ​

number

Inherited from ​

NetworkPacket.readUnsignedInt

readUnsignedIntLE() ​

readUnsignedIntLE(): number

Defined in: binaryutils/src/BinaryStream.ts:421

Reads a 32 bit (4 bytes) little-endian unsigned number.

Returns ​

number

Inherited from ​

NetworkPacket.readUnsignedIntLE

readUnsignedLong() ​

readUnsignedLong(): bigint

Defined in: binaryutils/src/BinaryStream.ts:559

Returns a 64 bit (8 bytes) unsigned big-endian number.

Returns ​

bigint

Inherited from ​

NetworkPacket.readUnsignedLong

readUnsignedLongLE() ​

readUnsignedLongLE(): bigint

Defined in: binaryutils/src/BinaryStream.ts:578

Returns a 64 bit (8 bytes) unsigned little-endian number.

Returns ​

bigint

Inherited from ​

NetworkPacket.readUnsignedLongLE

readUnsignedShort() ​

readUnsignedShort(): number

Defined in: binaryutils/src/BinaryStream.ts:237

Reads a 16 bit (2 bytes) unsigned big-endian number.

Returns ​

number

Inherited from ​

NetworkPacket.readUnsignedShort

readUnsignedShortLE() ​

readUnsignedShortLE(): number

Defined in: binaryutils/src/BinaryStream.ts:257

Reads a 16 bit (2 bytes) unsigned little-endian number.

Returns ​

number

Inherited from ​

NetworkPacket.readUnsignedShortLE

readUnsignedTriad() ​

readUnsignedTriad(): number

Defined in: binaryutils/src/BinaryStream.ts:319

Reads a 24 bit (3 bytes) unsigned big-endian number.

Returns ​

number

Inherited from ​

NetworkPacket.readUnsignedTriad

readUnsignedTriadLE() ​

readUnsignedTriadLE(): number

Defined in: binaryutils/src/BinaryStream.ts:340

Reads a 24 bit (3 bytes) unsigned little-endian number.

Returns ​

number

Inherited from ​

NetworkPacket.readUnsignedTriadLE

readUnsignedVarInt() ​

readUnsignedVarInt(): number

Defined in: binaryutils/src/BinaryStream.ts:619

Reads a 32 bit unsigned number.

Returns ​

number

Inherited from ​

NetworkPacket.readUnsignedVarInt

readUnsignedVarLong() ​

readUnsignedVarLong(): bigint

Defined in: binaryutils/src/BinaryStream.ts:702

Reads a 64 bit unsigned variable-length number.

Returns ​

bigint

Inherited from ​

NetworkPacket.readUnsignedVarLong

readVarInt() ​

readVarInt(): number

Defined in: binaryutils/src/BinaryStream.ts:597

Reads a 32 bit (4 bytes) zigzag-encoded number.

Returns ​

number

Inherited from ​

NetworkPacket.readVarInt

readVarLong() ​

readVarLong(): bigint

Defined in: binaryutils/src/BinaryStream.ts:675

Reads a 64 bit zigzag-encoded variable-length number.

Returns ​

bigint

Inherited from ​

NetworkPacket.readVarLong

readVarString() ​

readVarString(): string

Defined in: binaryutils/src/BinaryStream.ts:126

Reads a string: a varuint32 byte length, then UTF-8 bytes, the form Bedrock writes strings in. Named apart from readString because RakNet's packets read theirs with a u16 length. The docs' string primitive

Returns ​

string

The read string.

Inherited from ​

NetworkPacket.readVarString

reserve() ​

reserve(capacity): this

Defined in: binaryutils/src/BinaryStream.ts:805

Grows the write buffer so that at least capacity bytes can be written without any further allocation, and returns this stream.

Pre-sizing skips the 256 -> 512 -> 1024 ... growth ladder, each step of which copies the whole payload; a 3 KB packet starting from the 256-byte floor performs five allocations and memcpy's 1.25x its own size before it is done.

Parameters ​

capacity ​

number

Returns ​

this

Inherited from ​

NetworkPacket.reserve

resetWrite() ​

resetWrite(): void

Defined in: binaryutils/src/BinaryStream.ts:827

Rewinds the write cursor while keeping the allocated capacity, so a long-lived encoder reaches a steady state where it never allocates again. This is the intended way to reuse a stream for many packets.

Note the aliasing contract, which it shares with clear and reuse: any buffer previously handed out by getWriteBuffer is a view over this stream's memory and is invalidated by this call. Use copyOut or copyInto for output you intend to keep.

Returns ​

void

Inherited from ​

NetworkPacket.resetWrite

reuse() ​

reuse(buf): void

Defined in: binaryutils/src/BinaryStream.ts:991

Conventional method to reuse the stream without having to create a new BinaryStream instance.

The write buffer and its capacity are kept, so any view previously returned by getWriteBuffer is invalidated. See resetWrite.

Parameters ​

buf ​

Buffer

The new buffer instance.

Returns ​

void

Inherited from ​

NetworkPacket.reuse

serialize() ​

serialize(stream, context?): Buffer

Defined in: protocol/src/NetworkPacket.ts:165

Serializes the network packet into a binary stream.

Parameters ​

stream ​

NetworkBinaryStream

The binary stream to serialize into.

context? ​

ProtocolContext

Optional protocol data supplied for the connection.

Returns ​

Buffer

The serialized network packet as a Buffer.

Inherited from ​

NetworkPacket.serialize

setBuffer() ​

setBuffer(buf): void

Defined in: binaryutils/src/BinaryStream.ts:946

Sets the buffer for reading. make sure to reset the reading index!

Parameters ​

buf ​

Buffer

The new Buffer.

Returns ​

void

Deprecated ​

See setReadBuffer and setWriteBuffer.

Inherited from ​

NetworkPacket.setBuffer

setNetId() ​

setNetId(id): void

Defined in: protocol/src/NetworkPacket.ts:88

Stamps the id selected by a negotiated protocol version.

Parameters ​

id ​

number

The packet id in that version's table.

Returns ​

void

Inherited from ​

NetworkPacket.setNetId

setReadBuffer() ​

setReadBuffer(buf, rIndex?): void

Defined in: binaryutils/src/BinaryStream.ts:955

Sets the buffer for reading.

Parameters ​

buf ​

Buffer

The new Buffer.

rIndex? ​

number = 0

The new read index (default: 0, pass -1 to keep current).

Returns ​

void

Inherited from ​

NetworkPacket.setReadBuffer

setReadIndex() ​

setReadIndex(index): void

Defined in: binaryutils/src/BinaryStream.ts:1001

Sets the reading index.

Parameters ​

index ​

number

The new read index.

Returns ​

void

Inherited from ​

NetworkPacket.setReadIndex

setWriteBuffer() ​

setWriteBuffer(buf, wIndex?): void

Defined in: binaryutils/src/BinaryStream.ts:965

Sets the buffer for writing.

Parameters ​

buf ​

Buffer

The new Buffer.

wIndex? ​

number = 0

The new write index (default: 0, pass -1 to keep current).

Returns ​

void

Inherited from ​

NetworkPacket.setWriteBuffer

setWriteIndex() ​

setWriteIndex(index): void

Defined in: binaryutils/src/BinaryStream.ts:1010

Sets the new writing index.

Parameters ​

index ​

number

The new write index.

Returns ​

void

Inherited from ​

NetworkPacket.setWriteIndex

skip() ​

skip(len): void

Defined in: binaryutils/src/BinaryStream.ts:899

Skips len bytes on the buffer.

Parameters ​

len ​

number

Returns ​

void

Inherited from ​

NetworkPacket.skip

write() ​

write(buf): void

Defined in: binaryutils/src/BinaryStream.ts:76

Appends a buffer to the main buffer.

Parameters ​

buf ​

Uint8Array

Returns ​

void

Inherited from ​

NetworkPacket.write

writeBoolean() ​

writeBoolean(v): void

Defined in: binaryutils/src/BinaryStream.ts:188

Writes a boolean (true or false).

Parameters ​

v ​

boolean

Returns ​

void

Inherited from ​

NetworkPacket.writeBoolean

writeByte() ​

writeByte(v): void

Defined in: binaryutils/src/BinaryStream.ts:152

Writes an unsigned byte (0 to 255).

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

NetworkPacket.writeByte

writeDouble() ​

writeDouble(v): void

Defined in: binaryutils/src/BinaryStream.ts:490

Writes a 64 bit (8 bytes) big-endian floating point number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

NetworkPacket.writeDouble

writeDoubleLE() ​

writeDoubleLE(v): void

Defined in: binaryutils/src/BinaryStream.ts:510

Writes a 64 bit (8 bytes) little-endian floating point number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

NetworkPacket.writeDoubleLE

writeFloat() ​

writeFloat(v): void

Defined in: binaryutils/src/BinaryStream.ts:450

Writes a 32 bit (4 bytes) big-endian floating point number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

NetworkPacket.writeFloat

writeFloatLE() ​

writeFloatLE(v): void

Defined in: binaryutils/src/BinaryStream.ts:470

Writes a 32 bit (4 bytes) little-endian floating point number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

NetworkPacket.writeFloatLE

writeInt() ​

writeInt(v): void

Defined in: binaryutils/src/BinaryStream.ts:370

Writes a 32 bit (4 bytes) big-endian signed number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

NetworkPacket.writeInt

writeIntLE() ​

writeIntLE(v): void

Defined in: binaryutils/src/BinaryStream.ts:390

Writes a 32 bit (4 bytes) little-endian signed number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

NetworkPacket.writeIntLE

writeLengthPrefixed() ​

writeLengthPrefixed(buf): void

Defined in: binaryutils/src/BinaryStream.ts:115

Writes a varuint32 byte length, then the bytes.

Parameters ​

buf ​

Uint8Array

The bytes to append.

Returns ​

void

Inherited from ​

NetworkPacket.writeLengthPrefixed

writeLong() ​

writeLong(v): void

Defined in: binaryutils/src/BinaryStream.ts:530

Writes a 64 bit (8 bytes) signed big-endian number.

Parameters ​

v ​

bigint

Returns ​

void

Inherited from ​

NetworkPacket.writeLong

writeLongLE() ​

writeLongLE(v): void

Defined in: binaryutils/src/BinaryStream.ts:549

Writes a 64 bit (8 bytes) signed little-endian number.

Parameters ​

v ​

bigint

Returns ​

void

Inherited from ​

NetworkPacket.writeLongLE

writeShort() ​

writeShort(v): void

Defined in: binaryutils/src/BinaryStream.ts:206

Writes a 16 bit (2 bytes) signed big-endian number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

NetworkPacket.writeShort

writeShortLE() ​

writeShortLE(v): void

Defined in: binaryutils/src/BinaryStream.ts:226

Writes a 16 bit (2 bytes) signed little-endian number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

NetworkPacket.writeShortLE

writeSignedByte() ​

writeSignedByte(v): void

Defined in: binaryutils/src/BinaryStream.ts:170

Writes a signed byte (-128 to 127).

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

NetworkPacket.writeSignedByte

writeTriad() ​

writeTriad(v): void

Defined in: binaryutils/src/BinaryStream.ts:286

Writes a 24 bit (3 bytes) signed big-endian number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

NetworkPacket.writeTriad

writeTriadLE() ​

writeTriadLE(v): void

Defined in: binaryutils/src/BinaryStream.ts:307

Writes a 24 bit (3 bytes) signed little-endian number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

NetworkPacket.writeTriadLE

writeUnsignedInt() ​

writeUnsignedInt(v): void

Defined in: binaryutils/src/BinaryStream.ts:410

Writes a 32 bit (4 bytes) big-endian unsigned number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

NetworkPacket.writeUnsignedInt

writeUnsignedIntLE() ​

writeUnsignedIntLE(v): void

Defined in: binaryutils/src/BinaryStream.ts:430

Writes a 32 bit (4 bytes) little-endian unsigned number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

NetworkPacket.writeUnsignedIntLE

writeUnsignedLong() ​

writeUnsignedLong(v): void

Defined in: binaryutils/src/BinaryStream.ts:568

Writes a 64 bit (8 bytes) unsigned big-endian number.

Parameters ​

v ​

bigint

Returns ​

void

Inherited from ​

NetworkPacket.writeUnsignedLong

writeUnsignedLongLE() ​

writeUnsignedLongLE(v): void

Defined in: binaryutils/src/BinaryStream.ts:587

Writes a 64 bit (8 bytes) unsigned little-endian number.

Parameters ​

v ​

bigint

Returns ​

void

Inherited from ​

NetworkPacket.writeUnsignedLongLE

writeUnsignedShort() ​

writeUnsignedShort(v): void

Defined in: binaryutils/src/BinaryStream.ts:246

Writes a 16 bit (2 bytes) unsigned big-endian number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

NetworkPacket.writeUnsignedShort

writeUnsignedShortLE() ​

writeUnsignedShortLE(v): void

Defined in: binaryutils/src/BinaryStream.ts:266

Writes a 16 bit (2 bytes) unsigned little-endian number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

NetworkPacket.writeUnsignedShortLE

writeUnsignedTriad() ​

writeUnsignedTriad(v): void

Defined in: binaryutils/src/BinaryStream.ts:328

Writes a 24 bit (3 bytes) unsigned big-endian number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

NetworkPacket.writeUnsignedTriad

writeUnsignedTriadLE() ​

writeUnsignedTriadLE(v): void

Defined in: binaryutils/src/BinaryStream.ts:349

Writes a 24 bit (3 bytes) unsigned little-endian number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

NetworkPacket.writeUnsignedTriadLE

writeUnsignedVarInt() ​

writeUnsignedVarInt(v): void

Defined in: binaryutils/src/BinaryStream.ts:657

Writes a 32 bit unsigned number with variable-length.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

NetworkPacket.writeUnsignedVarInt

writeUnsignedVarLong() ​

writeUnsignedVarLong(v): void

Defined in: binaryutils/src/BinaryStream.ts:742

Writes a 64 bit unsigned variable-length number.

Parameters ​

v ​

bigint

Returns ​

void

Inherited from ​

NetworkPacket.writeUnsignedVarLong

writeUTF8String() ​

writeUTF8String(value): void

Defined in: binaryutils/src/BinaryStream.ts:91

Writes a UTF-8 string directly into the stream's backing buffer.

Parameters ​

value ​

string

The string to encode.

Returns ​

void

Inherited from ​

NetworkPacket.writeUTF8String

writeVarInt() ​

writeVarInt(v): void

Defined in: binaryutils/src/BinaryStream.ts:609

Writes a 32 bit (4 bytes) zigzag-encoded number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

NetworkPacket.writeVarInt

writeVarLong() ​

writeVarLong(v): void

Defined in: binaryutils/src/BinaryStream.ts:688

Writes a 64 bit unsigned zigzag-encoded number.

Parameters ​

v ​

bigint

Returns ​

void

Inherited from ​

NetworkPacket.writeVarLong

writeVarString() ​

writeVarString(str): void

Defined in: binaryutils/src/BinaryStream.ts:134

Writes a string as a varuint32 byte length, then UTF-8 bytes.

Parameters ​

str ​

string

The string to write.

Returns ​

void

Inherited from ​

NetworkPacket.writeVarString