Models

Everything a script reads through bot.* is an instance of the classes described here. They are read-only: to change the world use commands.

Which bot property returns which class is listed in the “World reads” table. This page describes what those classes contain.

Contents

oid and id

• oid (object id) — a specific instance: this mob, this item in your bag, this drop. Issued by the server, alive as long as the object is, carried in event fields.
• id (template id) — a type: a mob id, an item's itemId, a skillId. The same for every orc on the map.

Npc, Pet, Drop, Skill and PartyPet have both: mob.id is "orcs in general", mob.oid is "this particular orc". Commands accept either, see “id or oid”.

Positioned

The interface of everything that has a position: living entities, drops, party members.

Identified

The interface of everything that has a template id: Npc, Pet, Drop, Skill, PartyPet.

LiveEntity

The common base of living entities: Player, Npc, Char, Pet. Implements Positioned.

Player

Your own character — bot.user. Everything from LiveEntity plus:

Npc

A mob or NPC from bot.npcs. Everything from LiveEntity and Identified plus:

Char

Another player from bot.chars. Everything from LiveEntity plus:

Pet

Your own pet or summon from bot.pets. Everything from LiveEntity and Identified plus:

Drop

An item on the ground from bot.drops. Implements Positioned and Identified. It is not a living entity — it has no HP.

Skill

A skill from bot.skills or user.skills. Implements Identified.

InventoryItem

An item from bot.inventory, user.petItems or user.questItems.

StoreItem

One lot from bot.storeItems — the goods of the private store you last opened.

A snapshot taken when the store opened, not live prices: the server never says that someone else bought a lot out, so a list you keep around goes quietly stale.

Buff

An active buff or effect: entity.buffs, partyMember.effects, partyPet.effects.

PetAction

An available pet action from pet.actions.

PartyMember

A party member from bot.party. Implements Positioned. It is not a LiveEntity — the server sends less data about party members.

To get a party member as a full entity (with buffs, target and combat state), look them up in bot.chars by oid:

val member = bot.party.firstOrNull { it.name == "Healer" }
val asChar = member?.let { m -> bot.chars.byOid(m.oid) }

PartyPet

A party member's pet from partyMember.pets. Implements Identified.

Packet

A raw game packet from bot.packetsIn / bot.packetsOut — see Raw traffic. Not a world entity: it has no oid and no position, it is just bytes off the wire.

The two directions only look alike. The same opcode byte means different things each way, and even the extended-packet marker differs — FE inbound, D0 outbound. That is why subOpcode consults incoming, and why comparing opcode against a list of opcodes only means something once you know the direction.

It follows that only an outgoing packet can be replayed through sendPacket — its body is exactly what that command takes. Sending back at the server what the server sent you is meaningless, and usually drops the connection.

List helpers

Extension functions for the lists bot.* returns.

val mob   = bot.npcs.nearest { it.attackable && !it.dead && it.distToSelf <= 1200 }
val boss  = bot.npcs.byId(29020)
val ally  = bot.chars.byName("Healer")
val myPet = bot.pets.firstOrNull()

Enums

LootMode

Loot distribution mode for inviteParty.

RestartType

Respawn point for goHome.

Both enums expose a code: Int field holding the protocol value.

Numeric codes

Some fields are given as plain numbers, exactly as the server sends them.

Race — Char.race, PartyMember.race

Store type — Char.storeType

Chat channel codes are on the Commands page.