Руководство по написанию скриптов

Быстрый старт

Скрипт — это обычный текстовый файл в формате .lua

Как запустить

  1. Открой вкладку Настройки в боте и выбери режим бота "Скрипт").
  2. Выбери режим бота «Скрипт» и нажми выбери файл скрипта на диске.
  3. Скрипт будет автоматически скопирован в папку /settings/scripts

Первый квест


quest{
    id = 417, name = "Path to Scavenger", done = 1642,
    steps = {
        { talk = {"Pippi", "#quest", "#1"} },                -- начало: взять квест
        { have = 1646, talk = {"Master Toma", "#quest"} },   -- есть письмо -> к Toma
        { have = 1653, farm = {zone = "bears", get = {1655, 5}} },  -- набить 5 Honey Jar
        { have = 1645, talk = {"Raut", "#quest"} },          -- финал
    },
}

Здесь нет ни одной координаты. NPC указаны по имени, дорогу, телепорты по городам и бой с напавшими мобами бот берёт на себя (бот знает координаты только стандартных NPC HighFive); окно квеста открывает "#quest". В режиме

Что читать дальше

  • Пишешь квест — quest{} и разбор готового квеста.
  • Нужно несколько квестов подряд или «покачаться до 20 уровня» — plan{}.
  • Нужна конкретная функция — поиск сверху (клавиша /).

NPC, предметы, координаты

Как указывать NPC

Везде, где нужен NPC (go, talk, teleport(гк, ...)), его можно указать тремя способами:

СпособПримерКогда
по ID30524серверный id NPC — всегда однозначно
по имени"Pippi", "Adventurers' Guide"как написано над NPC в игре
титул + имя"Master Toma"если одноимённых NPC несколько (есть ещё Guard Toma)

Как бот находит NPC:

  1. Если NPC виден рядом — берётся его живая позиция.
  2. Иначе бот берёт все ID с этим именем и ищет среди точек из встроенной базы мира (2246 NPC с сервера) ближайшую к персонажу.

NPC, которого нет в базе (ходящий по маршруту, ивентовый, кастомный NPC сервера), задаётся координатами: talk{"Custom", at = {x, y, z}}.

Предметы

Предметы указываются ID (template id), например 1646. has() и count() считают и обычные, и квестовые предметы.


has(1646)        -- есть хоть один
has(1655, 5)     -- есть не меньше 5
count(57)        -- сколько адены

Координаты и зоны

Точка — таблица из трёх чисел {x, y, z}. Полигон состоит из набора таких точек координат, которые автоматически замыкаются (не меньше 3 точек):


local SPIDERS = {
    {146116, -217620, -3400}, {147992, -218480, -3400}, {153624, -217424, -3400},
    {153336, -215692, -3400}, {150272, -213116, -3400},
}
farm{points = SPIDERS, get = {1656, 20}}
farm{zone = "Пауки у Toma", get = {1656, 20}}   -- полигон из редактора
Координаты своего персонажа видно во вкладке игрока; для зоны удобнее нарисовать полигон в редакторе и сослаться на него по имени.

Простые функции

Высокоуровневые функции скриптов. Как правило много чего автоматизированно. (Например talk помимо разговора - ищет путь к персонажу, и может долететь через ГК). Это упрощенный способ писать скрипты; есть еще низкоуровневое api функции bot.* через которое можно контролировать каждый нюанс.

ФункцияЧто делает
has(item [, n])есть ли предмет (n штук)
count(item)сколько штук предмета
log(...)сообщение в лог
wait(ms)пауза
server()какой клиент: "lu4", "scryde", "boh"
go(куда [, arrive] [, опции])дойти до NPC или точки
talk(npc, ссылки...)поговорить с NPC и нажать ссылки
teleport("город") / teleport(гк, ссылки...)телепортироваться в город (бот автоматически должен добраться в указанный город)
run_to_gk()подойти к ближайшему ГК города
teleport_last()полететь через ГК туда куда бот телепортировался в предыдущий раз
farm{...}обычный фарм бота в зоне до условия
quest{...}квест по шагам
plan{...}несколько квестов и действий по порядку
me, target, petперсонаж, цель, питомец: me.hp_pct, target.dead
mobs{}, npcs{}, players{}, nearest{}поиск вокруг
cast, use, set_target, say, sit, key, wait_for...короткие действия

Предметы, лог, пауза

has(item, n?) → boolean

Есть ли предмет item в количестве не меньше n (по умолчанию 1). Учитывает обычные и квестовые предметы.


if has(1655, 5) then talk("Master Toma") end
count(item) → integer

Сколько штук предмета (обычные + квестовые). 0, если нет.

log(...)

Пишет аргументы через пробел в лог бота. Внутри квеста строка получает префикс квеста, например [Q417]; внутри плана без квеста — [план].


log("осталось", 20 - count(1656), "бусин")
server() → "lu4" | "scryde" | "boh"

Клиент этого окна (из настроек бота). Нужен, когда один скрипт должен вести себя по-разному на разных серверах.


on_death = function()
    run_to_gk()
    if server() == "lu4" then
        talk("Adventurers' Guide", "#2", "#1")    -- баф есть только на Lu4
    end
    teleport_last()
end,
wait(ms?)

Пауза на ms миллисекунд (по умолчанию 1000). Остановка бота прерывает паузу.

Передвижение

go(target, arrive?, opts?) → boolean ждёт

Дойти до NPC или точки. target — NPC (ID / имя), {x, y, z} или путь {{x,y,z}, {x,y,z}, ...} (кнопка «Скопировать в буфер» в редакторе путей) — тогда бот идёт по точкам по порядку. arrive — на каком расстоянии считать, что дошли (по умолчанию 150). Возвращает true, если дошёл.

Если цель далеко, а рядом с ней город, бот сам летит в этот город через ГК с пересадками и дальше идёт пешком. В зоны охоты сам не летает — для этого teleport(гк, строка) или via.

opts — как вести себя с мобами по дороге: {enemies = "ignore"}, {avoid = {20176}} (см. мобы по дороге).


go("Raut")
go({146116, -217620, -3400}, 300)
go({x, y, z}, {enemies = "ignore"})       -- бежать, не останавливаясь драться
go(ROUTE)                                 -- по пути, скопированному из редактора

Разговор с NPC

talk(npc, link1, link2, ...) → string | nil ждёт

Подойти к NPC, открыть диалог и нажать ссылки по порядку. Возвращает текст последней страницы или nil, если поговорить не удалось.

  • Ссылка — "#N" (N-я по порядку на странице), "#first" / "#last" (первая / последняя), "#quest" (окно квеста, см. ниже) или её текст: "Say you will help with the work".
  • Ссылки нажимаются по порядку, каждая — на странице, которую открыла предыдущая. Сам бот ничего не добавляет: что нажать, решает скрипт.
  • Ссылки нажимаются, пока они есть. Если очередной ссылки нет (NPC сам выдал предмет и закрыл тему), это не ошибка.

"#quest" — окно квеста

Нажать у NPC ссылку квестов и, если NPC показал список из нескольких квестов, выбрать квест скрипта (по id из quest{}). Дальше "#1" — уже первая ссылка в окне квеста.


talk("Pippi", "#quest", "#1")           -- окно квеста, потом его 1-я ссылка
{ have = 1646, talk = {"Master Toma", "#quest"} }
  • Выбор квеста из списка по id работает на Lu4. На Scryde, если у NPC один квест, сервер сразу открывает его окно; выбор из списка нескольких квестов там пока не поддержан (надо выбирать вручную).
  • Если в тексте ссылки несколько подходящих слов на разных ссылках — нажимается первая сверху.

talk("Mion", "#1")                                  -- первая ссылка
talk(30519, "#1", "#2")                             -- по ID, две ссылки подряд
talk("Mion", "Say you will help with the work")     -- ссылка по тексту
local text = talk("Pippi")                          -- только открыть, вернуть текст
if text and text:find("come back later") then ... end

Форма с параметрами

Если передать таблицу, первым идёт NPC, за ним ссылки, дальше — параметры:


talk{"Master Toma", "#quest", via = {"Wirphy", "#teleport", "#10"}}   -- далеко: сначала этот телепорт
talk{"Custom Npc", "#1", at = {12345, -67890, -3000}}
talk{"Torai", "#quest", "#1", "#1", avoid = {20176, 20554}}        -- по дороге обходить Wyrm и Grandis
ПараметрЧто делает
via = {ГК, ссылки...}если NPC дальше 20 000 — сначала этот телепорт, как в teleport: {"Wirphy", "#teleport", "#10"}. Для NPC вне городов (горы, поля), куда бот сам не летает
at = {x, y, z}где стоит NPC, если его нет в базе мира. Если задать координаты, то бот сам его постарается найти
enemies, avoid, avoid_radiusмобы по дороге, см. ниже

Телепорты

teleport(town) / teleport(gk, link1, link2, ...) → boolean ждёт

teleport("город") — в город, от ближайшего ГК, с пересадками через другие города (например, Гномья деревня → Глудио → Гиран). Только города.

teleport(гк, ссылки...) — у ГК нажать ссылки по порядку, как нажал бы руками; последняя — сам телепорт. Нужно для зон охоты. Работает на любом сервере.

  • гк — ID или имя ГК ("Wirphy"). Если ГК далеко — бот сначала долетит до его города.
  • Ссылки: "#teleport" — открыть список телепортов, "#N" — N-я ссылка на странице, "#first" — первая, "#last" — последняя, или текст ссылки.

teleport("Wirphy", "#teleport", "#10")       -- «Телепортироваться», потом 10-я ссылка списка
talk{"Master Toma", via = {"Wirphy", "#teleport", "#10"}}
  • Надёжнее, чем "#first": первая ссылка у ГК не всегда «Телепортироваться» — У некоторых GK на первом месте стоит другая ссылка.

Форма с номером строки teleport("Wirphy", 10) — для списка ГК в формате Lu4 — тоже работает.


teleport("giran")               -- ключ или имя: "Гиран", "Giran", "Gludin"...
teleport("Wirphy", 10)          -- Lu4: 10-я строка списка (Western Mining Zone)
teleport(30540, 10)             -- то же по ID

Ключи городов: talking_island, gludin, gludio, dark_elf, elf, dwarf, orc, kamael, dion, giran, oren, hunters, aden, heine, goddard, rune, schuttgart. Можно и по-русски: «Гиран», «Глудин», «Гномья деревня».

run_to_gk() → boolean ждёт

Дойти до ГК города, где стоит персонаж, а вне города — до ГК ближайшего города.

teleport_last() → boolean ждёт

Полететь туда, куда бот летал в прошлый раз. Одно из применений: в on_death, чтобы вернуться на место после смерти.

  1. В квесте — телепорт via. При teleport_last() улетит в то же место, куда бот телепортировался с помощью via
  2. Вне квеста — teleport_last() улетит туда же куда был последний полёт teleport(гк, строка) в этом запуске скрипта (если сейчас в другом городе — сначала в город, откуда улетали).
  3. Иначе — последний полёт в город.

Фарм

farm{...} → boolean ждёт

Обычный фарм бота в зоне — до тех пор, пока не наберутся предметы или не выполнится условие. Если персонаж вне зоны — сначала идёт к её центру.


farm{
    zone = "bears",               -- полигон из редактора полигонов (по имени)
    -- zone = BEARS,              -- или полигон, вставленный в скрипт
    -- points = {{x,y,z}, ...},   -- или просто точки (не меньше 3)
    get = {1655, 5},              -- что набрать (или items = {[1655] = 5, [1656] = 20})
    targets = {27058, 20777},     -- кого бить, по порядку приоритета
    timeout_min = 180,            -- ограничение по времени
}

farm{zone = "Пауки", until_check = function()   -- фармить до 20 уровня
    return bot.player.get_level() >= 20
end}

Полигон прямо в скрипте. В редакторе полигонов кнопка «Скопировать в буфер» копирует полигон вместе со стоп-зонами и патрулём. Вставь его в скрипт и укажи zone = ИМЯ — бот фармит с этими стоп-зонами и патрулём, файл полигона не нужен. Полигон без стоп-зон и патруля копируется просто списком точек: BEARS = {{x,y,z}, {x,y,z}, ...} — zone = BEARS работает и так.


BEARS = {
    name = "Bears",
    points = {
        {135168, -199972, -3770}, {135848, -201664, -3770}, {138180, -203568, -3790},
    },
    stop_zones = {   -- сюда бот не заходит
        { {136000, -200500, -3770}, {136400, -200500, -3770}, {136200, -200900, -3770} },
    },
    patrol = {       -- маршрут бега внутри полигона
        {135500, -200500, -3770}, {137500, -202500, -3790},
    },
    patrol_loop = true,    -- true: по кругу, false: туда-обратно
    patrol_fight = true,   -- true: в бою стоять, false: бежать дальше
}

farm{zone = BEARS, get = {1655, 5}}
ПолеЗначение
zone / pointsгде фармить: имя полигона, таблица полигона из буфера или точки
get = {id, n} / items = {[id] = n, ...}сколько чего набрать (все условия)
until_check = functionфармить, пока функция не вернёт true. Можно вместо или вместе с get
targets = {id или "имя", ...}кого бить, по порядку приоритета. Это не строгий фильтр: напавших мобов бот бьёт всегда и в первую очередь
timeout_minне дольше стольких минут
via = {ГК, ссылки...}если зона дальше 20 000 — сначала этот телепорт

Что происходит на время фарма — в разделе Фарм до условия.

Персонаж, цель, поиск, действия

Высокоуровневое API в отличии от низкоуровнего bot.* для повседневной логики: проверить HP, найти мобов рядом, использовать скилл. Всё встроено и работает в любом скрипте.


if me.hp_pct < 30 then use(1539) end                     -- банка
if not me.buff(1204) then cast(1204, me.id) end          -- Wind Walk на себя
if target.dead and target.sweepable then cast(42) end   -- свип

for _, m in ipairs(mobs{radius = 800, aggro = true}) do
    log("на меня напал", m.name, "в", math.floor(m.dist))
end

local g = nearest{kind = "npc", name = "grocer"}
if g then go(g) end

Общие правила

  • Нет данных — nil. Нет цели — target.id равен nil, а не 0 или −1.
  • ID NPC — серверный (30524, 20176).
  • Имена — без учёта регистра, по части имени: "wolf" найдёт «Gray Wolf».
  • Поля живые: me.hp_pct каждый раз читает свежее значение — копировать в переменную не нужно.

me — персонаж

ПолеЗначение
me.hp, me.max_hp, me.hp_pctHP, макс. HP, HP в % (0–100). Так же mp, cp
me.level, me.exp, me.spуровень, опыт, SP
me.name, me.title, me.idимя, титул, object id
me.class, me.base_class, me.raceкласс, базовый класс, раса
me.x, me.y, me.z, me.pos()координаты (pos() — сразу три)
me.targetid текущей цели или nil
me.karma, me.pvp, me.weight_pct, me.speedкарма, PvP-флаг, вес в %, скорость бега
me.charges, me.soulsзаряды «момент силы», souls
me.dead, me.sitting, me.running, me.combatсостояния
me.stunned, me.rooted, me.frozen, me.sleeping, me.muted, me.invisible, me.invulnerableконтроль и статусы
me.deathsсколько раз умер за сессию
me.buff(id), me.buffs()есть ли бафф; список {skill_id, level, enchant, remaining}
me.data()все данные таблицей (как bot.player.get_data())

target — текущая цель

ПолеЗначение
target.existsесть ли цель
target.id, target.npc_id, target.name, target.levelobject id, серверный id NPC, имя, уровень
target.hp, target.max_hp, target.hp_pct, mp, mp_pct, cp_pctHP/MP/CP
target.dist, target.heightрасстояние; разница высот (цель минус мы)
target.targetкого таргетит сама цель
target.dead, attackable, summoned, sweepable, spoiledсостояние для боя и свипа
target.combat, stunned, rooted, frozen, sleeping, mutedстатусы
target.x, y, z, target.pos()координаты
target.buff(id), target.buffs(), target.data()баффы, все данные

pet — питомец / саммон

ПолеЗначение
pet.exists, pet.dead, pet.idесть ли, мёртв ли, object id
pet.hp, pet.max_hp, pet.hp_pct, pet.mp_pct, pet.fed_pctHP, MP, сытость
pet.name, pet.level, pet.x/y/zимя, уровень, координаты
pet.buff(id), pet.buffs(), pet.data()баффы, все данные
mobs(f?) / npcs(f?) / players(f?) / objects(f?) → { объект, ... }

Объекты вокруг, от ближнего к дальнему. mobs — атакуемые мобы (по умолчанию только живые), npcs — неатакуемые NPC, players — игроки, objects — все. Вместо таблицы фильтров можно передать строку — часть имени: mobs("wolf").

ФильтрЗначение
name = "wolf"часть имени, без учёта регистра
id = 20176 / {20176, 20177}серверный id NPC
radius = 800не дальше
alive = true / dead = trueтолько живые / только мёртвые
aggro = trueтолько напавшие на нас
kind = "mob" | "npc" | "player"тип (для objects и nearest)

У объекта есть поля id, npc_id, name, x, y, z, dist, hp_pct, mp_pct, dead, attackable, combat, sweepable, spoiled, aggro, is_player и все поля из bot.entity.


local dead = mobs{dead = true, radius = 300}          -- трупы рядом (свип)
if #mobs{id = 20176, radius = 1500} > 0 then log("рядом Wyrm") end
for _, p in ipairs(players{radius = 2000}) do log("игрок рядом:", p.name) end
nearest(f) → объект | nil

Ближайший объект по тем же фильтрам: nearest("grocer"), nearest{kind = "mob", id = 20176}.

dist(объект | {x, y, z} | x, y, z) → number | nil

Расстояние от персонажа.

Короткие действия

ФункцияЧто делает
cast(skill [, кто])скилл; с объектом, id или именем — сначала взять его в цель
use(item)использовать предмет (банка, свиток)
set_target(кто), clear_target()взять в цель объект / id / ближайшего по имени; снять цель
say(text)сообщение в чат
sit(), stand()сесть, встать
to_town()после смерти — в город
key(name)нажать клавишу: key("F1")
wait_for(fn [, ms])ждать, пока fn() не вернёт true (по умолчанию 10 с)

local m = nearest{kind = "mob", name = "wolf", radius = 600}
if m then cast(101, m) end                          -- Stun Attack по ближайшему волку
wait_for(function() return not me.combat end, 15000)

quest{} — квест по шагам

quest{} - это специальный конструктор квестов, в котором можно описать выполнение квеста. Квест описывается как список шагов «есть X → сделай Y». X — то, что дал предыдущий шаг (обычно квестовый предмет), Y — действие.


quest{
    id = 417,                                        -- id квеста
    name = "Path to Scavenger",                      -- для лога
    done = 1642,                                     -- предмет-награда: квест выполнен
    require = {class = 53, level = 18, skill = 254}, -- проверки перед стартом
    retries = 3,                                     -- сколько раз подряд можно повторить шаг
    on_death = function() ... end,                   -- что делать после смерти
    steps = {
        { talk = {"Pippi", "#quest", "#1"} },         -- без условия — первый шаг
        { have = 1646, talk = {"Master Toma", "#quest"} },        -- есть 1646
        { have = {1655, 5}, talk = {"Master Toma", "#quest"} },   -- есть 5 шт. 1655
        { have_any = {1647, 1648}, run = deliver },   -- есть хоть один из
        { check = function() return bot.quest.get_cond(417) == 7 end, run = ... },
        { have = 1653, farm = {zone = "bears", get = {1655, 5}} },
    },
}

Как выбирается шаг

Текущий шаг — последний снизу, чьё условие выполнено. Если ни одно не выполнено — первый. Отсюда три важных свойства:

  • Запуск с любого места. Скрипт сам поймёт по сумке, где персонаж.
  • Порядок шагов важен. Пиши их в порядке квеста: чем дальше по квесту, тем ниже.
  • Если предмет-результат шага потом забирает NPC (письмо, посылка) — это не мешает: смотрится, что есть сейчас.
Если условия шага нет (например, нужного предмета нет в сумке), шаг просто пропускается — бот выбирает другой. Если не подходит ни один шаг, выполняется первый (начало квеста).

Поля квеста

ПолеЗначение
idid квеста — по нему "#quest" выбирает квест у NPC и проверяется «квест выполнен»
nameназвание для лога
doneпредмет-награда: если он есть — квест выполнен. Квест также выполнен, если сервер прислал «завершён»
requireпроверки перед стартом: class — id класса, level — минимальный уровень, skill — нужный выученный скилл
retriesсколько раз подряд шаг может не продвинуть квест, прежде чем бот уйдёт со спота (по умолчанию 3)
on_deathфункция после смерти, см. on_death
enemies, avoid, avoid_radiusмобы по дороге для всего квеста, см. ниже
stepsсписок шагов

Поля шага

У шага одно условие и одно действие.

УсловиеШаг активен, когда
have = idесть предмет
have = {id, n}есть не меньше n штук
have_any = {id, id, ...}есть хоть один из предметов
check = function() ... endфункция вернула true (например, по bot.quest.get_cond(id))
нет условияпервый шаг квеста
ДействиеЧто делает
talk = "Raut"подойти и открыть диалог
talk = {"Raut", "#quest", "#1"}то же и нажать ссылки по очереди ("#quest" — окно квеста)
talk = {"Имя", via = {...}, at = {...}}с телепортом / координатами, как у talk{}
farm = {...}фарм, как farm{}
go = цельдойти до NPC или точки
teleport = "giran" / {гк, ссылки...}телепорт
run = function() ... endсвоя логика
ПрочееЗначение
name = "к Toma"подпись шага в логе; нужна, чтобы сослаться на шаг из plan{}
via = {ГК, ссылки...}телепорт этого шага для teleport_last()
enemies, avoid, avoid_radiusмобы по дороге на этом шаге

Своя логика и ветвление

Если шаг не описать одной строкой — пиши функцию и отдавай её в run. Внутри доступно всё: talk, has, циклы, условия.


-- Посылка от Mion -> кому её отнести
local RECEIVER = { [1647] = "Bronk", [1648] = "Shari", [1649] = "Zimenf" }

local function deliveries()
    for _ = 1, 15 do                         -- не больше 15 повторов
        if has(1646) then return end         -- письмо Mion уже есть
        local receiver
        for item, npc in pairs(RECEIVER) do
            if has(item) then receiver = npc end
        end
        if receiver then talk(receiver, "#quest") else talk("Mion", "#quest", "#1") end
    end
end

-- в квесте:
{ have_any = {1643, 1647, 1648, 1649}, name = "доставки", run = deliveries },

Квесты без квестовых предметов

Если квест не даёт предметов (например, «убей 20 мобов»), условие шага пишется через check и номер шага квеста с сервера:


{ check = function() return bot.quest.get_cond(301) == 2 end,
  farm = {zone = "wolves", until_check = function() return bot.quest.get_cond(301) ~= 2 end} },

Мобы по дороге

Как вести себя с мобами, пока бот идёт (go, подход в talk, дорога к ГК):

ПараметрЧто делает
enemies = "kill"бить напавших (по умолчанию)
enemies = "ignore"не драться, бежать дальше
enemies = "avoid"обходить всех мобов, не драться
avoid = {20176, ...}обходить только этих (ID); остальных — по enemies. Обходимых бот не атакует
avoid_radius = 650зазор обхода (по умолчанию 650)

Где задаётся — ближнее важнее:


quest{ id = 417, enemies = "kill", ... }                          -- весь квест
{ have = 1644, talk = {"Torai", "#quest", "#1", "#1"}, avoid = {20176} }    -- один шаг
talk{"Torai", "#1", avoid = {20176}}                              -- один разговор
go({x, y, z}, {enemies = "ignore"})                               -- одна ходьба
  • Обход строится по геодате вокруг всех обходимых мобов сразу; когда впереди чисто — бот снова идёт прямо к цели.
  • Моб, который уже напал и гонится, не обходится — бот бежит дальше.
  • Если прохода нет — бот ждёт пока моб не отойдет, потом идёт напрямик.
  • Внутри самого farm{} бой идёт как в профиле — параметры действуют только на дорогу к зоне.
  • После каждого прогона скрипта режим сбрасывается и не влияет на макросы профиля.

Смерть и застревание

on_death

on_death это функция которую бот выполнит при смерти, либо после ухода со спота. Бот уходит со спота при застревании (кастует soe или /unstuck и потом будет выполнен блок on_death).


quest{
    ...,
    on_death = function()
        run_to_gk()                               -- к ГК
        talk("Adventurers' Guide", "#2", "#1")    -- баф: строка 2, потом строка 1
        teleport_last()                           -- обратно, куда вёл скрипт
    end,
    steps = {...},
}

Что происходит при смерти:

  1. Ходьба, телепорт и фарм прерываются — бот не бежит пешком к старой цели из города.
  2. Выполняется on_death. В нём обычные talk со ссылками; "#quest" там только нажимает ссылку квестов, без выбора квеста.
  3. Квест продолжается с текущего шага. Шаг, прерванный смертью, не считается неудачной попыткой.

Без on_death квест после воскрешения просто продолжит шаги (бот дойдёт сам — пешком или через города).

Застревание

Если сервер перестал вести персонажа (застрял в текстурах, провалился под землю) или шаг не продвигает квест retries раз подряд, квест не останавливается:

  1. «Уход со спота» — скилл или предмет из профиля (Scroll of Escape и т.п.), а если там ничего не выбрано — /unstuck. В мирной зоне этот шаг пропускается.
  2. Затем тот же on_death.
  3. Квест продолжается.

Если так случилось больше трёх раз подряд на одном шаге — квест останавливается, чтобы бот не крутился бесконечно. Причина пишется в лог.

plan{} — несколько квестов по порядку

План нужен, когда квестов несколько или между ними надо что-то сделать. Например прохождение 2 профы 3 марки сразу.

Квесты описываются отдельно — обычные таблицы, как для quest{}, только без вызова. У шагов, на которые ссылается план, должно быть name.


local Q417 = { id = 417, done = 1642, on_death = ..., steps = {
    { talk = {"Pippi", "#quest", "#1"} },
    { have_any = {...}, run = deliveries, name = "доставки" },
    { have = 1646, talk = TOMA,           name = "к Toma" },
    ...
}}
local Q418 = { id = 418, ... }

plan{
    on_death = function() run_to_gk() teleport_last() end,   -- общий (у квеста — свой)

    {Q417, until_step = "к Toma"},      -- 417, пока не дойдёт до шага «к Toma» (его не делает)
    {Q418, until_have = 1234},          -- 418, пока не появится предмет
    {teleport = "giran"},               -- строка без квеста: просто действие
    {talk = {"Grocer", "#2"}},
    {farm = {zone = "Пауки"}, name = "кач до 20",
     until_check = function() return bot.player.get_level() >= 20 end},
    {Q417},                             -- 417 до конца
    {Q418},
}

Строки плана

СтрокаЧто делает
{Q, until_step = "имя"}вести квест, пока он не дойдёт до шага с этим name. Сам шаг не выполняется — он достанется следующей строке с этим квестом
{Q} или {Q, until_step = "end"}вести квест до конца
{talk = ...}, {farm = ...}, {go = ...}, {teleport = ...}, {run = ...}строка без квеста — то же действие, что у шага. Можно добавить name, enemies/avoid, via, on_death

Условия выхода

У любой строки (с квестом или без) можно задать, когда она закончена. Хватает любого из условий:

ПолеСтрока закончена, когда
until_step = "имя"квест дошёл до шага с этим name (только для квеста)
until_have = id / {id, n}есть предмет (n штук)
until_have_any = {id, ...}есть хоть один из предметов
until_check = function() ... endфункция вернула true

Как работает план

  • Запуск с любого места. Строка, условие выхода которой уже выполнено (или квест уже выполнен / уже на нужном шаге), пропускается.
  • Строка без квеста и без условия выполняется один раз; при перезапуске плана — снова (бот не знает, что она уже была). Чтобы её пропускать, дай ей условие:
    
    {teleport = "giran", until_check = function() return bot.world.town_at() == "giran" end},
    
  • farm в строке (и в шаге квеста внутри такой строки) останавливается по условию выхода строки — get тогда не нужен.
  • Смерть, застревание, teleport_last, enemies/avoid — как в квесте, у того квеста, чья строка сейчас идёт. on_death берётся у квеста; если у квеста его нет — общий из плана.
  • Строка не выполнилась (квест остановился) — план останавливается.
  • Опечатка в until_step — ошибка сразу при запуске, а не через час.

Как бот ходит и летает

Ходьба

  • Бот отправляет одну команду движения прямо к цели — обход рассчитывается по геодате. Если геодата не смогла найти путь, пробуется серверный обход.
  • Напавших мобов бот бьёт обычной боёвкой по профилю (скиллы, спойл/свип, лут) и продолжает путь. Режим можно сменить — мобы по дороге.
  • Отдых по условию профиля (вкладка «Отдых») работает и в пути: при низком HP/MP бот садится, а когда выполнено условие «встать» — идёт дальше к той же точке.
  • Если сервер совсем перестал вести персонажа — это застревание, см. смерть и застревание.

Телепорты

  • Бот может летать между городами — сам. Если цель дальше 15 000 и рядом с ней город (до 40 000 от его ГК), а через город заметно короче — бот летит в этот город с пересадками, дальше пешком.
  • Вне города и без ГК рядом — «Уход со спота» из профиля: выбранный там скилл или предмет, а если не выбран или кончился — /unstuck.
  • В зоны охоты — бот не летает. Это нужно задавать вручную в скрипте скрипт: teleport(гк, ссылки...) или via.

Фарм до условия

farm{} запускает обычный фарм бота в указанной зоне и останавливает его, когда набраны предметы или выполнено условие.

На время фарма:

  • полигон — указанный; после окончания скрипта в настройки возвращается заданный в профиле полигон;
  • targets — приоритетные цели в указанном порядке; других мобов бот не трогает;
  • напавшие мобы(агры) бьются всегда и в первую очередь — даже если их нет в targets и даже за границей зоны;
  • макрос возврата и смена спота из профиля отключены; вышел из зоны — добирается самостоятельно через телепорты и пешком;
  • всё остальное — по профилю: скиллы, спойл, свип, лут, отдых, таймеры.
Фарм закончился, потому чтоfarm{} вернётbot.farm.run вернёт
набрали / условие выполненоtruetrue, "done"
вышло timeout_minfalsefalse, "timeout"
бота остановилиfalsefalse, "stopped"
персонаж умерfalsefalse, "died"
ошибка в параметрахfalsefalse, "bad_args"

Разбор готового квеста

Квест 417 «Path to Scavenger» целиком. Его можно взять за образец.


-- Зоны фарма (точки по порядку обхода)
local BEARS = {
    {135168, -199972, -3770}, {135848, -201664, -3770}, {137360, -204504, -3790},
    {138180, -203568, -3790}, {138832, -202756, -3790}, {138956, -201436, -3770},
    {139132, -196896, -3760}, {135988, -196872, -3760},
}
local TARANTULAS = {
    {146116, -217620, -3400}, {147992, -218480, -3400}, {153624, -217424, -3400},
    {153336, -215692, -3400}, {150272, -213116, -3400}, {148672, -212720, -3400},
    {147632, -213632, -3400},
}

-- Посылка от Mion -> кому её отнести
local RECEIVER = { [1647] = "Bronk", [1648] = "Shari", [1649] = "Zimenf" }

local function deliveries()
    for _ = 1, 15 do
        if has(1646) then return end
        local receiver
        for item, npc in pairs(RECEIVER) do
            if has(item) then receiver = npc end
        end
        if receiver then talk(receiver, "#quest") else talk("Mion", "#quest", "#1") end
    end
end

-- Master Toma живёт в горах: если далеко — телепорт Wirphy, 10-я строка списка
local TOMA = {"Master Toma", "#quest", via = {"Wirphy", "#teleport", "#10"}}

-- После смерти: к ГК, баф и обратно тем же телепортом
function death()
    run_to_gk()
    if server() == "lu4" then
        talk("Adventurers' Guide", "#2", "#1")
    elseif server() == "scryde" then
        talk("Newbie Guide", "#5")
    end
    teleport_last()
end

quest{
    id = 417, name = "Path to Scavenger", done = 1642,
    require = {class = 53, level = 18, skill = 254},
    on_death = death,
    steps = {
        { talk = {"Pippi", "#quest", "#1"} },
        { have_any = {1643, 1647, 1648, 1649, 1650, 1651, 1652},
          name = "доставки для Mion", run = deliveries },
        { have = 1646, talk = TOMA },
        { have = 1653, farm = {points = BEARS, get = {1655, 5}, targets = {27058, 20777}} },
        { have = {1655, 5}, talk = TOMA },
        { have = 1654, farm = {points = TARANTULAS, get = {1656, 20}, targets = {20403, 20508}} },
        { have = {1656, 20}, talk = TOMA },
        { have = 1657, talk = {"Raut", "#quest", "#1"} },
        { have = 1644, talk = {"Torai", "#quest", "#1", "#1"}, avoid = {20176, 20554} },
        { have = 1645, talk = {"Raut", "#quest"} },
    },
}

Что здесь происходит

  • Зоны — просто списки точек. Можно заменить на полигон из редактора: farm = {zone = "имя", ...}.
  • deliveries — пять доставок для Mion не описать одной строкой, поэтому это своя функция в run.
  • TOMA вынесен в переменную, потому что встречается в трёх шагах. via — если Toma далеко, сначала телепорт: "#teleport" открывает список у Wirphy, "#10" — строка в нём; если персонаж в другом городе, бот сначала долетит до Гномьей деревни.
  • Шаги снизу вверх: есть 1645 → к Raut сдавать; есть 1644 → к Torai; есть 1657 → к Raut за 1644 и так далее. Запуск с любого места квеста работает сам.
  • "#quest" — открыть окно квеста у NPC; дальше "#1" — ссылки уже в нём.
  • avoid у шага с Torai — по дороге обходить Wyrm (20176) и Grandis (20554), остальных напавших бить.
  • death — после смерти к ГК, баф (на Lu4 — Adventurers' Guide, на Scryde — Newbie Guide, по server()), обратно через via текущего места.

Справочник bot.*

Низкоуровневые функции, на которых построены простые функции.Лучше использовать высокоуровневые me / target / mobs / cast и простые функции — справочник нужен для редких задач:

Пометка ждёт — функция блокирует скрипт, пока не закончит. Многие действия работают только при запущенном боте в режиме «Скрипт» — иначе сразу возвращают false.
РазделЧто внутри
bot.utilпауза, ожидание условия, таймеры, расстояния, время, случайные числа
bot.playerHP/MP/CP, позиция, уровень, класс, состояния, баффы
bot.targetто же для текущей цели
bot.entityвсе видимые объекты: поиск по имени, радиусу, id
bot.inventoryпредметы, количество, квестовые предметы
bot.worldбаза мира: где NPC, города, полигоны
bot.questсписок квестов с сервера, шаг (cond)
bot.dialogдиалоги NPC: текст, ссылки, ожидание страниц
bot.actionдействия: движение, скиллы, предметы, клавиши, разговор, возврат в город
bot.farmуправление фармом и фарм до условия
bot.path, bot.gatekeeper, bot.macroпути, бег к ГК, макросы
bot.aggro, damage, protect, pvpагры, урон, защита, PvP
bot.pet, party, skills, zone, ground, loot, captchaпитомец, группа, скиллы, зона, предметы на земле, учёт лута, капча
bot.onсобытия: смерть, капча, чат, урон...

bot.util

bot.util.sleep(ms) ждёт

Пауза. Прерывается остановкой скрипта. Пока идёт пауза, срабатывают события bot.on и таймеры. Глобальные синонимы: sleep(ms), wait(ms).

bot.util.wait_until(fn, timeout_ms?, step_ms?) → boolean ждёт

Ждать, пока fn() не вернёт true. По умолчанию таймаут 10 000 мс, опрос раз в 50 мс. false — таймаут, остановка или ошибка в функции.


bot.util.wait_until(function() return not bot.player.is_in_combat() end, 15000)
bot.util.yield()

Один раз обработать накопившиеся события bot.on и таймеры, не делая паузы.

bot.util.set_timer(delay_ms, fn, period_ms?) → id

Вызвать fn через delay_ms; если period_ms > 0 — повторять. Таймер срабатывает только во время sleep / wait_until / yield.

bot.util.clear_timer(id) → boolean

Снять таймер. false — такого нет.

bot.util.random(a?, b?) → number

Без аргументов — дробное в [0, 1); (a) — целое от 1 до a; (a, b) — целое от a до b.

bot.util.random_sleep(lo, hi?) → ms ждёт

Пауза случайной длины от lo до hi мс; возвращает, сколько ждали.

bot.util.distance(x1, y1, z1, x2, y2, z2) → number

Расстояние между двумя точками.

bot.util.distance_to(object_id) → number

Расстояние от персонажа до объекта; -1 — объекта нет.

bot.util.distance_to_target() → number

Расстояние до текущей цели; -1 — цели нет.

bot.util.is_in_polygon() → boolean

Стоит ли персонаж внутри полигона профиля.

bot.util.is_xyz_in_polygon(x, y, z) → boolean

Лежит ли точка внутри полигона профиля.

bot.util.get_time() → ms

Монотонное время в миллисекундах — для замера интервалов.


local t = bot.util.get_time()
talk("Raut")
log("разговор занял", bot.util.get_time() - t, "мс")
bot.util.log(message)

Строка в лог бота с префиксом [lua]. Обычно удобнее log(...).

bot.player

Все функции возвращают nil, если данных персонажа ещё нет.

Для проверок удобнее me: me.hp_pct вместо bot.player.get_hp_percent().

ФункцияВозвращает
get_hp(), get_max_hp(), get_hp_percent()HP, макс. HP, HP в % (0–100)
get_mp(), get_max_mp(), get_mp_percent()MP
get_cp(), get_max_cp(), get_cp_percent()CP
get_x(), get_y(), get_z(), get_position()координаты (последняя — x, y, z сразу)
get_level(), get_exp(), get_sp()уровень, опыт, SP
get_class_id(), get_base_class_id(), get_race(), get_sex()класс, базовый класс, раса, пол
get_name(), get_title()имя, титул
get_karma(), get_pvp_flag(), get_relation()карма, PvP-флаг, битовая маска relation
get_weight(), get_max_weight(), get_weight_percent()вес
get_heading(), get_run_speed(), get_gear_score()направление, скорость бега, Gear Score
get_energy_force() (get_charges()), get_souls()заряды глада\тира, souls (Kamael)
Проверкаtrue, если
is_dead(), is_sitting(), is_running(), is_in_combat()мёртв, сидит, бежит, в бою
is_stunned(), is_rooted(), is_frozen(), is_sleeping(), is_muted()стан, рут, заморозка, сон, молчание
is_invisible(), is_invulnerable()невидим, неуязвим
bot.player.get_data() → table | nil

Все данные персонажа одной таблицей. Поля: object_id, name, title, race, sex, classId, baseClassId, level, exp, sp, hp, max_hp, mp, max_mp, cp, max_cp, hp_percent, mp_percent, cp_percent, weight, max_weight, weight_percent, str, dex, con, int, wit, men, p_atk, p_atk_spd, p_def, m_atk, m_atk_spd, m_def, evasion, accuracy, critical, run_spd, cast_speed, karma, pvp_flag, gear_score, direction, champions_aura, npc_type_id, target_id, x, y, z, is_dead, is_sitting, is_running, is_in_combat, is_attackable, is_summoned, is_sweepable, is_spoiled.


local p = bot.player.get_data()
if p then log(p.name, "HP", p.hp, "/", p.max_hp) end
bot.player.get_server_pos() → x, y, z | nil

Позиция «по серверу», без прогноза бота. get_x/get_y после команды движения сразу «едут» к цели, даже если сервер её проигнорировал; эта позиция — нет.

bot.player.get_effects() → { {skill_id, level, enchant, remaining}, ... }

Баффы и дебаффы. remaining — секунд до конца, -1 — бессрочный.

bot.player.has_effect(skill_id) → boolean

if not bot.player.has_effect(1204) then log("нет Wind Walk") end
bot.player.death_count() → integer

Сколько раз персонаж умер за сессию бота.

bot.player.stuck_count() → integer

Сколько раз ходьба сдалась, потому что сервер перестал вести персонажа.

bot.target

Для проверок удобнее target: target.dead вместо bot.target.is_dead().

То же, что у bot.player, но для текущей цели: get_data(), get_hp(), get_max_hp(), get_hp_percent(), get_mp…, get_cp…, get_level(), get_karma(), get_pvp_flag(), get_x/y/z(), get_name(), get_effects(), has_effect(id), is_dead(), is_sitting(), is_running(), is_in_combat(), is_stunned(), is_rooted(), is_frozen(), is_sleeping(), is_muted(). nil — цели нет.

ФункцияВозвращает
has()есть ли цель
get_id()object id цели; 0 — нет
get_npc_type_id()тип NPC цели (серверный id + 1 000 000)
get_target_id()кого таргетит сама цель
get_distance()расстояние до цели; -1 — нет цели
get_height_diff()z цели минус z персонажа
is_attackable(), is_summoned()можно атаковать; призванный
is_sweepable(), is_spoiled()можно свипнуть; заспойлен

if bot.target.is_dead() and bot.target.is_sweepable() then
    bot.action.use_skill(42)   -- Sweep
end

bot.entity

Для поиска удобнее mobs{} / npcs{} / nearest{}.

Сущность — таблица того же вида, что bot.player.get_data().

bot.entity.get_all() → { entity, ... }

Все видимые объекты: игроки, NPC, мобы.

bot.entity.get_by_id(object_id) → entity | nil

Объект по id. ВНИМАНИЕ! Это objectID моба (внутриклиентский id который меняется каждый раз при перезапуске клиента) а не тот ID (classID) который есть в базах данных и не меняется.

bot.entity.get_count() → integer

Сколько объектов видно.

bot.entity.find_nearest(name) / find_nearest_npc(name) / find_nearest_mob(name) → entity | nil

Ближайший объект, в имени которого есть name (без учёта регистра). _npc — только неатакуемые NPC, _mob — только атакуемые живые мобы.

Устарело — используй nearest{}.


local wolf = bot.entity.find_nearest_mob("Wolf")
if wolf and not wolf.is_dead then bot.action.select_target(wolf.object_id) end
bot.entity.find_in_radius(radius, kind?) → { entity, ... }

Объекты в радиусе от персонажа. kind: "mob", "npc", "player" или "any" (по умолчанию). Мёртвые не исключаются.

bot.entity.find_by_npc_type_id(npc_type_id) → entity | nil

Ближайший объект с этим NPC: принимает и серверный id (20176), и id со смещением (1020176).

Устарело — используй nearest{id = 20176}.

bot.inventory

bot.inventory.get_count(item_id) → integer

Сколько штук (обычные + квестовые). То же, что count().

bot.inventory.has_item(item_id) → boolean

Есть ли предмет (включая квестовые).

bot.inventory.get_item(item_id) → item | nil

Первый предмет с этим id (обычный или квестовый).

bot.inventory.get_all() → { item, ... }

Обычный инвентарь (без квестовых). Поля предмета: object_id, item_id, count, is_equipped, enchant_level, body_part, augmentation_id.

bot.inventory.get_quest_items() → { item, ... }

Квестовые предметы (вкладка «Квест»).

bot.inventory.find_object_id(item_id) → object_id

object id первого такого предмета в обычном инвентаре; 0 — нет.

bot.world

bot.world.npc(id | "Имя") → x, y, z, id | nil

Где NPC: живая позиция, если виден, иначе ближайшая точка из базы мира. Имя можно «титул имя».

bot.world.town_at(x?, y?) → key, gkId, gx, gy, gz | nil

Город в точке (по умолчанию — где стоим); nil — вне городов.

bot.world.nearest_town(x?, y?) → key, gkId, gx, gy, gz, dist

Город, где стоим, иначе ближайший.

bot.world.last_town_trip() → key, секунд_назад | nil

Куда в последний раз летели по городам.

bot.world.polygon(name) → { {x,y,z}, ... } | nil

Точки полигона из редактора (settings/polygons/<name>.txt).

bot.quest

Список квестов приходит от сервера при входе в мир и после каждого взятия, шага и сдачи квеста.

ФункцияВозвращает
is_started(id)квест взят и в процессе
is_completed(id)квест завершён
get_state(id)1 в процессе, 2 завершён, nil — нет
get_cond(id)текущий шаг квеста на сервере; 0 — не взят или завершён
get_all(){ {id, state, cond, started, completed}, ... }
has_received_list()пришёл ли список от сервера

bot.dialog

Для ручной работы с диалогами. Обычно хватает talk().

bot.dialog.click_link(text | "#N") → boolean

Нажать ссылку открытой страницы по тексту или номеру. false — ссылки нет.

bot.dialog.get_text(opts?) → string

Текст открытых страниц.

bot.dialog.contains(phrase, opts?) / contains_any({...}, opts?) / contains_all({...}, opts?) → boolean

Есть ли фраза в тексте страницы. opts: case_insensitive (по умолчанию true), strip_tags (true), include_board (true).


if bot.dialog.contains("come back later") then wait(60000) end
bot.dialog.find(pattern, opts?) → start, end, captures... | nil

Lua-шаблон (как string.find) по тексту страницы.

bot.dialog.wait_for_text(phrase, timeout_ms?, opts?) → boolean ждёт

Ждать, пока на странице появится фраза (по умолчанию 5000 мс).

bot.dialog.step(value, timeout_ms?) → boolean ждёт

Нажать ссылку (строка) или выбор (число, Scryde) и дождаться новой страницы.

bot.dialog.wait_html(ms?) / reset_html() / get_html_pages()

Ждать страницу NPC (по умолчанию 3000 мс) / сбросить флаг и накопленные страницы / получить HTML страниц. То же для досок (Alt+B): wait_board, reset_board, get_board_htmls; для меню выбора: wait_choice, reset_choice, is_choice_open, get_choices() → { {index, name}, ... }.

Все ожидания сразу прерываются остановкой скрипта.

bot.action

Передвижение

bot.action.go(x, y, z, arrive?) → boolean ждёт

Дойти до точки, при необходимости через города. Основа go().

bot.action.walk(x, y, z, arrive?) → boolean ждёт

То же без телепортов.

bot.action.walk_to(x, y, z, arrive?) → boolean ждёт

Старый способ ходьбы (по умолчанию arrive 50). false через 10 с без продвижения.

Устарело — используй go().

bot.action.move_to(x, y, z) / move_to(name) → boolean

Одна команда движения, без ожидания. По имени — к ближайшему объекту с этим именем.

Устарело — используй go(), если нужно дойти.

bot.action.stop_move() → boolean

Остановиться.

bot.action.teleport_town(name) → boolean ждёт

В город с пересадками. Основа teleport("город").

bot.action.teleport(x, y, z) → boolean ждёт

У ближайшего ГК — пункт, высадка которого ближе всего к точке.

bot.action.set_enemies(mode, avoid_ids?, radius?)

Мобы по дороге: "kill", "ignore", "avoid"; avoid_ids — обходить только этих. Обычно задаётся через enemies/avoid.

bot.action.leave_spot(force_unstuck?) → boolean ждёт

«Уход со спота», как в профиле: скилл или предмет из настроек, иначе /unstuck. В мирной зоне сразу true. force_unstuck — сразу /unstuck.

bot.action.unstuck() → boolean

Отправить /unstuck.

bot.action.return_to_village() / to_village() / to_clanhall() / to_castle() / to_fortress() → boolean

После смерти — в город, клан-холл, замок, крепость. to_village и return_to_village — одно и то же.

Устарело — используй to_town() для города.

Бой, скиллы, предметы

bot.action.select_target(object_id) / cancel_target() / select_nearest(name) → boolean

Взять цель по id, снять цель, взять ближайшую по имени.

Устарело — используй set_target() / clear_target().

bot.action.use_skill(skill_id, ctrl?, shift?) → boolean

Использовать скилл; true — каст начался. ctrl — на себя, shift — силой.

Устарело — используй cast().

bot.action.use_skill_on_target(skill_id, target_id, ctrl?, shift?) → boolean ждёт

Взять цель и сразу использовать скилл.

bot.action.cast_skill_and_wait(skill_id, opts?) → "success" | "failed" | "cancelled" | "timeout" | "pending" ждёт

Каст с ожиданием конца. opts: use_item_template_id — использовать предмет вместо скилла, timeout_ms (3000) — ожидание начала каста, on_check — функция; если вернёт true, каст прерывается.

bot.action.fight_aggressors(max_dist?) → integer ждёт

Перебить напавших в радиусе (по умолчанию 1500) обычной боёвкой. Возвращает, сколько целей атаковано.

bot.action.use_item(item_id) / use_item_by_object_id(object_id, ctrl?) → boolean

Использовать предмет.

Устарело — используй use().

bot.action.dispel_buff(target_id, skill_id, level?) → boolean

Снять бафф.

bot.action.collect_loot(killed_id?)

Подобрать лут и хербы рядом (до 10 предметов, до 1500).

bot.action.sit() / stand() → boolean

Сесть / встать.

Устарело — используй sit() / stand().

bot.action.request_skill_list() → boolean

Запросить у сервера список скиллов.

NPC и диалоги

bot.action.talk_to_npc(name, timeout_ms?) → boolean ждёт

Подойти к NPC (имя или id) и открыть диалог. Основа talk().

bot.action.move_to_npc(name) → boolean ждёт

Только подойти к NPC.

bot.action.navigate_npc_dialog(name, {кнопки}) → boolean ждёт

Открыть диалог и пройти цепочку кнопок (текст или "#N").

bot.action.bypass(text) → boolean

Отправить bypass напрямую (то, что стоит за ссылкой).

bot.action.open_alt_b() / navigate_alt_b({кнопки}) → boolean

Открыть Alt+B / пройти по его кнопкам.

bot.action.dialog_choice(n) / choice_menu_response(slot) → boolean

Выбор в диалоге (Scryde) / ответ на меню выбора.

Клавиатура, мышь, чат, группа

bot.action.press_key(key) / press_key_hold(key, ms?) / release_key(key) → boolean

Нажать клавишу ("F1"…"F12", "1"…"0", "A"…"Z", "ESC", "ENTER", "SPACE"…), удерживать ms (50), отпустить.

bot.action.combo_press(key1, key2, ...) → boolean

Сочетание клавиш: combo_press("ALT", "B").

bot.action.mouse_click(button?) → boolean

"LEFT" (по умолчанию), "RIGHT", "MIDDLE".

bot.action.chat(message) → boolean

Сообщение в чат.

Устарело — используй say().

bot.action.accept_party(accept) → boolean

Ответ на приглашение в группу. Без аргумента — отказ.

bot.action.solve_captcha(n) → boolean

Отправить ответ на капчу.

Устарело — используй bot.captcha.solve().

bot.farm

bot.farm.run{polygon=, points=, items=, until_check=, targets=, timeout_min=} → ok, reason ждёт

Фарм до условия — основа farm{}. items = {[id] = n}; reason: "done", "timeout", "stopped", "died", "bad_args".

bot.farm.start(mode?) → boolean

Запустить обычный цикл: "farm" (по умолчанию), "passive", "assist", "support".

bot.farm.stop() / pause() / resume() → boolean

Остановить, поставить на паузу, снять с паузы.

bot.farm.is_running() / is_paused() / in_farming_loop() → boolean

Запущен ли бот; на паузе ли; вызван ли скрипт изнутри цикла фарма.

bot.path

bot.path.follow(name, opts?) / follow_inline({ {x,y,z}, ... }, opts?) → boolean ждёт

Пройти по пути из файла settings/paths/<name>.txt или по точкам в скрипте.

optsЗначение
kill_aggressorsбить напавших (по умолчанию да)
kill_all, kill_all_radiusбить всех мобов в коридоре пути
stop_on_errorпрервать путь, если точка недостижима
avoid_radius, avoid_idsидти без боя, обходя мобов (всех или из списка)

bot.gatekeeper

bot.gatekeeper.run_to_nearest() → boolean ждёт

Бег к ГК города по записанному пути.

Устарело — используй run_to_gk().

bot.macro

bot.macro.execute(name, check_aggro?) → boolean ждёт

Выполнить макрос бота по имени.

bot.aggro · bot.damage · bot.protect · bot.pvp

ФункцияЧто делает
bot.aggro.get_ids()object id мобов, напавших на персонажа
bot.aggro.has_any()есть ли напавшие
bot.aggro.clear()очистить список
bot.damage.is_top_damager(mob_id, threshold?)наша доля урона по мобу ≥ threshold (0.5)
bot.damage.has_dealt(mob_id)наносили ли урон мобу
bot.protect.add(id) / remove(id) / clear()список тех, кого защищать
bot.protect.is_protected(id), peek_attacker()под защитой ли; кто атакует защищаемого
bot.pvp.was_attacked_within(ms)атаковал ли игрок за последние ms

bot.pet · party · skills · zone · ground · loot · captcha

ФункцияЧто делает
bot.pet.is_active(), is_dead(), get_object_id()есть ли пет/саммон, мёртв ли, его id (0 — нет)
bot.pet.get_data()таблица: object_id, summon_type (1 сервитор, 2 пет), level, hp, max_hp, mp, max_mp, hp_percent, mp_percent, fed, max_fed, fed_percent, name, x, y, z
bot.pet.get_hp_percent(), get_mp_percent(), get_effects(), has_effect(id)HP/MP пета, баффы
bot.party.get_member_ids(), get_member(id)id участников группы, данные участника
bot.party.count(), is_in_party(), am_i_leader()размер группы, в группе ли, лидер ли
bot.skills.get_all(){ {id, level, passive, disabled, enchantable}, ... }
bot.skills.has(id), get(id)есть ли скилл, данные скилла
bot.zone.get()"peace", "pvp", "siege", "sevensigns", "altered", "general", "unknown"
bot.zone.is_peace(), is_pvp(), is_siege()тип зоны
bot.ground.get_all()предметы на земле: {object_id, item_id, dropper_id, x, y, z}
bot.ground.find_nearest(item_id?), has_item(object_id)ближайший предмет (любой, если id не задан); лежит ли ещё
bot.ground.get_herbs({id, ...})предметы на земле из списка id (список обязателен)
bot.loot.set_tracking(on), is_tracking(), get_totals(), reset()учёт собранного лута: { {item_id, count}, ... }
bot.captcha.is_active(), get_answer(), solve(n)капча: есть ли, ответ бота, отправить ответ

События bot.on

bot.on(event, function(...) end) → id · bot.off(id)

Подписка на событие. Обработчик вызывается, когда скрипт ждёт (sleep, wait, wait_until, yield); пока работает долгая функция (ходьба, фарм), события копятся.

СобытиеАргументыКогда
"player_died"—персонаж умер
"disconnect"—потеря соединения
"captcha"answerкапча
"party_invite"inviter_name, item_distributionприглашение в группу
"zone_change"new_zone, old_zoneсмена типа зоны
"target_killed"object_idцель убита (последний удар — наш)
"aggro"mob_idмоб напал
"chat"type, char_name, textсообщение в чате
"damage_taken"attacker_id, damageполучен урон
"skill_landed"caster_id, target_idскилл прошёл
"level_up"levelновый уровень
"item_obtained"item_id, countполучен предмет
"weapon_unequipped"item_idоружие снято
"pet_died"object_idпет погиб
"npc_html"htmlпришла страница NPC

bot.on("chat", function(kind, who, text)
    if text:find("bot") then log("кто-то пишет про бота:", who) end
end)
bot.on("level_up", function(level) log("новый уровень", level) end)

Глобальные функции и песочница

ГлобальнаяТо же, что
sleep(ms)bot.util.sleep(ms)
log(...)сообщение в лог (с префиксом квеста внутри quest{})
print(...)то же, что log, но аргументы через табуляцию

Доступны стандартные библиотеки string, table, math, coroutine, а также os.time, os.clock, os.date.

Заблокированы: os.execute, os.remove, os.rename, os.tmpname, os.exit, os.getenv, io.open, io.lines, io.popen, io.tmpfile, io.input, io.output, loadfile, dofile, package.loadlib. Скрипт не может читать и писать файлы и запускать программы.

require("имя") подключает модули только из папок settings/scripts/ и settings/scripts/lib/.

Данные мира

Встроено в бота

ЧтоОткуда
2246 статичных NPC: id и координатыданные по HighFive
пункты в списках всех ГК данные по HighFive
17 городов: ГК, точка высадки, границы, связи между городамиданные по HighFive
строки-города в списках ГК (какая строка ведёт в какой город)парсинг с серверов
имена NPC: общая таблица и добавки под каждый сервертаблицы серверов
библиотека простых функций—

Всё это встроено в бота и не меняется во время работы — бот ничего не запоминает и не дописывает сам.

Вопросы и проблемы

Бот не нажал ссылку у NPC

"#1" — первая ссылка на текущей странице. Чтобы попасть в окно квеста, сначала нажми "#quest": talk("Mion", "#quest", "#1"). Если порядок ссылок неочевиден — используй текст ссылки: talk("Mion", "Say you will help with the work"). В логе «не открылось окно квеста» — у NPC нет ссылки квестов с подходящим текстом (см. "#quest").

Бот идёт пешком туда, куда надо лететь

В зоны охоты бот сам не летает. Добавь via = {ГК, ссылки...} к talk или farm, или добавь явный teleport(гк, ссылки...).

После смерти бот не возвращается

Проверь on_death и что у текущего шага (или шага выше, ведущего туда же) есть via — его использует teleport_last().

Шаг повторяется и квест останавливается

Условие следующего шага не выполняется после действия: например, NPC не выдал предмет, потому что не нажата нужная ссылка. Смотри в логе, на каком шаге и что ответил NPC (talk возвращает текст страницы — его можно вывести через log).

Как посмотреть, что видит скрипт


log("шаг квеста на сервере:", bot.quest.get_cond(417))
log("Honey Jar:", count(1655))
log("текст NPC:", talk("Pippi"))
log("где Toma:", bot.world.npc("Master Toma"))