WoW API < MouseIsOver

"I" iconThis function is implemented by FrameXML in [DEPRECATED http://wowprogramming.com/utils/xmlbrowser/live/FrameXML/UIParent.lua FrameXML/UIParent.lua].

Determines whether or not the mouse is over the specified frame.

isOver = MouseIsOver(frame, topOffset, bottomOffset, leftOffset, rightOffset);

Parameters[edit | edit source]

Arguments[edit | edit source]

(frame, [topOffset, bottomOffset, leftOffset, rightOffset])
  • frame (Frame) - The frame (or frame-derived object such as Buttons, etc) to test with
  • topOffset (number) - distance from the top to include in calculations. optional
  • bottomOffset (number) - distance from the bottom to include in calculations. optional
  • leftOffset (number) - distance from the left to include in calculations. optional
  • rightOffset (number) - distance from the right to include in calculations. optional

Returns[edit | edit source]

  • isOver (boolean) - A 'true' value if the mouse is over the frame, 'false<' otherwise.

Example[edit | edit source]

You can determine whether or not the mouse is over the minimap using the below.

if (MouseIsOver(MinimapCluster)) then
   -- do something
end

Details[edit | edit source]

It doesn't matter if the frame is hidden or not, if the mouse would be over it when you :Show() it then this function does return true.

Most importantly, it will still return true if the frame in question has its mouse response disabled using EnableMouse(false). Hence, MouseIsOver is what you need for rollover effects not interfering with the player's world clicks.

Community content is available under CC-BY-SA unless otherwise noted.