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 現行バージョン：パッチ 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. ... - イベントのペイロード引数（イベントごとに異なります）

イベント処理ガイドより：

• グローバル変数 event と argX は、パッチ 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 ウィンドウを開き、イベントの送受信を確認できます。

リファレンスファイル

イベント一覧は Wiki のカテゴリに合わせ、API システムごとに分類されています。

• 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