https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AWindowRegisterCoreEventHandlerAPI:WindowRegisterCoreEventHandler - Revision history2026-10-18T16:17:50ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:WindowRegisterCoreEventHandler&diff=30888&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:51:44Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Window}}<br />
Sets the Lua function that a window calls for one of its own (core) events, such as a mouse click.<br />
<br />
<pre><br />
WindowRegisterCoreEventHandler(windowName, eventName, functionName)<br />
</pre><br />
<br />
== Arguments ==<br />
;windowName : <code>string</code> – Name of the window.<br />
;eventName : <code>string</code> – Name of the core event, for example <code>"OnLButtonUp"</code>. See the list below.<br />
;functionName : <code>string</code> – Name of the Lua function to call, as a dotted path such as <code>"MyAddon.OnClick"</code>.<br />
<br />
== Returns ==<br />
Nothing.<br />
<br />
== Details ==<br />
* These are the core event names in the client's event table:<br />
** <code>OnInitialize</code>, <code>OnInitializeCustomSettings</code>, <code>OnShutdown</code>, <code>OnUpdate</code><br />
** <code>OnLButtonDown</code>, <code>OnLButtonUp</code>, <code>OnLButtonDblClk</code>, <code>OnRButtonDown</code>, <code>OnRButtonUp</code>, <code>OnRButtonDblClk</code>, <code>OnMButtonDown</code>, <code>OnMButtonUp</code>, <code>OnMButtonDblClk</code><br />
** <code>OnMouseOver</code>, <code>OnMouseOverEnd</code>, <code>OnMouseDrag</code>, <code>OnMouseWheel</code><br />
** <code>OnKeyEnter</code>, <code>OnKeyTab</code>, <code>OnKeyEscape</code>, <code>OnRawDeviceInput</code>, <code>OnGamepadInput</code><br />
** <code>OnShown</code>, <code>OnHidden</code>, <code>OnSizeUpdated</code>, <code>OnSetMoving</code><br />
** <code>OnHyperLinkLButtonDown</code>, <code>OnHyperLinkLButtonUp</code>, <code>OnHyperLinkRButtonDown</code>, <code>OnHyperLinkRButtonUp</code>, <code>OnHyperLinkMButtonDown</code>, <code>OnHyperLinkMButtonUp</code>, <code>OnHyperLinkMouseOver</code>, <code>OnHyperLinkMouseOverEnd</code><br />
* The call fails '''silently''' (no error) when:<br />
** <code>eventName</code> is not a known core event name,<br />
** <code>eventName</code> or <code>functionName</code> is empty, or<br />
** the window already has a handler for that event. The old handler stays. Remove it first with [[API:WindowUnregisterCoreEventHandler|WindowUnregisterCoreEventHandler]].<br />
* Window XML sets the same handlers with <code>&lt;EventHandler event="OnLButtonUp" function="..." /&gt;</code>. This function adds one at run time, for example to a window created from a template.<br />
* For game events (<code>SystemData.Events.*</code>) use [[API:WindowRegisterEventHandler|WindowRegisterEventHandler]] instead.<br />
<br />
== Errors ==<br />
* <code>Error in function call 'WindowRegisterCoreEventHandler': Window %s does not exist</code><br />
<br />
== Example ==<br />
Making a context menu item react to clicks and mouse-over, from <code>ea_chatwindow/source/chatwindow.lua</code>:<br />
<pre><br />
CreateWindowFromTemplate ("ChatWindowContextShowTimestamp", "ChatContextMenuItemCheckBox", "Root")<br />
LabelSetText( "ChatWindowContextShowTimestampCheckBoxLabel", GetChatString( StringTables.Chat.LABEL_CHAT_TAB_TIMESTAMP ) )<br />
WindowRegisterCoreEventHandler("ChatWindowContextShowTimestamp", "OnLButtonUp", "EA_ChatWindow.ToggleTimestamp")<br />
WindowRegisterCoreEventHandler("ChatWindowContextShowTimestamp", "OnMouseOver", "EA_Window_ContextMenu.OnMouseOverDefaultMenuItem")<br />
</pre><br />
<br />
== See also ==<br />
* [[API:WindowUnregisterCoreEventHandler|WindowUnregisterCoreEventHandler]]<br />
* [[API:WindowRegisterEventHandler|WindowRegisterEventHandler]]</div>Maintenance script