JSPrismarine
    Preparing search index...

    The base class for all packets.

    Hierarchy (View Summary)

    Index

    Constructors

    Methods

    • Clears the whole BinaryStream instance.

      Returns void

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

      Returns boolean

    • Returns the encoded buffer.

      Returns Buffer

    • Retuns the read index.

      Returns number

    • Returns the write index.

      Returns number

    • Reads a slice of buffer by the given length.

      Parameters

      • len: number

      Returns Buffer

    • Reads a boolean (true or false).

      Returns boolean

    • Reads an unsigned byte (0 to 255).

      Returns number

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

      Returns number

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

      Returns number

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

      Returns number

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

      Returns number

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

      Returns number

    • Reads a 32 bit (4 bytes) signed number.

      Returns number

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

      Returns bigint

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

      Returns bigint

    • Reads the remaining bytes and returns the buffer slice.

      Returns Buffer

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

      Returns number

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

      Returns number

    • Reads a signed byte (-128 to 127).

      Returns number

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

      Returns number

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

      Returns number

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

      Returns number

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

      Returns number

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

      Returns bigint

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

      Returns bigint

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

      Returns number

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

      Returns number

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

      Returns number

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

      Returns number

    • Reads a 32 bit unsigned number.

      Returns number

    • Reads a 64 bit unsigned variable-length number.

      Returns bigint

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

      Returns number

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

      Returns bigint

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

      Parameters

      • buf: Buffer

        The new buffer instance.

      Returns void

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

      Parameters

      • buf: Buffer

        The new Buffer.

      Returns void

    • Sets the reading index.

      Parameters

      • index: number

        The new read index.

      Returns void

    • Sets the new writing index.

      Parameters

      • index: number

        The new write index.

      Returns void

    • Skips len bytes on the buffer.

      Parameters

      • len: number

      Returns void

    • Appends a buffer to the main buffer.

      Parameters

      • buf: Uint8Array

      Returns void

    • Writes a boolean (true or false).

      Parameters

      • v: boolean

      Returns void

    • Writes an unsigned byte (0 to 255).

      Parameters

      • v: number

      Returns void

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

      Parameters

      • v: number

      Returns void

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

      Parameters

      • v: number

      Returns void

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

      Parameters

      • v: number

      Returns void

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

      Parameters

      • v: number

      Returns void

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

      Parameters

      • v: number

      Returns void

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

      Parameters

      • v: number

      Returns void

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

      Parameters

      • v: bigint

      Returns void

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

      Parameters

      • v: bigint

      Returns void

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

      Parameters

      • v: number

      Returns void

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

      Parameters

      • v: number

      Returns void

    • Writes a signed byte (-128 to 127).

      Parameters

      • v: number

      Returns void

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

      Parameters

      • v: number

      Returns void

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

      Parameters

      • v: number

      Returns void

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

      Parameters

      • v: number

      Returns void

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

      Parameters

      • v: number

      Returns void

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

      Parameters

      • v: bigint

      Returns void

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

      Parameters

      • v: bigint

      Returns void

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

      Parameters

      • v: number

      Returns void

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

      Parameters

      • v: number

      Returns void

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

      Parameters

      • v: number

      Returns void

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

      Parameters

      • v: number

      Returns void

    • Writes a 32 bit unsigned number with variable-length.

      Parameters

      • v: number

      Returns void

    • Writes a 64 bit unsigned variable-length number.

      Parameters

      • v: bigint

      Returns void

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

      Parameters

      • v: number

      Returns void

    • Writes a 64 bit unsigned zigzag-encoded number.

      Parameters

      • v: bigint

      Returns void