Um evento chama uma função sua quando algo acontece: alguém fala no chat, aparece um efeito na tela, você aperta uma tecla, o CaveBot chega num label. Assim o script reage na hora, sem ficar checando em loop.

Como registrar#

Game.registerEvent(evento, função) liga a função ao evento e devolve a própria função. Game.unregisterEvent(evento, função) desliga. Guarde a função numa variável se quiser desligar depois. Um script pode ter várias funções no mesmo evento: todas são chamadas, na ordem em que foram registradas.

-- Registra, usa e desliga um evento
local function aoFalar(nome, level, modo, x, y, z, texto)
  print(nome .. ": " .. texto)
end

Game.registerEvent(Game.Events.TALK, aoFalar)

-- 60 s depois, para de ouvir o chat
Timer.new("parar", function()
  Game.unregisterEvent(Game.Events.TALK, aoFalar)
  destroyTimer("parar")
end, 60000)

-- O mesmo código roda no ZeroBot e no DrenoxBot.
-- Aqui wait() não trava os eventos: eles continuam chegando durante a espera.
Game.registerEvent(Game.Events.TEXT_MESSAGE, function(msg)
  if msg.messageType == Enums.MessageTypes.MESSAGE_LOOT then
    print(msg.text)
  end
end)

while true do
  wait(1000)
end

Como os eventos chegam#

• Cada script roda na sua própria thread. Os eventos entram numa fila e rodam nessa thread, um de cada vez, então dois eventos do mesmo script nunca rodam ao mesmo tempo.
• O bot só manda um evento para o script que tem função registrada nele. Os eventos de clique em HUD e em janela vão só para o script que criou o HUD ou a janela.
• Um erro dentro da função aparece no Console como event <número>: <erro> e o script continua rodando.
• wait(ms) não bloqueia os eventos: enquanto o script espera, os eventos e timers da fila continuam rodando.

Resumo#

TALK#

Dispara a cada mensagem de fala que o servidor manda: Default, yell, whisper, canais, PMs e falas de NPC.

-- Pisca a janela quando alguém fala o seu nome
Game.registerEvent(Game.Events.TALK, function(nome, level, modo, x, y, z, texto)
  if texto:lower():find(Player.getName():lower(), 1, true) then
    print(nome .. " (" .. level .. "): " .. texto)
    Client.flashWindow()
  end
end)

MAGIC_EFFECT#

Dispara para cada efeito mágico (não projétil) que o servidor desenha num piso.

-- Mostra no Console os efeitos em volta de você
Game.registerEvent(Game.Events.MAGIC_EFFECT, function(id, x, y, z)
  local p = Player.getPosition()
  if z == p.z and math.abs(x - p.x) <= 1 and math.abs(y - p.y) <= 1 then
    print("efeito " .. id .. " em " .. x .. "," .. y)
  end
end)

HUD_CLICK#

Dispara quando você clica num HUD criado pelo script. Só o script dono do HUD recebe. Antes das funções registradas, o bot chama o callback do próprio HUD (hud:setCallback), se houver.

local botao = HUD.new(20, 100, "[ CaveBot ]")

Game.registerEvent(Game.Events.HUD_CLICK, function(hudId)
  if hudId == botao:getId() then
    Engine.enableCaveBot(not Engine.isCaveBotEnabled())
  end
end)

HOTKEY_SHORTCUT_PRESS#

Dispara quando uma tecla é apertada (não quando é segurada) e a janela do cliente está em foco. Teclas modificadoras sozinhas (Ctrl, Alt, Shift, Win, Num Lock) não disparam: elas entram só na máscara.

local ok, mods, tecla = HotkeyManager.parseKeyCombination("Ctrl+F5")

Game.registerEvent(Game.Events.HOTKEY_SHORTCUT_PRESS, function(k, m)
  if k == tecla and bit.band(m, 7) == mods then
    Engine.enableTargeting(not Engine.isTargetingEnabled())
  end
end)

TEXT_MESSAGE#

Dispara a cada mensagem de texto do servidor: loot, dano, cura, experiência, avisos em verde e vermelho, look.

-- Soma o dano recebido
local total = 0
Game.registerEvent(Game.Events.TEXT_MESSAGE, function(msg)
  if msg.messageType == Enums.MessageTypes.MESSAGE_DAMAGE_RECEIVED then
    total = total + (msg.value or 0)
    print("dano total: " .. total)
  end
end)

MODAL_WINDOW#

Dispara quando o servidor abre uma janela com botões e escolhas (NPCs, quests, sistemas do OT). Responda com Game.modalWindowAnswer.

-- Aperta "Yes" em toda janela que tiver esse botão
Game.registerEvent(Game.Events.MODAL_WINDOW, function(janela)
  for _, b in ipairs(janela.buttons) do
    if b.text == "Yes" then
      Game.modalWindowAnswer(janela.id, b.id, 0)
    end
  end
end)

CUSTOM_MODAL_WINDOW_BUTTON_CLICK#

Dispara quando você clica num botão de uma janela criada pelo script com CustomModalWindow. A janela fecha com o clique. Só o script dono recebe, e o callback da janela (setCallback) é chamado antes.

local janela = CustomModalWindow.new("Refill", "Voltar para a cidade?")
janela:addButton("Sim")  -- 0
janela:addButton("Não")  -- 1

Game.registerEvent(Game.Events.CUSTOM_MODAL_WINDOW_BUTTON_CLICK, function(id, botao)
  if id == janela:getId() and botao == 0 then
    CaveBot.GoTo("refill")
  end
end)

QUEST_LOG#

Dispara quando o servidor manda a lista de quests, por exemplo depois de Game.requestQuestLog().

Game.registerEvent(Game.Events.QUEST_LOG, function(quests)
  for _, q in ipairs(quests) do
    if not q.completed then print("pendente: " .. q.name) end
  end
end)
Game.requestQuestLog()

QUEST_LINES#

Dispara quando o servidor manda as missões de uma quest, por exemplo depois de Game.requestQuestLines(id).

Game.registerEvent(Game.Events.QUEST_LINES, function(questId, missoes)
  for _, m in ipairs(missoes) do
    print(m.name .. ": " .. m.description)
  end
end)

DISTANCE_SHOOT_EFFECT#

Dispara para cada projétil (flecha, runa, magia à distância) que o servidor desenha.

-- Avisa quando um projétil cai no seu piso
Game.registerEvent(Game.Events.DISTANCE_SHOOT_EFFECT, function(id, fx, fy, fz, tx, ty, tz)
  local p = Player.getPosition()
  if tx == p.x and ty == p.y and tz == p.z then
    print("projétil " .. id .. " em você")
  end
end)

LABEL#

Dispara quando o CaveBot chega num waypoint do tipo Label, e só se algum script tiver função registrada nesse evento. O CaveBot pausa antes de mandar o evento e fica parado até um script chamar CaveBot.pause(0). Se o script que registrou o evento parar, a pausa acaba sozinha.

-- No label "checar": sem 50 mana potions, vai para o label "refill"
Game.registerEvent(Game.Events.LABEL, function(indice, label)
  if label == "checar" and Game.getItemCount(268) < 50 then -- 268 = mana potion
    CaveBot.GoTo("refill")
  end
  CaveBot.pause(0) -- solta a rota
end)

OPEN_STASH#

Dispara quando o servidor manda o conteúdo do seu stash (supply stash).

Game.registerEvent(Game.Events.OPEN_STASH, function(stash)
  for _, item in ipairs(stash.stashItems) do
    print(item.itemId .. " x" .. item.count)
  end
end)

HUD_DRAG#

Dispara quando você solta um HUD arrastável (hud:setDraggable(true)) do script numa nova posição. A posição do HUD já está atualizada quando o evento chega.

local hud = HUD.new(20, 60, "Arraste-me")
hud:setDraggable(true)

Game.registerEvent(Game.Events.HUD_DRAG, function(id, x, y)
  if id == hud:getId() then print("HUD agora em " .. x .. ", " .. y) end
end)

ALARM#

Dispara junto com um alarme da aba Tools (o mesmo que aparece no Console como [ALARM]). Se os alarmes estiverem desligados com Engine.allAlarmsEnable(false), o evento também não dispara.

Game.registerEvent(Game.Events.ALARM, function(tipo)
  if tipo == Enums.AlarmType.PLAYER_ON_SCREEN then
    Engine.enableCaveBot(false)
    Sound.play("alarm.wav", true)
  end
end)

CREATURE_HEALTH#

Extra do DrenoxBot (não existe no ZeroBot). Dispara quando o servidor manda a nova vida de uma criatura.

local hud = HUD.new(20, 60, "Alvo: -")
Game.registerEvent(Game.Events.CREATURE_HEALTH, function(id, hp)
  if id == Player.getTargetId() then
    hud:setText(Creature.new(id):getName() .. "  " .. hp .. "%")
  end
end)

PLAYER_DATA#

Extra do DrenoxBot (não existe no ZeroBot). Dispara sempre que o servidor manda o pacote com seus dados de status (vida, mana, cap, level...).

Game.registerEvent(Game.Events.PLAYER_DATA, function(hp, maxHp, mana, maxMana)
  if hp < maxHp * 0.3 then
    Client.showMessage("Vida baixa!")
  end
end)

Eventos do ZeroBot que ainda não disparam#

Game.Events tem todos os nomes do ZeroBot, então registrar os eventos abaixo não dá erro. Mas o DrenoxBot ainda não dispara nenhum deles: a função fica registrada e nunca é chamada.

Veja também: Scripting e a referência de funções.