Class EoReader

A class for reading EO data from a sequence of bytes.

`EoReader` features a chunked reading mode, which is important for accurate emulation of the official game client.

See

Chunked Reading

Hierarchy

  • EoReader

Constructors

constructor

Accessors

chunkedReadingMode position remaining

Methods

findNextBreakIndex getByte getBytes getChar getEncodedString getFixedEncodedString getFixedString getInt getShort getString getThree nextChunk readByte readBytes slice decodeAnsi removePadding

Constructors

constructor

  • Creates a new EoReader instance for the specified data.

    Parameters

    • data: Uint8Array

      the byte array containing the input data

    Returns EoReader

Properties

Private _chunkedReadingMode

_chunkedReadingMode: boolean = false

Private _position

_position: number = 0

Private chunkStart

chunkStart: number = 0

Private Readonly data

data: Uint8Array

Private nextBreak

nextBreak: number = -1

Accessors

chunkedReadingMode

  • get chunkedReadingMode(): boolean

  • Gets the chunked reading mode for the reader.

    Returns

    True if the reader is in chunked reading mode

    Returns boolean

  • set chunkedReadingMode(chunkedReadingMode: boolean): void

  • Sets the chunked reading mode for the reader.

    In chunked reading mode:

    • the reader will treat `0xFF` bytes as the end of the current chunk.
    • nextChunk can be called to move to the next chunk.

    Parameters

    • chunkedReadingMode: boolean

      the new chunked reading mode

    Returns void

position

  • get position(): number

  • Gets the current position in the input data.

    Returns

    The current position in the input data

    Returns number

remaining

  • get remaining(): number

  • If chunked reading mode is enabled, gets the number of bytes remaining in the current chunk. Otherwise, gets the total number of bytes remaining in the input data.

    Returns

    The number of bytes remaining

    Returns number

Methods

Private findNextBreakIndex

getByte

  • Reads a raw byte from the input data.

    Returns

    A raw byte

    Returns number

getBytes

  • Reads an array of raw bytes from the input data.

    Returns

    An array of raw bytes

    Parameters

    • length: number

    Returns Uint8Array

getChar

  • Reads an encoded 1-byte integer from the input data.

    Returns

    A decoded 1-byte integer

    Returns number

getEncodedString

  • Reads an encoded string from the input data.

    Returns

    A decoded string

    Returns string

getFixedEncodedString

  • Reads an encoded string with a fixed length from the input data.

    Returns

    A decoded string

    Throws

    Error if the length is negative

    Parameters

    • length: number

      the length of the string

    • padded: boolean = false

      true if the string is padded with trailing 0xFF bytes

    Returns string

getFixedString

  • Reads a string with a fixed length from the input data.

    Returns

    A decoded string

    Throws

    Error if the length is negative

    Parameters

    • length: number

      the length of the string

    • padded: boolean = false

      true if the string is padded with trailing 0xFF bytes

    Returns string

getInt

  • Reads an encoded 4-byte integer from the input data.

    Returns

    A decoded 4-byte integer

    Returns number

getShort

  • Reads an encoded 2-byte integer from the input data.

    Returns

    A decoded 2-byte integer

    Returns number

getString

getThree

  • Reads an encoded 3-byte integer from the input data.

    Returns

    A decoded 3-byte integer

    Returns number

nextChunk

  • Moves the reader position to the start of the next chunk in the input data.

    Throws

    Error if not in chunked reading mode

    Returns void

Private readByte

Private readBytes

slice

  • Creates a new EoReader whose input data is a shared subsequence of this reader's data.

    The input data of the new reader will start at position `index` in this reader and contain up to `length` bytes. The two reader's position and chunked reading mode will be independent.

    The new reader's position will be zero, and its chunked reading mode will be false.

    Throws

    Error if index or length is negative.
    This exception will not be thrown if index + length is greater than the size of the input data. Consistent with the existing over-read behaviors, the new reader will be supplied a shared subsequence of all remaining data starting from index.

    Returns

    The new reader

    Parameters

    • Optional index: number = ...

      the position in this reader at which the data of the new reader will start; must be non-negative. Defaults to the current reader position.

    • Optional length: number = ...

      the length of the shared subsequence of data to supply to the new reader; must be non-negative. Defaults to the length of the remaining data starting from index.

    Returns EoReader

Static Private decodeAnsi

Static Private removePadding

  • Parameters

    • bytes: Uint8Array

    Returns Uint8Array

Settings

Member Visibility

Theme

Generated using TypeDoc