Lua API Reference

[number]

[string]

[number]

[number]

[number]

[number]

[number]

[number]

[number]

[number]

[number] 0: No party. 1: Party leader inviting your character. 2: Invited member on party. 3: Party member. 4: Party leader.

[number]

[number] — 0 N, 1 E, 2 S, 3 W

[boolean]

[number]

[number]

[number]

[number]

[number] 0: No skull. 1: Yellow skull. 2: Green skull. 3: White skull. 4: Red skull.

[number]

[number]

[number]

[boolean]

[boolean]

[boolean]

[number]

[number]

[number]

[number]

[number]

[number]

[number]

[number]

[number]

[number]

[number]

[number]

[number]

[number]

[number]

[number]

[boolean]

[boolean]

[boolean]

[boolean]

[boolean]

[boolean]

[boolean]

[boolean]

[boolean]

[boolean]

pzone = protection zone (PlayerStates.Pz; alias Pigeon no client). NOTE: some custom servers do not send this bit in getStates() — in that case, `pzone()` will always return false and detection needs to be done by another means (e.g., tile flag, minimap color). We maintain the pattern of the remaining conditions; the user can involve their own check if needed.

[boolean]

[boolean]

[boolean]

[boolean]

[boolean]

[boolean]

getwaypoint(wptIndex) [table]

getwaypoints() [table]

wpt() [table]

[table]

finditemonground(item|id) [table] — {count,posx,posy,posz} da primeira ocorrência

gettile(x, y, z) [table] — items (tabela), topitem, itemcount, posx/posy/posz

gettileeffects(x, y, z) [table] — lista de ids de effects vivos no tile.

gettiles() [table] — 15×11 em redor do player (raio 7 sqm), piso actual

gettileseffects() [table] — tiles na área visível (15×15 centrada no player) com ≥ 1 effect “vivo”. A varredura é síncrona; chama uma vez por tick do motor para captar runes / explosões logo quando acontecem.

iscreatureontile(x, y, z) [boolean]

isposonscreen(x, y, z, fromX?, fromY?, fromZ?) [boolean] — Chebyshev ≤ 7 e z igual. Sem from = origem = player position.

tileiswalkable(x, y, z) [boolean] — idem iswalkable, mantido por contrato

tilereachable(x, y, z) [boolean] — reutiliza tryCreatureReachable

tileshootable(x, y, z) [boolean]

topitem(x, y, z, considerCreatures?) [table]

toplookitem(x, y, z, considerCreatures?) [table]

topmoveitem(x, y, z) [table]

topuseitem(x, y, z, considerCreatures?) [table]

closewindow(windowname) [void] — contentor cujo título / nome case

closewindows() [void] — fechar todos os contentores

openitem(itemid, location, newWindow, index) [void]

openitemslot(slotIndex, location, newWindow) [void] — slot 0-based no contentor; location = nome ou "container"

reachlocation(x,y,z, stepIn?, mapClicks?) [boolean] — inicia autoWalk; não garante chegada. stepIn / mapClicks: reservado (sem API comum; ignorados).

resizebattle(size) [void]

resizewindows() [void] — 1 linha (59px: 25 + 1*34) em cada `container.window` aberto

rturn(times, backOriginal?) [void]

say(text, channel?) [void] — sem canal: talk local; com canal: tenta talkChannel (id)

turn(direction) [void] — só n/e/s/w

useitem(itemid, location) [void]

useitemon(itemid, x, y, z) [void] — item vindo de inventário / mochilas (mesma busca que eatfood)

useitemoncreature(item, creature) [void] — criatura por nome; item por id

useitemonitem(item, itemOn, itemOnLocation, itemLocation) [void] — todos ids

Hotkeys: tem `enableAll` / `disableAll` em vez de `start`/`stop`. Faz a tradução aqui para reusar `_ibSyncEnabledCheckbox` e o pattern uniform.

Genérica: aceita o nome do estado (case-sensitive PascalCase, ex.: "Burn", "Pz", "Hungry"). Útil quando se quer iterar sobre vários states em código user/script sem multiplicar funções dedicadas. hascondition('Burn') == burning() hascondition('Pz') == pzone()

Aliases comuns (vBot-style).

pzblock = red swords / no-logout-no-pz (PvP after-hit timer).

Tibia 12+ (OTClient-main); OTCv8 não expõe estes mas se existirem vão funcionar via `_G.PlayerStates`.

emptyslots(windowName?) [number] — capacity − items.size. Sem nome = soma de todos.

higherwindows(containerName) [void] — sobe para o contentor pai via g_game.upContainer

minimizewindows("equip" | containerName) [void]

restorewindows("equip" | containerName) [void]

stackitems(location?, onlyOnce?, itemName?) — junta stacks parciais no mesmo contentor. location: nome do contentor (ou "container" = primeiro aberto); nil = todos os abertos. onlyOnce: se true, só faz um único merge e sai (útil em macros rápidos). itemName/itemId: restringe a um id (nome só funciona se o contract resolver; aqui = id).

getcreature(name|id) [table] — creatureToInfo resolvido por id (fast-path) ou nome (spectators).

getcreatures(filter) [table<creatureInfo>] — filtro livre: 'p' = player (isPlayer e não LocalPlayer) 'm' = monster (isMonster) 'f' = mesmo floor do player (z igual) 's' = mesmo floor + onscreen (Chebyshev ≤ 7) Sem letras = todos (exclui LocalPlayer).

ignorecreature(id, ignore) [void] — true marca, false/nil remove.

eatfood() [boolean] — usa o primeiro id disponível de `foodItemIds` (sem exigir fome). Só `g_game.use(item)` — sem `useWith` / `useInventoryItem*`. Devolve true se uma tentativa de uso correu (sem erro Lua); false se sem lista, sem `g_game`/`lp`, sem item, ou tudo falhou.

attacked() [table] — criatura em ataque (quadrado vermelho); getAttacked() — mesmo contrato

following() [table] — follow (verde); getFollowing() — mesmo contrato

moveitems(int itemid, to, from, int count?) [void] — to = destino, from = origem

self() [table] — jogador local; getSelf() — mesmo contrato

target() [table] — alvo do motor de Targeting; getTarget() — mesmo contrato

getlastmessage() [table]

getlastprivatemessage(visibleOnly?) [table]

getlastscreenmessage() [string] — debug helper. Devolve a última mensagem capturada (ou via onTextMessage ou via hook directo nos widgets de status — ver IB_HookStatusLabels) com prefixo de origem e mode, para diagnosticar quando getstatusmessage devolve "": ex: print(getlastscreenmessage()) -> "[label=bottomStatusLabel] Sorry, not possible." -> "[mode=21] Sorry, not possible."

getmessages() [table]

getnewmessages() [table] — marca como lidas ao devolver.

getstatusmessage(visibleOnly?) [string] — última status message do jogo (texto branco que aparece sob o mapa: "Sorry, not possible", "You are exhausted", "You cannot use this object", "There is not enough room", etc.). Filtra pelos modes de status/warning do protocolo 8.6 (17 StatusDefault, 18 EventAdvance, 19, 20 StatusWarning, 21, 22 StatusSmall — este último é o típico "not possible"). Devolve "" se nada na janela de visibilidade (5s). Por defeito só devolve mensagens "ainda visíveis" no jogo (mesma janela do screenmessage). Passa `false` para varrer o histórico completo (últimas 32 screen messages).

itemcount(itemId, location?) [number] — soma a contagem visível de um item. Sem `location`: soma todos os contentores abertos + slots de inventário do player. Tiles do chão NÃO são incluídos por defeito (a UI só vê os tiles à volta do player; "inventário visível" = bag + body slots). Com `location`: container('backpack') → só dentro desse contentor (case-insensitive). container(...) → tabela do helper aceite. inventory(slot) → só nesse slot do body (1..10). Útil para confirmar se equipou determinado anel/runa. ground() ou ground(x,y,z) → tile do player (sem args) ou tile dado. "container" / "inventory" / "ground" (string) → equivalente. "<nome do container>" → contentor por nome. Stackables: usa `getCount()`. Items não-stackable contam como 1 cada.

itemcountmsg(item, message) [number] — extrai nº dentro da frase. "Using one of 2 vials..." → 2; "Using the last vial..." → 1.

screenmessage(visibleOnly?, type?) [string] — última "green message" do écran. type: 'any' / 'loot' / 'look' / 'exp' (filtro por palavras-chave no conteúdo).

followcreature(string) [void] — segue a primeira visível: por id (string numérica) ou por nome

move(string) [void] — "n", "s", "e", "w", "nw", "ne", "sw", "se" (ver `Directions` / fallback)

reachcreature(name|id) [void]

reachgrounditem(item, stepIn?) [void] — stepIn=true: ficar **em cima**; false/nil: adjacente

getviplist() [table] — array { { name, isonline }, ... } na ordem de iteração do map interno de VIPs. `isonline` só é verdadeiro para `VipState.Online`; Pending é tratado como offline (corresponde ao semáforo "verde" visível da VIP List).

isviponline(vipName) [boolean] — true sse existe um VIP com esse nome e o estado é Online. Pending (2) e Offline (0) → false. Case-insensitive, como no `game_viplist.lua` do OTCv8.

ligar/desligar o Auto Fishing programaticamente (Action de cavebot, hotkey, persistent). Substitui o equivalente a abrir o painel Tools, escolher modo, definir condMin/Max e marcar Enabled. Args: type : "Capacity" | "Count" - Capacity: comeca a pescar quando cap() >= condmax, para quando cap() <= condmin (encher mochila). - Count : comeca quando #peixes <= condmin, para quando #peixes >= condmax (sessoes). nil/string invalida -> mantem o modo actual. condmin : number, threshold inferior da histerese. nil -> mantem actual. condmax : number, threshold superior da histerese. nil -> mantem actual. bool : true / false, liga ou desliga o motor. nil -> mantem actual. Exemplos: setfishing("Count", 0, 50, true) -- pescar 50 peixes e parar setfishing("Capacity", 100, 200, true) -- encher bag com cap target setfishing(nil, nil, nil, false) -- desligar (mantem config) Sincroniza tambem os widgets do painel Tools se a janela ja' foi criada nesta sessao -- o user ve a mudanca reflectida na UI sem precisar de fechar e reabrir.

isitemontile(itemid, x, y, z) [boolean]

iswalkable(x, y, z) [boolean]

timetosec("HH:MM" | "HH:MM:SS") → segundos desde 00:00. Retorno por contrato = string (mantido) mas contém valor numérico.

— expoem-se como funcoes globais simples para uso em hotkeys, scripts de Action no cavebot (`forcelogout()` / `safelogout()`) e persistents. Diferenca: `forcelogout()` — fecha a ligacao TCP independentemente de pzlocked / in-fight / battle. O server marca o personagem como "logged out" mesmo dentro de combate, *mas* o char permanece online no mundo durante 60-90s a sofrer hits ate que o slot expira (regra de servers OT classicos para evitar combat-log abuse). Util quando o player vai morrer e ja' nao ha como salvar. `safelogout()` — pede logout normal pelo protocolo (packet 0x14 em OT). O server *recusa* o logout se ha pzblock ou estiveres em in-fight com criaturas vivas. Em PZ ou fora de combate fecha limpamente. Recomendado para hotkeys de "AFK exit" e end-of-hunt scripts onde o char ja' voltou ao depot. Defensivo: se `g_game` ou os metodos nao existem (forks antigos), as funcoes sao no-op silencioso em vez de levantar erro.

(conversão via `modules.game_interface.gameMapPanel:getTile({x=px,y=py})`; igual ao que o OTCv8 faz em `getTileUnderCursor`). moveitemspos(px, py, itemid, location?, count?) [void]

useitemonpos(px, py, itemid, location?) [void]

forks que tem bugs no CharacterList module. Tiers (cada um faz pcall + valida widgets/refs antes de tocar): T1: g_game.loginWorld(...) DIRECTO — bypassa todo o UI / module client_entergame. Usa world info cacheada do último connectchar. Esta e a via mais fiavel: nao depende de charactersWindow estar visivel, nao chama CharacterList.create (que tem upvalue bugs em alguns forks). Requer: connectchar() previo nesta sessao. T2: CharacterList.doLogin() com char focado — comportamento OTCv8 padrao. Funciona quando a charlist ja esta visivel e com char focado (last-used-character). Nao precisa de creds em cache. T3: connectchar(...) flow completo — re-digita credenciais + escolhe char por nome. Usado quando nada mais funciona; precisa creds em cache. Cada tier valida pre-conditions; se falhar, tenta o seguinte. Erro final agrega causas para debug.