WoW:API MouseIsOver: Difference between revisions

WoW:API MouseIsOver (source)

275 bytes removed , 10 January 2005

Added return value documentation

Anonymous user

@@ Line 1: / Line 1: @@
 <center>'''MouseIsOver''' ''-Documentation by [[user:coder_1024|coder_1024]]-''</center>
-<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
+  isOver = MouseIsOver(frame);
-  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.
@@ Line 12: / Line 8: @@
 ;''Arguments''
-<!-- List each argument, together with its type -->
+:(frame)
+:;frame : Frame - The frame to test with
+----
+;''Results''
-:(frame)
+:isOver
-:;frame : the frame in question
+:;isOver : Boolean - A <tt>true</tt> value if the mouse is over the frame, <tt>false</tt> otherwise.
 ----
 ;''Example''
-<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->
 You can determine whether or not the mouse is over the minimap using the below.
@@ Line 27: / Line 25: @@
      -- do something
   end
-----
-;''Details''
-<!-- Details not appropriate for the main description can go here -->
 ----
 {{Template:WoW API}}
+[[Category:API Frame Functions|MouseIsOver]]