protocol/net.rsprot.protocol.message/ZoneProt

ZoneProt

interface ZoneProt : OutgoingGameMessage

ZoneProt is a special type of outgoing message, used for any zone payload packet, such as area sound or map proj anim.

Properties

abstract val category: ServerProtCategory

abstract val protId: Int

Prot id is a constant value assigned to each unique prot, with the intent of being able to switch on these constants and make use of a tableswitch operation, allowing fast O(1) lookups for various zone prots. The respective, unique constants are defined in revision-specific zone prot file. Each id is expected to be unique and incrementing. Gaps should not exist as they cause the JVM to use a lookupswitch instead.

Functions

estimateHuffmanEncodedTextSize

fun OutgoingMessage.estimateHuffmanEncodedTextSize(text: String): Int

open fun estimateSize(): Int

A function to estimate the size of a message. The estimate should only consist of the payload, not the header.

estimateTextSize

fun OutgoingMessage.estimateTextSize(text: String): Int