openrs2/org.openrs2.cache/JagArchive

JagArchive

class JagArchive : Closeable

An interface for reading and writing .jag archives, which are used by RuneScape Classic and early versions of RuneScape 2.

Unlike the client, this implementation is case-sensitive. Entry names should therefore be supplied in uppercase for compatibility.

This class is not thread safe.

Constructors

constructor()

Types

object Companion

Properties

The number of entries in the archive.

Functions

open override fun close()

open operator override fun equals(other: Any?): Boolean

fun exists(name: String): Boolean

Checks whether an entry exists.

fun existsNamed(nameHash: Int): Boolean

Checks whether an entry exists.

open override fun hashCode(): Int

fun list(): Iterator<Int>

Lists all entries in the archive.

fun pack(compressedArchive: Boolean, alloc: ByteBufAllocator = ByteBufAllocator.DEFAULT): ByteBuf

Packs a .jag archive into a compressed ByteBuf using the given compression method.

fun packBest(alloc: ByteBufAllocator = ByteBufAllocator.DEFAULT): ByteBuf

Packs a .jag archive into a compressed ByteBuf. The best compression method for minimising the size of the compressed archive is automatically selected. Note that this does not necessarily correspond to the minimimal amount of RAM usage at runtime.

fun read(name: String): ByteBuf

Reads an entry.

fun readNamed(nameHash: Int): ByteBuf

Reads an entry.

fun remove(name: String)

Deletes an entry. Does nothing if the entry does not exist.

fun removeNamed(nameHash: Int)

Deletes an entry. Does nothing if the entry does not exist.

fun write(name: String, buf: ByteBuf)

Writes an entry. If an entry with the same name hash already exists, it is overwritten.

fun writeNamed(nameHash: Int, buf: ByteBuf)

Writes an entry. If an entry with the same name hash already exists, it is overwritten.