WoW:API GameTooltip AddLine - Revision history

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

2023-08-15T04:45:37Z

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

← Older revision

Revision as of 04:45, 15 August 2023

Bear at 03:22, 29 December 2014

2014-12-29T03:22:32Z

← Older revision		Revision as of 03:22, 29 December 2014
Line 1:		Line 1:
	{{widgetmethod}}		{{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~~.

WoWWiki>Pcj at 16:26, 4 December 2007

2007-12-04T16:26:40Z

← Older revision		Revision as of 16:26, 4 December 2007
Line 1:		Line 1:
	{{widgetmethod}}		{{widgetmethod}}

	~~<center>'''GameTooltip:AddLine''' ''-Documentation by [[user:Goatus\|Goatus]]-''</center>~~

	<!-- 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 -->

WoWWiki>Luke1410: updated reference to Gametooltip:Show()

2007-05-26T02:39:15Z

updated reference to Gametooltip:Show()

← Older revision		Revision as of 02:39, 26 May 2007
Line 41:		Line 41:
	MyTooltip:AddLine("New tooltip line", 1, 1, 1);		MyTooltip:AddLine("New tooltip line", 1, 1, 1);
	MyTooltip:Show();		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.<br />
			A subsequent call to [[API_Region_Show\|GameTooltip:Show()]] will update the tooltip's borders correctly.

WoWWiki>GazmikFizzwidget: WoW 2.0 update

2007-04-10T21:54:31Z

WoW 2.0 update

← Older revision		Revision as of 21:54, 10 April 2007
Line 9:		Line 9:
	<!-- Describe the purpose of the function, though exhausting detail can be saved for a later section -->		<!-- Describe the purpose of the function, though exhausting detail can be saved for a later section -->

	Appends a line of text to tooltip. ~~If the tooltip already has its~~ maximum number of		Appends a line of text to tooltip. (As of WoW 2.0, there is no longer a maximum number of lines.)
	lines~~, this function silently fails~~.

	----		----

WoWWiki>Farmbuyer at 20:12, 19 August 2006

2006-08-19T20:12:33Z

← Older revision		Revision as of 20:12, 19 August 2006
Line 9:		Line 9:
	<!-- Describe the purpose of the function, though exhausting detail can be saved for a later section -->		<!-- Describe the purpose of the function, though exhausting detail can be saved for a later section -->

	~~Adds Line with~~ text to tooltip.		Appends a line of text to tooltip. If the tooltip already has its maximum number of
			lines, this function silently fails.

	----		----

WoWWiki>Mikk: {{widgetmethod}}

2006-06-10T12:06:35Z

← Older revision		Revision as of 12:06, 10 June 2006
Line 1:		Line 1:
			{{widgetmethod}}

	<center>'''GameTooltip:AddLine''' ''-Documentation by [[user:Goatus\|Goatus]]-''</center>		<center>'''GameTooltip:AddLine''' ''-Documentation by [[user:Goatus\|Goatus]]-''</center>

Line 39:		Line 41:
	MyTooltip:AddLine("New tooltip line", 1, 1, 1);		MyTooltip:AddLine("New tooltip line", 1, 1, 1);
	MyTooltip:Show();		MyTooltip:Show();

	~~----~~
	~~{{Template:WoW API}}~~

WoWWiki>Maldivia: typo in argument list

2006-06-08T11:46:50Z

typo in argument list

← Older revision		Revision as of 11:46, 8 June 2006
Line 1:		Line 1:
	<center>'''~~Title~~''' ''-Documentation by [[user:Goatus\|Goatus~~]]-''</center>~~		<center>'''GameTooltip:AddLine''' ''-Documentation by [[user:Goatus\|Goatus]]-''</center>
	~~<center>'''Title''' ''-Edited by [[user:ThePooBurner\|ThePooBurner~~]]-''</center>

	<!-- 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 -->

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

	<!-- Describe the purpose of the function, though exhausting detail can be saved for a later section -->		<!-- Describe the purpose of the function, though exhausting detail can be saved for a later section -->
Line 15:		Line 14:
	<!-- List each argument, together with its type -->		<!-- List each argument, together with its type -->

	:(tooltipText [, textColor.r, textColor.g, textColor.b , wrapText])		:(tooltipText [, textColor.r, textColor.g, textColor.b [, wrapText]])


Line 38:		Line 37:

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

	~~----~~
	~~4-1-05: Removed the "wrapText" argument as it isn't real. There is no argument after the color with this command. I tested this extensivly when creating custum tooltips for my mod's options pane.~~
	----		----
	{{Template:WoW API}}		{{Template:WoW API}}

WoWWiki>Mania at 07:09, 24 April 2006

2006-04-24T07:09:35Z

← Older revision		Revision as of 07:09, 24 April 2006
Line 39:		Line 39:
	MyTooltip:SetOwner(TargetFrame, "ANCHOR_RIGHT");		MyTooltip:SetOwner(TargetFrame, "ANCHOR_RIGHT");
	MyTooltip:AddLine("New tooltip line", 1,1,1);		MyTooltip:AddLine("New tooltip line", 1,1,1);
	MyTooltip:Show():		MyTooltip:Show();

	----		----

WoWWiki>Anticrash at 15:44, 4 January 2006

2006-01-04T15:44:05Z

← Older revision		Revision as of 15:44, 4 January 2006
Line 45:		Line 45:
	----		----
	{{Template:WoW API}}		{{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\|Empty Template]]~~