WoW:API GameTooltip ClearLines: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (added ClearLines tooltip function description)
 
m (Move page script moved page API GameTooltip ClearLines to API GameTooltip ClearLines without leaving a redirect)
 
(5 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<center>'''Title''' ''-Documentation by [[user:Goatus|Goatus]]-''</center>
{{widgetmethod}}


<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
Line 30: Line 30:
: If run when Tooltip is visible it will clear all text from it but won't hide it
: If run when Tooltip is visible it will clear all text from it but won't hide it


----
: This doesn't actually clear the right hand column of lines, but meerly hides them. After running this function you can still retreive the previous tooltips RightTextX with the GetText() function. So if you wish to check for text here you should use IsVisible instead of checking of the text value of the field is nil.
{{Template:WoW API}}
<!-- Update the category to the appropriate subsection, and be sure to put the function name as the label for the category link. Multiple subcategories are okay if appropriate, please dont link functions to the API Functions category directly. -->
[[Category:API Functions|SetInventoryItem]]

Latest revision as of 04:45, 15 August 2023

Widget API ← GameTooltip < ClearLines


Tooltip:ClearLines();


Clear all 30 lines of tooltip (both left and right ones)


Arguments


none

Returns


nothing

Details


If run when Tooltip is visible it will clear all text from it but won't hide it
This doesn't actually clear the right hand column of lines, but meerly hides them. After running this function you can still retreive the previous tooltips RightTextX with the GetText() function. So if you wish to check for text here you should use IsVisible instead of checking of the text value of the field is nil.