WoW:API GameTooltip SetFrameStack - Revision history

Move page script: Move page script moved page API GameTooltip SetFrameStack to WoW:API GameTooltip SetFrameStack without leaving a redirect

2023-08-15T04:45:38Z

Move page script moved page API GameTooltip SetFrameStack to API GameTooltip SetFrameStack without leaving a redirect

← Older revision

Revision as of 04:45, 15 August 2023

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

2012-03-31T22:30:32Z

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

← Older revision		Revision as of 22:30, 31 March 2012
Line 17:		Line 17:

	== Notes ==		== Notes ==
	The '''/framestack [S]''' slash command toggles a pre-declared GameTooltip and dispatches this function on it. ~~The optional '''S'~~'' ~~argument is interpreted as a boolean following the usual boolean type coercion rules~~, ~~and passed to this method as the ''showhidden'' parameter~~. ~~For example, <tt>~~'~~/framestack~~ true'~~</tt> and <tt>'/framestack cheese'</tt> both show~~ hidden frames.		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 [[UITYPE_FrameStrata\|strata]] and [[FrameLevel#Frame_Levels\|level]]. Within that list, the frames are colored:		The frame listing on a tooltip after this function is called are arranged by [[UITYPE_FrameStrata\|strata]] and [[FrameLevel#Frame_Levels\|level]]. Within that list, the frames are colored:

WoWWiki>Farmbuyer: Initial writeup based on http://forums.worldofwarcraft.com/thread.html?topicId=25578318852&postId=255759571387&sid=1#2

2010-07-06T05:35:09Z

Initial writeup based on http://forums.worldofwarcraft.com/thread.html?topicId=25578318852&postId=255759571387&sid=1#2

New page

{{widgetmethod}} __NOTOC__

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 [[API_Region_Hide|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 [S]''' slash command toggles a pre-declared GameTooltip and dispatches this function on it. The optional '''S''' argument is interpreted as a boolean following the usual boolean type coercion rules, and passed to this method as the ''showhidden'' parameter. For example, <tt>'/framestack true'</tt> and <tt>'/framestack cheese'</tt> both show hidden frames.

The frame listing on a tooltip after this function is called are arranged by [[UITYPE_FrameStrata|strata]] and [[FrameLevel#Frame_Levels|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