API de scripts

Seu personagem: hp, maxHp, hpPercent, mana, maxMana, manaPercent, cap, soul, level, vocation, name, x, y, z, direction, skull, inPz, inBattle, pzLocked, hasted, paralyzed, poisoned, magicShield, invisible, hungry, moving, targetId.

Exemplo

if (player.hpPercent < 50) cast("exura vita")

Suas skills: magic, fist, club, sword, axe, distance e shielding, cada uma com level e percent.

Exemplo

log(skills.magic && skills.magic.level)

Sua experiência total.

Exemplo

log(experience)

O gold que você carrega (moedas de gold, platinum e crystal em gold). null quando não se sabe.

Exemplo

if (money !== null && money < 1000) warn("low on gold")

Tudo que está visível menos você: monstros, players e NPCs. Cada um tem id, name, type, hpPercent, x, y, z, distance (sqm), sameFloor, skull, party, level, vocation, summon, attackingMe e isTarget.

Exemplo

for (const c of creatures) log(c.name, c.type, c.distance)

Só os monstros do seu andar.

Exemplo

if (monsters().length >= 3) cast("exevo gran mas vis")

Só os players do seu andar.

Exemplo

if (players().length > 0) pause("cavebot")

Só os NPCs do seu andar.

Exemplo

log(npcs().map((n) => n.name))

A criatura que você está atacando, ou null.

Exemplo

if (target && target.hpPercent < 20) useOnTarget(3155)

A primeira criatura do seu andar com esse nome (maiúscula não importa), ou null.

Exemplo

const bob = findCreature("Bob")

Distância em sqm (a maior diferença entre x e y). Com um argumento, mede a partir de você. Outro andar = Infinity.

Exemplo

if (target && distance(target) > 4) chaseMode("chase")

As linhas novas desde a última chamada: mensagens do servidor, respostas de NPC, fala de monstro, loot e mensagens privadas (só quem mandou).

Exemplo

for (const m of messages()) if (m.type === "npc") log(m.from, m.text)

Suas mochilas abertas: index, name, size, free e items (id, name, count, slot, fluid, bag = true quando o item é uma backpack).

Exemplo

for (const bp of containers) log(bp.name, bp.items.length)

O que você está usando: ring, amulet, boots, rightHand, leftHand e ammo (null quando vazio).

Exemplo

if (!equipment.ring) warn("no ring on")

Os slots da sua hotbar: slot, key, words, itemId e mode (spell, self, target, crosshair, equip…).

Exemplo

log(hotbar.map((h) => h.slot + ":" + (h.words || h.itemId)))

Acha qualquer item do jogo pelo nome e devolve o id, o fluid e o nome, ou null. Toda função de item também aceita o nome entre aspas direto, como useItem("mana fluid"); o painel Funções tem uma busca que mostra os ids.

Exemplo

const fluid = item("life fluid")
log(fluid.name, fluid.id, fluid.fluid)

O depot quando está aberto, ou null: index, size, free, items (id, name, count, slot, bag…) e bags (as backpacks do depot que você abriu, com os itens e os slots livres).

Exemplo

if (depot) log(depot.items.length, "items in the depot")

Abre o depot: usa o locker livre mais perto de você (até 7 sqm; o jogo anda até ele). Precisa do Direct Controls.

Exemplo

openDepot()
await waitUntil(() => depot, 5000)

Abre uma backpack que está dentro de um container aberto, como uma backpack do depot. Precisa do Direct Controls.

Exemplo

openItem(depot.items[1])
await waitUntil(() => depot.bags.length > 0, 3000)

Move um item (das containers ou do depot) para um container (o primeiro slot livre), para dentro de uma backpack ou para "backpack" (a sua backpack principal). count é opcional: tudo por padrão. Precisa do Direct Controls.

Exemplo

moveItem(containers[0].items[0], depot.bags[0])

Fecha um container aberto: uma das suas backpacks, uma backpack do depot ou o depot.

Exemplo

closeContainer(depot)

Quantos itens desse você carrega, pelo nome ("life fluid") ou pelo id. Conta mochilas fechadas quando o item está na hotbar. Pelo id, os fluids usam o mesmo id de vial 2874: informe o fluid (7 mana, 10 life).

Exemplo

if (itemCount("mana fluid") < 20) alarm()

O primeiro item com esse nome nas suas mochilas abertas, ou null. Use o id dele nas outras funções.

Exemplo

const sd = findItem("sudden death rune")

Solta uma magia da sua vocação. Usa a tecla da hotbar quando ela está lá, senão digita. Confere level, mana e cooldown antes.

Exemplo

cast("utani hur")

true quando cast(words) funcionaria agora.

Exemplo

if (canCast("exura vita")) cast("exura vita")

Fala um texto no canal Default: palavras de NPC, magias de casa, qualquer coisa.

Exemplo

say("hi")

Usa um item em você (comida, fluid, runa), pelo nome ou pelo id: useItem("mana fluid"). Usa a tecla da hotbar em modo Self quando existe, senão a mochila.

Exemplo

if (player.manaPercent < 40) useItem(2874, 7)

Usa um item (runa, corda, pá) numa criatura ou num sqm {x, y, z}. Precisa do Direct Controls.

Exemplo

useItemOn(3160, findCreature("Bob"))

Usa uma runa na criatura que você está atacando.

Exemplo

useOnTarget(3155)

Aperta um slot da hotbar. Os números dos slots estão na lista hotbar.

Exemplo

useHotbar(4)

Ataca uma criatura (o objeto, o id ou o nome). O módulo Target pode escolher outra na vez dele.

Exemplo

attack(monsters()[0])

Para de atacar.

Exemplo

if (player.hpPercent < 30) stopAttack()

Um passo: north, south, east, west, north-east, north-west, south-east ou south-west.

Exemplo

walk("north")

Anda até um sqm do seu andar, como um clique no mapa. Precisa do Direct Controls.

Exemplo

walkTo(32369, 32241, 7)

Anda até um sqm do seu andar e espera chegar (true) ou o tempo acabar (false, padrão 30 s). Pause o Cavebot antes para ele não andar para outro lado. Precisa do Direct Controls.

Exemplo

pause("cavebot")
if (await goTo(32369, 32241, 7)) useTile(32369, 32240, 7)
resume("cavebot")

Vira sem andar: north, south, east ou west.

Exemplo

turn("west")

Usa um sqm ao seu lado: porta, alavanca, escada de mão.

Exemplo

useTile(player.x + 1, player.y, player.z)

Joga um item da mochila no chão (embaixo de você quando não informa o sqm). Precisa do Direct Controls.

Exemplo

dropItem(3031, 10)

Troca o modo de luta: attack, balanced ou defense.

Exemplo

fightMode("defense")

Troca o modo de perseguir: stand, chase ou aggressive.

Exemplo

chaseMode("stand")

Sai do jogo (o jogo recusa enquanto você está em batalha).

Exemplo

if (player.hpPercent < 15 && !player.inBattle) logout()

Toca o som do alarme e pisca a janela do bot.

Exemplo

if (player.cap < 50) alarm()

A janela da loja do NPC, ou null quando está fechada: npcName, tab, gold e offers (id, name, price, side buy/sell).

Exemplo

if (trade) log(trade.npcName, trade.offers.length, trade.gold)

Compra pela loja aberta, em lotes de até 100, e espera cada lote passar. Abra a loja antes (diga hi e depois trade). Precisa do Direct Controls.

Exemplo

say("hi")
await wait(1500)
say("trade")
await waitUntil(() => trade, 3000)
await buy(3155, 50)
closeTrade()

Vende pela loja aberta, como o buy.

Exemplo

await sell(3031, itemCount(3031))

Fecha a janela da loja.

Exemplo

closeTrade()

Uma regra para o módulo Target: pergunta à sua função sobre cada monstro na tela. false = nunca atacar, um número = prioridade (maior primeiro, acima da ordem da sua lista), nada = como sempre. O Target precisa estar ligado.

Exemplo

onAttack((m) => {
  if (m.name === "Rat") return false
  if (m.hpPercent !== null && m.hpPercent < 30) return 10
})

Uma regra para o módulo Loot: pergunta sobre cada item de um corpo aberto. false = nunca pegar, true = sempre pegar, nada = as opções do Loot decidem. O Loot precisa estar ligado.

Exemplo

onLoot((item) => {
  if (item.value !== null && item.value < 50) return false
  if (item.name === "dragon ham") return true
})

O Cavebot agora: status (walking, paused:monster, script…), label (a label do trecho da rota em que ele está, como "Hunt"), index (o número do waypoint), waypoint (o tipo dele), stuck (true depois de 3 pulos seguidos) e inWaypoint (true quando um waypoint Script começou esta rodada). null com o Cavebot desligado.

Exemplo

if (cavebot && cavebot.label === "Hunt") log("hunting, waypoint", cavebot.index)

Faz o Cavebot pular para um label. Numa rodada começada por um waypoint Script ele pula quando o script termina; em qualquer outro script, na hora.

Exemplo

if (player.cap < 100) gotoLabel("Refill")

Liga um módulo, como o interruptor dele (target, attack, loot, cavebot, healing…). Fica ligado até alguém desligar.

Exemplo

turnOn("target")

Desliga um módulo, como o interruptor dele. Diferente do pause(), continua desligado depois que o script termina.

Exemplo

turnOff("target")

Segura um módulo (cavebot, target, attack, healing, loot, rune-maker, hunt-follow…) enquanto este script está ligado. Desligar o script solta o módulo.

Exemplo

pause("cavebot")

Solta um módulo segurado por pause().

Exemplo

resume("cavebot")

true quando o interruptor desse módulo está ligado.

Exemplo

if (isOn("cavebot")) log("walking")

Espera e depois segue para a próxima linha. Escreva await antes.

Exemplo

say("hi")
await wait(1500)
say("trade")

Espera até a checagem devolver true (true) ou o tempo acabar (false, padrão 5 s). A checagem roda a cada 0,1 s.

Exemplo

await waitUntil(() => player.manaPercent > 90, 60000)

Por que a última ação devolveu false: mana, cooldown, no-item, chat-busy, one-action-per-tick…

Exemplo

if (!cast("exura")) log(why())

Escreve uma linha no console deste script, embaixo do código.

Exemplo

log("HP", player.hp, "of", player.maxHp)

Como o log, marcado em amarelo.

Exemplo

warn("no mana fluids")

Um objeto que guarda os valores entre as rodadas, até você editar o script ou recarregar o jogo.

Exemplo

storage.kills = (storage.kills || 0) + 1

O relógio do jogo, em milissegundos.

Exemplo

if (now - (storage.last || 0) > 60000) storage.last = now