WoW:API GameTooltip AddLine: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
m (Move page script moved page API GameTooltip AddLine to API GameTooltip AddLine without leaving a redirect)
 
(4 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{widgetmethod}}
{{widgetmethod}}


<center>'''GameTooltip:AddLine''' ''-Documentation by [[user:Goatus|Goatus]]-''</center>
GameTooltip:AddLine(text [, red, green, blue [, wrapText]]);


<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
Appends a line of text to tooltip.


GameTooltip:AddLine(tooltipText [, textColor.r, textColor.g, textColor.b [, wrapText]]);
== Arguments ==


<!-- Describe the purpose of the function, though exhausting detail can be saved for a later section -->
:;text : {{api|string|t=t}} - text which will appear in new tooltip line
:;red : number range 0 to 1 - red color value for text string
:;green : number range 0 to 1 - green color value for text string
:;blue : number range 0 to 1 - blue color value for text string
:;wrapText : {{api|boolean|t=t}} - 'true' to wrap text.


Appends a line of text to tooltip.  If the tooltip already has its maximum number of
== Returns ==
lines, this function silently fails.


----
:none
;''Arguments''


<!-- List each argument, together with its type -->
== Examples ==


:(tooltipText [, textColor.r, textColor.g, textColor.b [, wrapText]])
MyTooltip:SetOwner(TargetFrame, "ANCHOR_RIGHT")
MyTooltip:AddLine("New tooltip line", 1, 1, 1)
MyTooltip:Show()


== Details ==
Note that this only appends the new line to the tooltip. It does not update the tooltip's height/width, so that the newly added line initially appears underneath (outside of) the tooltip.


:;tooltipText : String - string which will appear in new tooltip line
A subsequent call to [[API_Region_Show|GameTooltip:Show()]] will update the tooltip's borders correctly.


:;textColor.r : range 0 to 1 - red color value for text string
== Notes ==
:;textColor.g : range 0 to 1 - green color value for text string
* As of WoW 2.0, there is no longer a maximum number of lines.
:;textColor.b : range 0 to 1 - blue color value for text string
* As of 6.0 uses Lua boolean, rather than WoW Boolean (nil or 1) for wrap text setting.
:;wrapText : nil or 1 - Set to 1 to wrap text.
 
----
;''Returns''
 
<!-- List each return value, together with its type -->
 
:nothing
 
----
;''Example''
 
<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->
 
MyTooltip:SetOwner(TargetFrame, "ANCHOR_RIGHT");
MyTooltip:AddLine("New tooltip line", 1, 1, 1);
MyTooltip:Show();

Latest revision as of 04:45, 15 August 2023

← Widget API ← GameTooltip < AddLine 

GameTooltip:AddLine(text [, red, green, blue [, wrapText]]);

Appends a line of text to tooltip.

Arguments[edit]

text
string - text which will appear in new tooltip line
red
number range 0 to 1 - red color value for text string
green
number range 0 to 1 - green color value for text string
blue
number range 0 to 1 - blue color value for text string
wrapText
boolean - 'true' to wrap text.

Returns[edit]

none

Examples[edit]

MyTooltip:SetOwner(TargetFrame, "ANCHOR_RIGHT")
MyTooltip:AddLine("New tooltip line", 1, 1, 1)
MyTooltip:Show()

Details[edit]

Note that this only appends the new line to the tooltip. It does not update the tooltip's height/width, so that the newly added line initially appears underneath (outside of) the tooltip.

A subsequent call to GameTooltip:Show() will update the tooltip's borders correctly.

Notes[edit]

  • As of WoW 2.0, there is no longer a maximum number of lines.
  • As of 6.0 uses Lua boolean, rather than WoW Boolean (nil or 1) for wrap text setting.
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_GameTooltip_AddLine&oldid=18846"