WoW:API GetMouseFocus: Difference between revisions

Latest revision as of 04:46, 15 August 2023

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

Returns the frame that is currently receiving mouse events. The frame must have enableMouse="true"

frameID = GetMouseFocus();

none

frameID: Table - The frame that currently has the mouse focus. *NOTE: This can momentarily return nil if GetMouseFocus() is called when selecting "Inspect" on another player. This is likely an API bug in 4.1+.

You can get the name of the mouse-enabled frame beneath the pointer with this:

message( "The mouse is over " .. GetMouseFocus():GetName() );

The mouse is over WorldFrame

@@ Line 1: / Line 1: @@
-<center>'''GetMouseFocus''' ''-Documentation by Gello-''</center>
+{{wowapi}}__NOTOC__
+Returns the frame that is currently receiving mouse events.  The frame must have enableMouse="true"
   frameID = GetMouseFocus();
-Returns the frame that is currently receiving mouse events.  The frame must have enableMouse="true"
+== Parameters ==
+=== Arguments ===
-----
-;''Arguments''
 :none
-----
+=== Results ===
-;''Results''
-:frameID
+:;frameID : Table - The frame that currently has the mouse focus. ''*NOTE: This can momentarily return nil if GetMouseFocus() is called when selecting "Inspect" on another player. This is likely an API bug in 4.1+. ''
-:;frameID : Table - The frame that currently has the mouse focus.
-----
+== Example ==
-;''Example''
 You can get the name of the mouse-enabled frame beneath the pointer with this:
@@ Line 22: / Line 19: @@
   message( "The mouse is over " .. GetMouseFocus():GetName() );
-;''Result''
+=== Result ===
   The mouse is over WorldFrame
-----
-{{template:WoW API}}