WoW:API MouseIsOver: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Added return value documentation)
No edit summary
Line 1: Line 1:
<center>'''MouseIsOver''' ''-Documentation by [[user:coder_1024|coder_1024]]-''</center>
<center>'''MouseIsOver''' ''-Documentation by [[user:coder_1024|coder_1024]],[[user:KarlKFI|KarlKFI]]-''</center>


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


Determines whether or not the mouse is over the specified frame.
Determines whether or not the mouse is over the specified frame.
Line 8: Line 8:
;''Arguments''
;''Arguments''


:(frame)
:(frame, [topOffset, bottomOffset, leftOffset, rightOffset])
:;frame : Frame - The frame to test with
:;frame : Frame - The frame 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


----
----

Revision as of 20:35, 24 April 2005

MouseIsOver -Documentation by coder_1024,KarlKFI-
isOver = MouseIsOver(frame, topOffset, bottomOffset, leftOffset, rightOffset);

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


Arguments
(frame, [topOffset, bottomOffset, leftOffset, rightOffset])
frame
Frame - The frame 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

Results
isOver
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

Template:WoW API