WoW:API MouseIsOver: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
 
m (Move page script moved page API MouseIsOver to WoW:API MouseIsOver without leaving a redirect)
 
(9 intermediate revisions by 8 users not shown)
Line 1: Line 1:
<center>'''MouseIsOver''' ''-Documentation by [[user:coder_1024|coder_1024]]-''</center>
{{framexmlfunc|FrameXML/UIParent.lua}}
 
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
 
MouseIsOver(frame);
 
<!-- Describe the purpose of the function, though exhausting detail can be saved for a later section -->
 
Determines whether or not the mouse is over the specified frame.
Determines whether or not the mouse is over the specified frame.


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


<!-- List each argument, together with its type -->
== Parameters ==
=== Arguments ===
:(frame, [topOffset, bottomOffset, leftOffset, rightOffset])


:(frame)
* frame (Frame) - The frame (or frame-derived object such as Buttons, etc) to test with
:;frame : the frame in question
* 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 ===
;''Example''


<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->
* 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.
You can determine whether or not the mouse is over the minimap using the below.


Line 28: Line 25:
  end
  end


----
== Details ==
;''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.
 
<!-- Details not appropriate for the main description can go here -->


----
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.
{{Template:WoW API}}

Latest revision as of 04:46, 15 August 2023

← WoW API < MouseIsOver

"I" iconThis 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 (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

  • 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.

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.

Retrieved from "https://addonstudio.org/mw1/index.php?title=WoW:API_MouseIsOver&oldid=5894"