WoW:FrameXML elements: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (new page experiment)
 
m (Move page script moved page FrameXML elements to FrameXML elements without leaving a redirect)
 
(8 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{Stub/API}}
== Overview ==
== Overview ==


This document describes various important UI elements which are provided by the standard World of Warcraft FrameXML UI.
This document describes various important UI elements which are provided by the standard World of Warcraft FrameXML UI.


== Tooltips ==
=== MinimapCluster ===


=== GameTooltip ===
Frame which represents the minimap area of the user interface.


This is the game's tooltip, it consists of a number of lines, to determine how many there are, you can call the [[API GameToolTip NumLines|GameTooltip:NumLines()]] function.
==== Example: Determining if the mouse is over the minimap ====
if (MouseIsOver(MinimapCluster)) then
    -- do something
end


=== GameTooltipTextLeft<i>&lt;num&gt;</i> ===
[[Category:FrameXML documentation]]
 
Each line of text from the game tooltip is represented by one of these objects, replace &lt;num&gt; with the appropriate line number. To obtain the text of a line call the [[API FontString GetText|GameTooltipTextLeft<i>&lt;num&gt;</i>:GetText()]] function.
 
<small>Not sure if there is a way to dynamically form a function name in lua based on a variable (which would allow easily looping through all tooltip lines).</small>

Latest revision as of 04:48, 15 August 2023

Overview[edit]

This document describes various important UI elements which are provided by the standard World of Warcraft FrameXML UI.

MinimapCluster[edit]

Frame which represents the minimap area of the user interface.

Example: Determining if the mouse is over the minimap[edit]

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