Модели

Всё, что скрипт читает через bot.*, — это объекты описанных здесь классов. Они доступны только на чтение: изменить мир можно командами.

Какое свойство bot какой класс возвращает — в таблице «Чтение мира». Здесь описано, что у этих классов внутри.

Оглавление

oid и id

• oid (object id) — конкретный экземпляр: вот этот моб, вот эта вещь в сумке, вот этот дроп. Выдаётся сервером, живёт пока объект существует, приходит в полях событий.
• id (template-id) — тип: id моба, itemId вещи, skillId умения. Один и тот же у всех орков на карте.

У Npc, Pet, Drop, Skill, PartyPet есть оба: mob.id — «орк вообще», mob.oid — «вот этот орк». Команды принимают и то и другое, см. «id или oid».

Positioned

Интерфейс всего, у чего есть позиция: живые сущности, дроп, участники группы.

Identified

Интерфейс всего, у чего есть template-id: Npc, Pet, Drop, Skill, PartyPet.

LiveEntity

Общая база живых сущностей: Player, Npc, Char, Pet. Реализует Positioned.

Player

Свой персонаж — bot.user. Всё из LiveEntity плюс:

Npc

Моб или NPC из bot.npcs. Всё из LiveEntity и Identified плюс:

Char

Другой игрок из bot.chars. Всё из LiveEntity плюс:

Pet

Свой пет или саммон из bot.pets. Всё из LiveEntity и Identified плюс:

Drop

Вещь на земле из bot.drops. Реализует Positioned и Identified. Живой сущностью не является — HP у неё нет.

Skill

Умение из bot.skills или user.skills. Реализует Identified.

InventoryItem

Вещь из bot.inventory, user.petItems, user.questItems.

StoreItem

Одна позиция из bot.storeItems — товары последней открытой частной лавки.

Это снимок на момент открытия, а не живые цены: когда кто-то выкупит позицию, сервер об этом молчит, и сохранённый список тихо устаревает.

Buff

Активный бафф или эффект: entity.buffs, partyMember.effects, partyPet.effects.

PetAction

Доступное действие пета из pet.actions.

PartyMember

Участник группы из bot.party. Реализует Positioned. Это не LiveEntity — сервер присылает по участникам меньше данных.

Чтобы получить участника группы как полноценную сущность (с баффами, целью, боевым состоянием), найди его среди bot.chars по oid:

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

PartyPet

Пет участника группы из partyMember.pets. Реализует Identified.

Packet

Сырой игровой пакет из bot.packetsIn / bot.packetsOut — см. «Сырой трафик». Не сущность мира: у него нет ни oid, ни позиции, это просто байты с провода.

Направления похожи только формой. Один и тот же байт опкода значит в каждую сторону своё, и признак extended-пакета у них разный — FE у входящих, D0 у исходящих. Поэтому subOpcode и смотрит на incoming, а сравнивать opcode со списком опкодов имеет смысл только зная направление.

Из того же следует: повторить через sendPacket можно только исходящий пакет — его тело и есть то, что принимает эта команда. Отправлять на сервер то, что от сервера пришло, бессмысленно, а обычно ещё и рвёт соединение.

Хелперы списков

Функции-расширения для списков, которые отдаёт bot.*.

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()

Перечисления

LootMode

Режим дележа лута для inviteParty.

RestartType

Точка возрождения для goHome.

У обоих перечислений есть поле code: Int с числовым значением из протокола.

Числовые коды

Некоторые поля отдаются числом, как их присылает сервер.

Раса — Char.race, PartyMember.race

Тип лавки — Char.storeType

Коды каналов чата — на странице Команды.