osrs-228-model/net.rsprot.protocol.game.outgoing.zone.payload/LocAddChangeV2

LocAddChangeV2

Loc add-change v2 packet is used to either add or change a loc in the world. The client will add a new loc if none exists by this description, or overwrites an old one with the same layer (layer is obtained through the shape property of the loc).

Constructors

LocAddChangeV2

constructor(id: Int, xInZone: Int, zInZone: Int, shape: Int, rotation: Int, opFlags: Byte, ops: Map<Byte, String>?)

constructor(id: Int, xInZone: Int, zInZone: Int, shape: Int, rotation: Int, opFlags: Byte)

Properties

category

open override val category: ServerProtCategory

coordInZonePacked

val coordInZonePacked: Int

val id: Int

the id of the loc to add

locPropertiesPacked

val locPropertiesPacked: Int

opFlags

val opFlags: Byte

the right-click options enabled on this loc. Use the net.rsprot.protocol.game.outgoing.util.OpFlags helper object to create these bitpacked values which can be passed into it.

ops

val ops: Map<Byte, String>?

a map of mini menu ops to override the defaults with. If the map is null or empty, the ops will not be overridden and the ones provided in the respective cache config will be used. If the map has entries, all the cache ops are ignored and the provided map is used. Note that only ops 1-5 will actually be used, any other values get ignored by the client. As such, if a map is provided that has no keys of value 1-5, all the ops will simply be hidden.

protId

open override val protId: Int

rotation

val rotation: Int

the rotation of the loc, a value of 0 to 3 (inclusive) is expected.

shape

val shape: Int

the shape of the loc, a value of 0 to 22 (inclusive) is expected.

xInZone

val xInZone: Int

the x coordinate of the loc within the zone it is in, a value in range of 0 to 7 (inclusive) is expected. Any bits outside that are ignored.

zInZone