WoW:API MouseIsOver: Difference between revisions

Revision as of 14:09, 5 September 2006

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ WoW API

← WoW API < MouseIsOver

This function is implemented in Lua here FrameXML/UIParent.lua.

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

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

Parameters

Arguments

(frame, [topOffset, bottomOffset, leftOffset, rightOffset])

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

Returns

isOver: Boolean - A true value if the mouse is over the frame, false otherwise.

Example

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

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

Details

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.

@@ Line 1: / Line 1: @@
-{{framexml}}
+{{framexmlfunc|FrameXML/UIParent.lua}} __NOTOC__
-<center>'''MouseIsOver''' ''-Documentation by [[user:coder_1024|coder_1024]],[[user:KarlKFI|KarlKFI]]-''</center>
+Determines whether or not the mouse is over the specified frame.
   isOver = MouseIsOver(frame, topOffset, bottomOffset, leftOffset, rightOffset);
-Determines whether or not the mouse is over the specified frame.
-----
+== Parameters ==
-;''Arguments''
+=== Arguments ===
 :(frame, [topOffset, bottomOffset, leftOffset, rightOffset])
-:;frame : Frame - The frame to test with
+:;frame : Frame - The frame (or frame-derived object such as Buttons, etc) to test with
 :;topOffset : (optional) Number - distance from the top to include in calculations
 :;bottomOffset : (optional) Number - distance from the bottom to include in calculations
@@ Line 17: / Line 18: @@
 :;rightOffset : (optional) Number - distance from the right to include in calculations
-----
+=== Returns ===
-;''Results''
-:isOver
+:;isOver : [[Boolean]] - A <tt>true</tt> value if the mouse is over the frame, <tt>false</tt> otherwise.
-:;isOver : Boolean - A <tt>true</tt> value if the mouse is over the frame, <tt>false</tt> otherwise.
-----
+== Example ==
-;''Example''
 You can determine whether or not the mouse is over the minimap using the below.
@@ Line 33: / Line 31: @@
-Note: 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.
+== Details ==
+: 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.

Navigation menu

Search