osrs-221-model/net.rsprot.protocol.game.outgoing.map/RebuildRegion

RebuildRegion

class RebuildRegion : OutgoingGameMessage

Rebuild region is used to send a dynamic map to the client, built up out of zones (8x8x1 tiles), allowing for any kind of unique instancing to occur.

Constructors

Link copied to clipboard
constructor(zoneX: Int, zoneZ: Int, reload: Boolean, zoneProvider: RebuildRegion.RebuildRegionZoneProvider)

Types

Link copied to clipboard
class RebuildRegionZone

This class wraps a reference zone to be copied together with the respective xtea key needed to decrypt the backing mapsquare.

Link copied to clipboard
fun interface RebuildRegionZoneProvider

Zone provider acts as a function to provide all the necessary information needed for rebuild region to function, in the order the client expects it in.

Link copied to clipboard
@JvmInline
value class ReferenceZone

A value class around zone objects that bitpacks all the properties into a single integer to be written to the client as the client expects it.

Properties

Link copied to clipboard
open override val category: ServerProtCategory
Link copied to clipboard
val reload: Boolean

whether to forcibly reload the map client-sided. If this property is false, the client will only reload if the last rebuild had difference zoneX or zoneZ coordinates than this one.

Link copied to clipboard
val zones: List<RebuildRegion.RebuildRegionZone?>

the list of zones to build, in a specific order.

Link copied to clipboard
val zoneX: Int

the x coordinate of the center zone around which the build area is built

Link copied to clipboard
val zoneZ: Int

the z coordinate of the center zone around which the build area is built

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String