wow-api-events

WoW 事件（框架事件）

本技能介绍 WoW 客户端通过 OnEvent 处理程序发送给 UI 代码的框架事件，涵盖设置、载荷处理，以及按类别整理的事件列表及其载荷。

信息来源：https://warcraft.wiki.gg/wiki/Events 事件处理：https://warcraft.wiki.gg/wiki/Handling_events OnEvent 处理程序：https://warcraft.wiki.gg/wiki/UIHANDLER_OnEvent 当前版本：Patch 12.0.0 (Retail)

范围

• 仅限 Retail（忽略仅适用于 Classic 的事件）。
• 通过 OnEvent 处理程序分发的框架事件。
• 包含有文档记录的载荷。

何时使用此技能

在需要以下操作时使用此技能：

• 注册或处理事件（RegisterEvent、RegisterUnitEvent）。
• 了解事件载荷及参数顺序。
• 将事件映射到 UI 系统（Inventory、Quest、Party 等）。
• 构建事件驱动的插件逻辑。

如何使用此技能

1. 先阅读下方的事件处理入门指南。
2. 打开包含所需事件类别的参考文件。
3. 使用事件载荷列表拆解处理程序中的 ...。
4. 如果载荷不明确，请在对应的 wiki 页面核对不常见的事件。

事件处理入门指南

核心 API

• CreateFrame("Frame") 会创建一个事件处理框架。
• frame:RegisterEvent("EVENT_NAME") 会订阅指定事件。
• frame:RegisterUnitEvent("UNIT_EVENT", "unit") 会筛选单位。
• frame:SetScript("OnEvent", handler) 会指定处理程序。
• frame:UnregisterEvent("EVENT_NAME") 或 frame:UnregisterAllEvents() 会取消订阅。

处理程序签名

OnEvent 处理程序会接收：

1. self - 框架
2. event - 事件名称字符串
3. ... - 事件载荷参数（因事件而异）

根据 Handling events 指南：

• 全局 event 和 argX 变量已在 patch 4.0.1 中移除。
• 始终从 ... 中拆解载荷。

分发表模式

local f = CreateFrame("Frame")
local handlers = {}

function handlers:PLAYER_LOGIN()
    print("Login")
end

function handlers:BAG_UPDATE(bagID)
    print("Bag updated", bagID)
end

f:SetScript("OnEvent", function(self, event, ...)
  local handler = handlers[event]
  if handler then
    handler(handlers, ...)
  end
end)

for name in pairs(handlers) do
    f:RegisterEvent(name)
end

XML 事件处理程序

<Ui>
  <Frame name="MyEventFrame">
    <Scripts>
      <OnLoad>
        self:RegisterEvent("PLAYER_ENTERING_WORLD")
      </OnLoad>
      <OnEvent>
        print("Event:", event)
      </OnEvent>
    </Scripts>
  </Frame>
</Ui>

调试事件

使用 /etrace 打开 Event Trace 窗口并检查事件流量。

参考文件

事件列表按 API 系统分组，与 wiki 类别一致：

• EVENTS-A-F.md
• EVENTS-G-L.md
• EVENTS-M-R.md
• EVENTS-S-Z.md
• EVENTS-UNDOCUMENTED.md

来源

• https://warcraft.wiki.gg/wiki/Events
• https://warcraft.wiki.gg/wiki/Handling_events
• https://warcraft.wiki.gg/wiki/UIHANDLER_OnEvent