WoW:ItemLink - Revision history

Move page script: Move page script moved page ItemLink to WoW:ItemLink without leaving a redirect

2023-08-15T04:48:32Z

Move page script moved page ItemLink to ItemLink without leaving a redirect

← Older revision

Revision as of 04:48, 15 August 2023

Bear: /* Changes */

2016-07-21T02:01:03Z

Changes

← Older revision		Revision as of 02:01, 21 July 2016
Line 2:		Line 2:
	{{wowapitype}}		{{wowapitype}}

	An [[ItemLink]] ~~is a string that can be processed by the WoW UI to produce UI item~~ 'link' text for a [[item\|game item]]~~. [[ItemLink]]s are [[itemString\|ItemStrings]] with additional formatting to make~~ in~~-game~~ text ~~controls~~ display them as clickable hyperlinks. ~~ItemLinks are returned various functions, including~~ {{apif\|GetAuctionItemLink}}, {{apif\|GetContainerItemLink}}, {{apif\|GetInventoryItemLink}}.		[[ItemLink]]s are [[itemString]]s with additional formatting for embedding 'link' text for a [[item\|game item]] link, typically used for display in the UI such as text boxes that can display them as clickable hyperlinks. See {{apif\|GetAuctionItemLink}}, {{apif\|GetContainerItemLink}}, {{apif\|GetInventoryItemLink}}.

			\|cff9d9d9d\|Hitem:3299::::::::20:257::::::\|h[Fractured Canine]\|h\|r

	== Format ==		== Format ==

	* ~~<tt>"'''~~\|cff9d9d9d~~'''"</tt>~~ - Colorizes the link with a medium grey color (hex color code)		* \|cff9d9d9d - Colorizes the link with a medium grey color (hex color code)
	** The first two characters after ~~pipe-~~c may be the alpha level, where ~~<code>~~ff~~</code>~~ is fully opaque.		** The first two characters after '\|c' may be the alpha level, where 'ff' is fully opaque.
	** The next three sets of two characters represent the red, green, and blue levels, just like HTML.		** The next three sets of two characters represent the red, green, and blue levels, just like HTML.
	* ~~<tt>"'''~~\|H~~'''"</tt>~~ - Hyperlink link data starts here		* \|H - Hyperlink link data starts here
	* ~~<tt>"'''~~item:7073:0:0:0:0:0:0:0:0:0:0~~'''"</tt>~~ - ~~The embedded~~ item string. See [[itemString]]~~. Changed in 5.0.4~~.		* item:7073:0:0:0:0:0:0:0:0:0:0:0:0 or item:7073:::::::::::: - the item string. See [[itemString]].
	* ~~<tt>"'''~~\|h~~'''"</tt>~~ - End of link, text follows		* \|h - End of link, text follows
	* ~~<tt>"'''~~[Broken Fang]~~'''"</tt>~~ - The actual text displayed		* [Broken Fang] - The actual text displayed
	* ~~<tt>"'''~~\|h~~'''"</tt>~~ - End of hyperlink		* \|h - End of hyperlink
	* ~~<tt>"'''~~\|r~~'''"</tt>~~ - Restores color to normal		* \|r - Restores color to normal

	\|cff9d9d9d\|Hitem:7073:0:0:0:0:0:0:0:80:0:0\|h[Broken Fang]\|h\|r		\|cff9d9d9d\|Hitem:7073::::::::::::\|h[Broken Fang]\|h\|r

	== Summary ==		== Summary ==

	=== Example ===		=== Example ===
			local itemLink =
			"\|cff9d9d9d\|Hitem:3299::::::::20:257::::::\|h[Fractured Canine]\|h\|r"
	local itemString = string.match(itemLink, "item[%-?%d:]+")		local itemString = string.match(itemLink, "item[%-?%d:]+")
			Produces:
			itemString == "item:3299::::::::20:257::::::"
	This example extracts the itemString from a given itemLink using the string.match regex Lua function.		This example extracts the itemString from a given itemLink using the string.match regex Lua function.

Line 27:		Line 33:

	'''To obtain all the data within a hyperlink, you can use the following:'''		'''To obtain all the data within a hyperlink, you can use the following:'''
	local _, _, Color, Ltype, Id, Enchant, Gem1, Gem2, Gem3, Gem4, Suffix, Unique, LinkLvl, Name =		local _, _, Color, Ltype, Id, Enchant, Gem1, Gem2, Gem3, Gem4,
	string.find(itemLink,		Suffix, Unique, LinkLvl, Name = string.find(itemLink,
	"\|?c?f?f?(%x)\|?H?([^:]):?(%d+):?(%d):?(%d):?(%d):?(%d):?(%d):?(%-?%d):?(%-?%d):?(%d):?(%d):?(%-?%d)\|?h?%[?([^%[%]]*)%]?\|?h?\|?r?")		"\|?c?f?f?(%x)\|?H?([^:]):?(%d+):?(%d):?(%d):?(%d):?(%d):?(%d):?(%-?%d):?(%-?%d):?(%d):?(%d):?(%-?%d)\|?h?%[?([^%[%]]*)%]?\|?h?\|?r?")
	Note that this will accept any hyperlink (item/spell/quest/talent/achievement/tradeskill/etc), it will take itemstrings alone, or even just a single number.		Note that this will accept any hyperlink (item/spell/quest/talent/achievement/tradeskill/etc), it will take itemstrings alone, or even just a single number.
Line 49:		Line 55:
	*Enter the game and paste the information into the chat window		*Enter the game and paste the information into the chat window
	*A clickable link for that item should appear		*A clickable link for that item should appear

			== Changes ==
			* Patch 5.0.4 - changed the number of [[itemString]] parameters from 10 to 11
			* Patch 7.0.3 - in the 'itemString' portion place holder 0s can be removed or left blank to be assumed 0. For example ''\|cff9d9d9d\|Hitem:7073:0:0:0:0:0:0:0:80:0:0:0:0\|h[Broken Fang]\|h\|r'' becomes ''\|cff9d9d9d\|Hitem:7073:::::::0:80::::\|h[Broken Fang]\|h\|r''. See [[itemString]]

	== Notes ==		== Notes ==
	* The format of the link is similar for enchant, spell and quest links, with merely the "itemstring" changing. See [[spellString]], [[enchantString]] and [[questString]]		* The format of the link is similar for enchant, spell and quest links, with merely the "itemstring" changing. See [[spellString]], [[enchantString]] and [[questString]]
	* Patch 5.0.4 - changed the number of [[itemString]] parameters from 10 to 11

	== See ==		== See Also ==
	* [[itemString]]		* [[itemString]]
	* {{apif\|GetContainerItemLink}}		* {{apif\|GetContainerItemLink}}
	* [[item\|game item (item)]]		* [[item\|game item (item)]]
	* [[questString]], [[spellString]], [[enchantString]]		* [[questString]], [[spellString]], [[enchantString]]

67.42.57.13 at 05:29, 25 October 2013

2013-10-25T05:29:10Z

← Older revision		Revision as of 05:29, 25 October 2013
Line 2:		Line 2:
	{{wowapitype}}		{{wowapitype}}

	An [[ItemLink]] is a string that can be processed by the WoW UI to produce UI item 'link' text for a [[item\|game item]]. [[ItemLink~~\|ItemLinks~~]] are [[itemString\|ItemStrings]] with additional formatting to make in-game text controls display them as clickable hyperlinks. ItemLinks are returned various functions, including {{apif\|GetAuctionItemLink}}, {{apif\|GetContainerItemLink}}, {{apif\|GetInventoryItemLink}}.		An [[ItemLink]] is a string that can be processed by the WoW UI to produce UI item 'link' text for a [[item\|game item]]. [[ItemLink]]s are [[itemString\|ItemStrings]] with additional formatting to make in-game text controls display them as clickable hyperlinks. ItemLinks are returned various functions, including {{apif\|GetAuctionItemLink}}, {{apif\|GetContainerItemLink}}, {{apif\|GetInventoryItemLink}}.

	== Format ==		== Format ==
Line 10:		Line 10:
	** The next three sets of two characters represent the red, green, and blue levels, just like HTML.		** The next three sets of two characters represent the red, green, and blue levels, just like HTML.
	* <tt>"'''\|H'''"</tt> - Hyperlink link data starts here		* <tt>"'''\|H'''"</tt> - Hyperlink link data starts here
	* <tt>"'''item:7073:0:0:0:0:0:0:0:0:0:0'''"</tt> - The embedded item string. See [[itemString]]. Changed in 5.0.4.		* <tt>"'''item:7073:0:0:0:0:0:0:0:0:0:0'''"</tt> - The embedded item string. See [[itemString]]. Changed in 5.0.4.
	* <tt>"'''\|h'''"</tt> - End of link, text follows		* <tt>"'''\|h'''"</tt> - End of link, text follows
	* <tt>"'''[Broken Fang]'''"</tt> - The actual text displayed		* <tt>"'''[Broken Fang]'''"</tt> - The actual text displayed

WoWWiki>Raylan13 at 03:51, 7 December 2012

2012-12-07T03:51:12Z

← Older revision		Revision as of 03:51, 7 December 2012
Line 2:		Line 2:
	{{wowapitype}}		{{wowapitype}}

	An [[ItemLink]] is a string that can be ~~process~~ by the WoW UI to produce UI item 'link' text for a [[item\|game item]]. [[ItemLink\|ItemLinks]] are [[itemString\|ItemStrings]] with additional formatting to make in-game text controls display them as clickable hyperlinks. ItemLinks are returned various functions, including {{apif\|GetAuctionItemLink}}, {{apif\|GetContainerItemLink}}, {{apif\|GetInventoryItemLink}}.		An [[ItemLink]] is a string that can be processed by the WoW UI to produce UI item 'link' text for a [[item\|game item]]. [[ItemLink\|ItemLinks]] are [[itemString\|ItemStrings]] with additional formatting to make in-game text controls display them as clickable hyperlinks. ItemLinks are returned various functions, including {{apif\|GetAuctionItemLink}}, {{apif\|GetContainerItemLink}}, {{apif\|GetInventoryItemLink}}.

	== Format ==		== Format ==
Line 41:		Line 41:

	"124" is the ascii value of the "\|" character. If you are writing this in a regular .lua file, feel free to go ahead and just use "\|" and "\|\|". However, if you're typing it in an in-game editor, it's better to use the ascii code escape to avoid problems.		"124" is the ascii value of the "\|" character. If you are writing this in a regular .lua file, feel free to go ahead and just use "\|" and "\|\|". However, if you're typing it in an in-game editor, it's better to use the ascii code escape to avoid problems.

			== Simple ingame item look-up ==
			For calling up an item in the game that is not available via shift+left-click (such as something on the AH or in the professions tab), follow these very easy steps:
			*Look up the item on wowhead
			*Click on the "Links" button in the top right of the item page
			*Select the "Ingame link" section (usually already selected); copy the information
			*Enter the game and paste the information into the chat window
			*A clickable link for that item should appear

	== Notes ==		== Notes ==

Bear: /* Components */

2012-09-25T22:34:48Z

Components

← Older revision		Revision as of 22:34, 25 September 2012
Line 1:		Line 1:
	{{DISPLAYTITLE:itemLink}}		{{DISPLAYTITLE:itemLink}}
	{{wowapitype}}		{{wowapitype}}
	'''itemLinks''' are returned by several functions, e.g. [[API GetAuctionItemLink\|GetAuctionItemLink]](), [[API GetContainerItemLink\|GetContainerItemLink]](), [[API GetInventoryItemLink\|GetInventoryItemLink]](), etc.

	~~In essence, they~~ are [[itemString]]s with additional formatting to make in-game text controls display them as clickable hyperlinks.		An [[ItemLink]] is a string that can be process by the WoW UI to produce UI item 'link' text for a [[item\|game item]]. [[ItemLink\|ItemLinks]] are [[itemString\|ItemStrings]] with additional formatting to make in-game text controls display them as clickable hyperlinks. ItemLinks are returned various functions, including {{apif\|GetAuctionItemLink}}, {{apif\|GetContainerItemLink}}, {{apif\|GetInventoryItemLink}}.

	~~\|cff9d9d9d\|Hitem:7073:0:0:0:0:0:0:0:80:0\|h[Broken Fang]\|h\|r~~		== Format ==

	~~Broken up in its components:~~		* <tt>"'''\|cff9d9d9d'''"</tt> - Colorizes the link with a medium grey color (hex color code)

	* <tt>"'''\|cff9d9d9d'''"</tt> ~~–~~ Colorizes the link with a medium grey color (hex color code)
	** The first two characters after pipe-c may be the alpha level, where <code>ff</code> is fully opaque.		** The first two characters after pipe-c may be the alpha level, where <code>ff</code> is fully opaque.
	** The next three sets of two characters represent the red, green, and blue levels, just like HTML.		** The next three sets of two characters represent the red, green, and blue levels, just like HTML.
	* <tt>"'''\|H'''"</tt> ~~– "~~Hyperlink link data starts here"		* <tt>"'''\|H'''"</tt> - Hyperlink link data starts here
	* <tt>"'''item:7073:0:0:0:0:0:0:0:0:0'''"</tt> ~~– Read more at~~ [[itemString]].		* <tt>"'''item:7073:0:0:0:0:0:0:0:0:0:0'''"</tt> - The embedded item string. See [[itemString]]. Changed in 5.0.4.
	* <tt>"'''\|h'''"</tt> ~~– "~~End of link, text follows"		* <tt>"'''\|h'''"</tt> - End of link, text follows
	* <tt>"'''[Broken Fang]'''"</tt> ~~–~~ The actual text displayed		* <tt>"'''[Broken Fang]'''"</tt> - The actual text displayed
	* <tt>"'''\|h'''"</tt> ~~– "~~End of hyperlink"		* <tt>"'''\|h'''"</tt> - End of hyperlink
	* <tt>"'''\|r'''"</tt> ~~–~~ Restores color to normal		* <tt>"'''\|r'''"</tt> - Restores color to normal

	~~You can extract the itemString from a given itemLink with the following function~~:		\|cff9d9d9d\|Hitem:7073:0:0:0:0:0:0:0:80:0:0\|h[Broken Fang]\|h\|r

			== Summary ==

			=== Example ===
	local itemString = string.match(itemLink, "item[%-?%d:]+")		local itemString = string.match(itemLink, "item[%-?%d:]+")
			This example extracts the itemString from a given itemLink using the string.match regex Lua function.

	~~Note: The format of the link is similar for enchant, spell and quest links, with merely the "itemstring" changing. See [[spellString]], [[enchantString]] and [[questString]]~~		== Details ==

	'''To obtain all the data within a hyperlink, you can use the following:'''		'''To obtain all the data within a hyperlink, you can use the following:'''
	local _, _, Color, Ltype, Id, Enchant, Gem1, Gem2, Gem3, Gem4, Suffix, Unique, LinkLvl, Name = string.find(itemLink, "\|?c?f?f?(%x)\|?H?([^:]):?(%d+):?(%d):?(%d):?(%d):?(%d):?(%d):?(%-?%d):?(%-?%d):?(%d)\|?h?%[?([^%[%]]*)%]?\|?h?\|?r?")		local _, _, Color, Ltype, Id, Enchant, Gem1, Gem2, Gem3, Gem4, Suffix, Unique, LinkLvl, Name =
			string.find(itemLink,
			"\|?c?f?f?(%x)\|?H?([^:]):?(%d+):?(%d):?(%d):?(%d):?(%d):?(%d):?(%-?%d):?(%-?%d):?(%d):?(%d):?(%-?%d)\|?h?%[?([^%[%]]*)%]?\|?h?\|?r?")
	Note that this will accept any hyperlink (item/spell/quest/talent/achievement/tradeskill/etc), it will take itemstrings alone, or even just a single number.		Note that this will accept any hyperlink (item/spell/quest/talent/achievement/tradeskill/etc), it will take itemstrings alone, or even just a single number.

	== Printing links for debug ==		=== Printing links for debug ===

	Printing out the contents of an item link is perhaps not so obvious; displaying it anywhere in-game will just show you a clickable link. Reformat it slightly to ruin the [[UI Escape Sequences\|escape sequences]] and you'll see what it really looks like:		Printing out the contents of an item link is perhaps not so obvious; displaying it anywhere in-game will just show you a clickable link. Reformat it slightly to ruin the [[UI Escape Sequences\|escape sequences]] and you'll see what it really looks like:

Line 37:		Line 41:

	"124" is the ascii value of the "\|" character. If you are writing this in a regular .lua file, feel free to go ahead and just use "\|" and "\|\|". However, if you're typing it in an in-game editor, it's better to use the ascii code escape to avoid problems.		"124" is the ascii value of the "\|" character. If you are writing this in a regular .lua file, feel free to go ahead and just use "\|" and "\|\|". However, if you're typing it in an in-game editor, it's better to use the ascii code escape to avoid problems.

			== Notes ==
			* The format of the link is similar for enchant, spell and quest links, with merely the "itemstring" changing. See [[spellString]], [[enchantString]] and [[questString]]
			* Patch 5.0.4 - changed the number of [[itemString]] parameters from 10 to 11

			== See ==
			* [[itemString]]
			* {{apif\|GetContainerItemLink}}
			* [[item\|game item (item)]]
			* [[questString]], [[spellString]], [[enchantString]]

WoWWiki>Siz at 02:51, 28 October 2010

2010-10-28T02:51:58Z

WoWWiki>Farmbuyer: Slightly faster and more precise itemString extraction function call and pattern

2010-07-07T21:07:30Z

Slightly faster and more precise itemString extraction function call and pattern

← Older revision		Revision as of 21:07, 7 July 2010
Line 19:		Line 19:
	* <tt>"'''\|r'''"</tt> – Restores color to normal		* <tt>"'''\|r'''"</tt> – Restores color to normal

	You can extract the itemString from a given itemLink with the following ~~pattern~~:		You can extract the itemString from a given itemLink with the following function:

	local ~~found, _,~~ itemString = string.~~find~~(itemLink, "^\|c%x+\|H(.+)\|h%[~~.*%]~~")		local itemString = string.match(itemLink, "^\|c%x+\|H(item[%d:]+)\|h%[")

	Note: The format of the link is similar for enchant, spell and quest links, with merely the "itemstring" changing. See [[spellString]], [[enchantString]] and [[questString]]		Note: The format of the link is similar for enchant, spell and quest links, with merely the "itemstring" changing. See [[spellString]], [[enchantString]] and [[questString]]

WoWWiki>Starlightblunder: yank first header

2010-06-15T12:01:38Z

yank first header

← Older revision		Revision as of 12:01, 15 June 2010
Line 1:		Line 1:
	{{DISPLAYTITLE:itemLink}}		{{DISPLAYTITLE:itemLink}}
	{{wowapitype}}~~<br>~~		{{wowapitype}}
			'''itemLinks''' are returned by several functions, e.g. [[API GetAuctionItemLink\|GetAuctionItemLink]](), [[API GetContainerItemLink\|GetContainerItemLink]](), [[API GetInventoryItemLink\|GetInventoryItemLink]](), etc.
	~~== itemLink API Type (String) ==~~
	itemLinks are returned by several functions, e.g. [[API GetAuctionItemLink\|GetAuctionItemLink]](), [[API GetContainerItemLink\|GetContainerItemLink]](), [[API GetInventoryItemLink\|GetInventoryItemLink]](), etc.

	In essence, they are [[itemString]]s with additional formatting to make in-game text controls display them as clickable hyperlinks.		In essence, they are [[itemString]]s with additional formatting to make in-game text controls display them as clickable hyperlinks.

WoWWiki>ShandrisForever: /* itemLink API Type (String) */

2009-12-03T14:24:17Z

itemLink API Type (String)

← Older revision		Revision as of 14:24, 3 December 2009
Line 11:		Line 11:
	Broken up in its components:		Broken up in its components:

	* <tt>"'''\|cff9d9d9d'''"</tt> – Colorizes the link with a medium grey color (~~Broken Fang is vendortrash~~)		* <tt>"'''\|cff9d9d9d'''"</tt> – Colorizes the link with a medium grey color (hex color code)
	** The first two characters after pipe-c may be the alpha level, where <code>ff</code> is fully opaque.		** The first two characters after pipe-c may be the alpha level, where <code>ff</code> is fully opaque.
	** The next three sets of two characters represent the red, green, and blue levels, just like HTML.		** The next three sets of two characters represent the red, green, and blue levels, just like HTML.

WoWWiki>Nathanmx: /* itemLink API Type (String) */

2009-08-11T04:27:36Z

itemLink API Type (String)

← Older revision		Revision as of 04:27, 11 August 2009
Line 26:		Line 26:

	Note: The format of the link is similar for enchant, spell and quest links, with merely the "itemstring" changing. See [[spellString]], [[enchantString]] and [[questString]]		Note: The format of the link is similar for enchant, spell and quest links, with merely the "itemstring" changing. See [[spellString]], [[enchantString]] and [[questString]]

			'''To obtain all the data within a hyperlink, you can use the following:'''
			local _, _, Color, Ltype, Id, Enchant, Gem1, Gem2, Gem3, Gem4, Suffix, Unique, LinkLvl, Name = string.find(itemLink, "\|?c?f?f?(%x)\|?H?([^:]):?(%d+):?(%d):?(%d):?(%d):?(%d):?(%d):?(%-?%d):?(%-?%d):?(%d)\|?h?%[?([^%[%]]*)%]?\|?h?\|?r?")
			Note that this will accept any hyperlink (item/spell/quest/talent/achievement/tradeskill/etc), it will take itemstrings alone, or even just a single number.

	== Printing links for debug ==		== Printing links for debug ==

← Older revision		Revision as of 02:51, 28 October 2010
Line 5:		Line 5:
	In essence, they are [[itemString]]s with additional formatting to make in-game text controls display them as clickable hyperlinks.		In essence, they are [[itemString]]s with additional formatting to make in-game text controls display them as clickable hyperlinks.

	\|cff9d9d9d\|Hitem:7073:0:0:0:0:0:0:0\|h[Broken Fang]\|h\|r		\|cff9d9d9d\|Hitem:7073:0:0:0:0:0:0:0:80:0\|h[Broken Fang]\|h\|r

	Broken up in its components:		Broken up in its components:
Line 13:		Line 13:
	** The next three sets of two characters represent the red, green, and blue levels, just like HTML.		** The next three sets of two characters represent the red, green, and blue levels, just like HTML.
	* <tt>"'''\|H'''"</tt> – "Hyperlink link data starts here"		* <tt>"'''\|H'''"</tt> – "Hyperlink link data starts here"
	* <tt>"'''item:7073:0:0:0:0:0:0:0'''"</tt> – Read more at [[itemString]].		* <tt>"'''item:7073:0:0:0:0:0:0:0:0:0'''"</tt> – Read more at [[itemString]].
	* <tt>"'''\|h'''"</tt> – "End of link, text follows"		* <tt>"'''\|h'''"</tt> – "End of link, text follows"
	* <tt>"'''[Broken Fang]'''"</tt> – The actual text displayed		* <tt>"'''[Broken Fang]'''"</tt> – The actual text displayed
Line 21:		Line 21:
	You can extract the itemString from a given itemLink with the following function:		You can extract the itemString from a given itemLink with the following function:

	local itemString = string.match(itemLink, "~~^\|c%x+\|H(~~item[%d:]+~~)\|h%[~~")		local itemString = string.match(itemLink, "item[%-?%d:]+")

	Note: The format of the link is similar for enchant, spell and quest links, with merely the "itemstring" changing. See [[spellString]], [[enchantString]] and [[questString]]		Note: The format of the link is similar for enchant, spell and quest links, with merely the "itemstring" changing. See [[spellString]], [[enchantString]] and [[questString]]