WoW:API GameTooltip AddLine: Difference between revisions

WoW:API GameTooltip AddLine (source)

Revision as of 03:22, 29 December 2014

447 bytes removed , 29 December 2014

m

no edit summary

Bear

Bureaucrats, Interface administrators, Administrators

49

edits

@@ Line 1: / Line 1: @@
 {{widgetmethod}}
-<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
+ GameTooltip:AddLine(text [, red, green, blue [, wrapText]]);
- GameTooltip:AddLine(tooltipText [, textColor.r, textColor.g, textColor.b [, wrapText]]);
+Appends a line of text to tooltip.
-<!-- Describe the purpose of the function, though exhausting detail can be saved for a later section -->
+== Arguments ==
-Appends a line of text to tooltip. (As of WoW 2.0, there is no longer a maximum number of lines.)
+:;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.
-----
+== Returns ==
-;''Arguments''
-<!-- List each argument, together with its type -->
+:none
-:(tooltipText [, textColor.r, textColor.g, textColor.b [, wrapText]])
+== Examples ==
+ MyTooltip:SetOwner(TargetFrame, "ANCHOR_RIGHT")
+ MyTooltip:AddLine("New tooltip line", 1, 1, 1)
+ MyTooltip:Show()
-:;tooltipText : String - string which will appear in new tooltip line
+== 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.
-:;textColor.r : range 0 to 1 - red color value for text string
+A subsequent call to [[API_Region_Show|GameTooltip:Show()]] will update the tooltip's borders correctly.
-:;textColor.g : range 0 to 1 - green color value for text string
-:;textColor.b : range 0 to 1 - blue color value for text string
-:;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();
-----
+== Notes ==
-;''Details''
+* As of WoW 2.0, there is no longer a maximum number of lines.
-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.<br />
+* As of 6.0 uses Lua boolean, rather than WoW Boolean (nil or 1) for wrap text setting.
-A subsequent call to [[API_Region_Show|GameTooltip:Show()]] will update the tooltip's borders correctly.