EventButton and EventFrame widgets

Mayron · 03-12-23, 03:28 AM

Hi all. I was wondering if there are any documentation or wiki articles on these newer `EventFrame` and `EventButton` widgets. Blizzard uses them a lot in their XML files. I was surprised I haven't heard much discussion online about them.

Here's an example of how to create an `EventFrame`, followed by the contents dumped to depth 2:

`/run local a = CreateFrame("EventFrame");`

Lua Code:

["OnShow_Intrinsic"] = function: 000002106023F200, 
["HasRegistrantsForEvent"] = function: 0000021060BA9730, 
["GetCallbacksByEvent"] = function: 00000210600A3A50, 
["UnregisterEvents"] = function: 00000210600BADF0, 
["OnHide_Intrinsic"] = function: 000002106023F1C8, 
["GenerateCallbackEvents"] = function: 00000210600BB630, 
["DoesFrameHaveEvent"] = function: 00000210600A3BD8, 
["GetCallbackTable"] = function: 00000210600A3A18, 
["callbackTables"] = { 
    ["1"] = {}, 
    ["2"] = {} 
}, 
["SecureInsertEvent"] = function: 0000021060BA9780, 
["Event"] = { 
  ["OnSizeChanged"] = "OnSizeChanged", 
  ["OnShow"] = "OnShow", 
  ["OnScroll"] = "OnScroll", 
  ["OnAllowScrollChanged"] = "OnAllowScrollChanged", 
  ["OnHide"] = "OnHide" 
}, 
["RegisterCallback"] = function: 0000021060122FD0, 
["GetCallbackTables"] = function: 00000210600A39A8, 
["SetUndefinedEventsAllowed"] = function: 00000210600A39E0, 
["UnregisterCallback"] = function: 0000021060BA97D0, 
["TriggerEvent"] = function: 0000021060123050, 
["OnSizeChanged_Intrinsic"] = function: 000002106023F238, 
["RegisterCallbackWithHandle"] = function: 00000210600BB670, 
["OnLoad"] = function: 0000021060BA96E0, 
["OnLoad_Intrinsic"] = function: 000002106023F190

And here's an example of how to create an `EventButton`, followed by the contents dumped to depth 2:

`/run local a = CreateFrame("EventButton");`

Lua Code:

["OnClick_Intrinsic"] = function: 00000184D802D790, 
["OnMouseUp_Intrinsic"] = function: 00000184D802D590, 
["HasRegistrantsForEvent"] = function: 00000185626BC670, 
["GetCallbacksByEvent"] = function: 00000184D801CB80, 
["UnregisterEvents"] = function: 00000184D8023F10, 
["OnLeave_Intrinsic"] = function: 000001854FD29568, 
["GetCallbackTables"] = function: 00000184D801CAD8, 
["SecureInsertEvent"] = function: 00000185626BC6C0, 
["GenerateCallbackEvents"] = function: 00000184D8024750, 
["TriggerEvent"] = function: 00000184D806C150, 
["OnLoad"] = function: 00000185626BC620, 
["callbackTables"] = { 
    ["1"] = {}, 
    ["2"] = {} 
}, 
["OnLoad_Intrinsic"] = function: 000001854FD294C0, 
["Event"] = { 
  ["OnSizeChanged"] = "OnSizeChanged", 
  ["OnEnter"] = "OnEnter", 
  ["OnValueChanged"] = "OnValueChanged", 
  ["OnMouseDown"] = "OnMouseDown", 
  ["OnLeave"] = "OnLeave", 
  ["OnClick"] = "OnClick", 
  ["OnMouseUp"] = "OnMouseUp" 
}, 
["RegisterCallback"] = function: 00000184D806C0D0, 
["GetCallbackTable"] = function: 00000184D801CB48, 
["SetUndefinedEventsAllowed"] = function: 00000184D801CB10, 
["UnregisterCallback"] = function: 00000185626BC710, 
["DoesFrameHaveEvent"] = function: 00000184D801CD08, 
["OnSizeChanged_Intrinsic"] = function: 000001854FD295A0, 
["RegisterCallbackWithHandle"] = function: 00000184D8024790, 
["OnEnter_Intrinsic"] = function: 000001854FD29530, 
["OnMouseDown_Intrinsic"] = function: 00000184D802D750

Mayron · 03-12-23, 03:29 AM

I can mostly guess how to use them, but I wasn't sure how many other addon devs didn't know about these newer widgets or if there are any additional resources for how to use them correctly. Has anyone tried them before and if so how and why did you use them?

I wasn't sure if these EventFrames were for registering in-game wow events, custom events, or only for frame/button events as shown in the `Event` sub-table (like OnSizeChanged, etc...).

If you can use them for registering game events then I was curious if you could substitute a "Frame" widget that only exists for registering and handling events with "EventFrame".

Xrystal · 03-12-23, 06:35 AM

I've seen them while looking at their code while bug fixing addons but not really needed to look further at them. I assumed they were either templates you used in your own frames or something that can only be used by Blizzard frames.

Fizzlemizz · 03-12-23, 08:26 AM

They're "new" intrinsics, the documentation is basically in their mixins (and inherited mixins).

EventTraceLogEventButtonMixin (Addons\Blizzard_EventTrace\Blizzard_EventTrace.lua which is LOD) and EventFrameMixin (EventFrame.lua).