AddOn Studio

Widget API: GameTooltip:SetFrameStack

Revision as of 22:30, 31 March 2012 by WoWWiki>Msaint (→‎Notes: Previously stated that usual lua boolean logic was applied to the optional parameter. This may have been true at some point, but is not now. The current test in Blizzard's ChatFrame.lua is "if(msg == tostring(true)) then" which will on)

← Widget API ← GameTooltip < SetFrameStack

Displays the frame stack of the mouse cursor's current position on the tooltip. This is not intended to be used in typical addons, but is part of the Blizzard_DebugTools "builtin addon" inspired by DevTools.

Arguments

(showhidden)
showhidden
Boolean - If true, includes in the display those frames which are currently hidden.

Returns

nil

Example

GameTooltip_SetDefaultAnchor(GameTooltip, UIParent)
GameTooltip:SetFrameStack(true)

Shows the GameTooltip with information about the frames over which the mouse is currently hovering.

Notes

The /framestack [showHidden] slash command toggles a pre-declared GameTooltip and dispatches this function on it. When followed by 'true', hidden frames will also be shown. No value other than 'true' will cause hidden frames to be shown.

The frame listing on a tooltip after this function is called are arranged by strata and level. Within that list, the frames are colored:

  • Yellow/Orange : frame for which IsMouseEnabled is true
  • Blue/Teal : frame for which IsMouseEnabled is false
  • DarkGrey/LightGrey : frame that is hidden (when showhidden is true)

In each of those pairs, the colors alternate based on the frame level. For example, in a series of four frames all with the mouse enabled and within the same frame level the colors will alternate like this:

  • 4 Orange
  • 3 Yellow
  • 2 Orange
  • 1 Yellow
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_GameTooltip_SetFrameStack&oldid=16525"