The OnEnter handler is called when the user mouse pointer enters the frame.
A typical use for this event is to pop up a help tooltip, or a menu with option choices (for instance on a minimap button). The opposite of OnEnter is OnLeave. If you decide to show something in OnEnter you should hide it again in the OnLeave event handler.
self - the frame being entered
- true, if the mouse pointer has been moved
- false, if the mouse pointer was not moved (e.g. frame:Show() and the mouse pointer is over the frame)
This example illustrates how to use OnEnter and OnLeave to display a mouseover help text in the GameTooltip.
Declare the event handlers in the "Scripts" section of your frame:
<Frame name="MyFrame"> <Scripts> <OnEnter> MyFrame_OnEnter(self) </OnEnter> <OnLeave> MyFrame_OnLeave(self) </OnLeave> </Scripts> </Frame>
Place the actual functions in one of your LUA files:
function MyFrame_OnEnter(self) GameTooltip_SetDefaultAnchor( GameTooltip, UIParent ) GameTooltip:SetText( "This text shows up when you mouse over\nthe MyFrame frame" ) GameTooltip:Show() end function MyFrame_OnLeave(self) GameTooltip:Hide() end