Difference between revisions of "ItemLink"

From Wowpedia
Jump to: navigation, search
Tag: WoW API docs
(→‎Examples: comment ood example)
Tag: WoW API docs
Line 336: Line 336:
 
;<code>"item:4388:::::::210677200:80:105::::::"</code>
 
;<code>"item:4388:::::::210677200:80:105::::::"</code>
 
: The first number is the ItemID for [[Discombobulator Ray]]. The eighth number adds the information that this particular item only has 4 uses left and was made by Kirov.
 
: The first number is the ItemID for [[Discombobulator Ray]]. The eighth number adds the information that this particular item only has 4 uses left and was made by Kirov.
  +
<!--
 
;<code>"item:28484:1503::2946:2945::::80:105::::::"</code>
 
;<code>"item:28484:1503::2946:2945::::80:105::::::"</code>
 
: The first number is the ItemID for [[Bulwark of Kings]]. The second number ([[enchantId]]) is that of +100 HP. The third number denotes an empty blue jewel socket while the fourth and fifth numbers represent yellow jewel sockets occupied by a [[Inscribed Ornate Topaz]] and a [[Bold Ornate Ruby]] respectively. Jewel sockets can also take normal enchantID's. Bulwark of Kings has a socket bonus, but this is not represented within the itemString.
 
: The first number is the ItemID for [[Bulwark of Kings]]. The second number ([[enchantId]]) is that of +100 HP. The third number denotes an empty blue jewel socket while the fourth and fifth numbers represent yellow jewel sockets occupied by a [[Inscribed Ornate Topaz]] and a [[Bold Ornate Ruby]] respectively. Jewel sockets can also take normal enchantID's. Bulwark of Kings has a socket bonus, but this is not represented within the itemString.
  +
-->
   
 
===Artifacts===
 
===Artifacts===

Revision as of 03:05, 17 May 2021

For the data previously at "ItemLink", see ItemLink/Archive.

Item hyperlinks are used to encode information for item tooltips and to pass item information between clients.

Format

item : itemID : enchantID : gemID1 : gemID2 : gemID3 : gemID4 : suffixID : uniqueID : linkLevel : specializationID : modifiersMask : context : numBonusIDs[:bonusID1:bonusID2:...] : numModifiers[:modifierType1:modifierValue1:...] : relic1NumBonusIDs[:relicBonusID1:relicBonusID2:...] : relic2NumBonusIDs[:...] : relic3NumBonusIDs[:...] : unk
itemID 
Item ID used for e.g. GetItemInfo()
enchantID # 
Permanent enchants.
gemID1, gemID2, gemID3, gemID4 # 
Item IDs of socketed gems. gemID4 is unused.
suffixID # 
Random item suffix e.g. "of the Owl".
uniqueID # 
Data pertaining to a specific instance of the item.
linkLevel 
Level of the character supplying the link. This is used to render scaling heirloom item tooltips at the proper level.
specializationID 
Class SpecializationID of the character supplying the link. This is used to display the appropriate primary stat and set bonuses on gear.
modifiersMask 
Seems to be always empty.
context
Usually refers to the instance DifficultyID.
numModifiers # 
The number of item modifiers.
modifierType1, modifierValue1, ... 
Key/Value pairs for item modifiers.
numBonusIDs # 
The number of bonusIDs.
bonusID1, bonusID2, ... 
Data describing how the item differs from a generic instance of its base Item ID. See below for more info.
relic1NumBonusIDs, ... 
The number of bonusIDs for the socketed artifact relic.
relic1BonusID1, relic1BonusID2, ...
Data describing how the socketed artifact relic differs from a generic instance of its base Item ID.
unk 
Undocumented.

Details

Enchant IDs

See list of EnchantIds and SpellItemEnchantment.db2

  • ItemLinks can be altered to have any enchantID or any bonus stats and still be valid for use in SendChatMessage() and tooltips.
  • Temporary enchants like [Windfury Weapon] and  [Rough Sharpening Stone] do not appear in the ItemLink, even though they are listed in SpellItemEnchantment.db2

Example: Item enchanted with  [Minor Stamina]:

"|cff0070dd|Hitem:80921:4721:::::::36:103::1::::::|h[Saboteur's Stabilizing Bracers]|h|r"

Gem IDs

Gems are listed by itemID for each socket.

Example:  [Helm of Elemental Binding] socketed with  [Perfect Brilliant Bloodstone] for only the 2nd gem slot.

"|cff0070dd|Hitem:87451:::41438:::::53:257:::1:6658:2:9:35:28:1035::::|h[Helm of Elemental Binding]|h|r"
4: 41438

Suffix IDs

Item suffixes are given to items that get randomized stat ratings e.g. "of the Bear" and refer to (multiple) enchantIDs.

Example: Suffix with a positive ID from Burning Crusade Classic, obtained during Classic:

"|cff1eff00|Hitem:9849::::::776:661453184:33::::::::|h[Conjurer's Hood of the Owl]|h|r"

Example: Post-2.0 suffix with a negative ID from Burning Crusade Classic:

"|cff1eff00|Hitem:6267::::::-9:1379794946:33::::::::|h[Disciple's Pants of the Owl]|h|r"

Unique IDs

UniqueId contains information on the maker of a crafted item, number of charges or uses if applicable, or other information exclusive to one particular manifestation of an item. Items received from quests frequently have a UniqueId value, and occasionally dropped items have one as well. The numbers don't appear to hold any information in and of themselves, and are not consistent in any way across servers like EnchantIds and SecondaryIds. The value appears to be a link to a database entry on the server or client that contains the unique information such as who made an item, which quest it came from, when the quest was delivered, who sold the item on the Auction House, etc. GMs would then be able to track an item should a petition about one be made. UniqueID can have negative values (see Scaled Random Suffixes below).

Addendum: In-game testing indicates that the UniqueId can change from the first loot to successive loots on the same item. To observe this behavior, Master Looter method was used, an item meeting the loot threshold found, and then the loot window closed without giving the item to a raid member. On re-opening the corpse, the value had changed. For example, on the first loot of Shimmering Trousers of the Eagle, the UniqueId value was 0x00009182. On successive loot attempts it was 0x40679182. Note that the low order bytes were maintained. In at least a few observations, negative UniqueId values did not change in successive looting attempts.

UniqueIds can be repeated (and thus are not truly "unique"). This has been observed when disenchanting items, where the UniqueId was the same for every  [Maelstrom Crystal] "created" by the same player sharding raid loot. Another observed example is a less common occurrence: looting the  [Elementium Gem Cluster] for the rogue legendary daggers quest; the UniqueId field was the same (-534608128) for every gem cluster from every boss across multiple months of raid instance IDs. (It's not known whether the value would be the same for all rogues on that quest, or whether it was a value specific to this rogue on this quest.)

On negative UniqueID's: A negative UniqueID is not special in any way. It seems that (sometimes!) the high 16 bits are simply "random", i.e. 0x0000-0xffff. If this value is >0x8000, it will translate to a negative decimal value (signed 32-bit).

Modifier Types

ID Type Description
0 TRANSMOG_APPEARANCE_ALL_SPECS
1 TRANSMOG_APPEARANCE_SPEC_1
2 UPGRADE_ID
3 BATTLE_PET_SPECIES_ID BattlePetSpeciesID
4 BATTLE_PET_BREED_DATA
5 BATTLE_PET_LEVEL
6 BATTLE_PET_DISPLAY_ID
7 ENCHANT_ILLUSION_ALL_SPECS
8 ARTIFACT_APPEARANCE_ID ArtifactAppearanceID
9 TIMEWALKER_LEVEL
10 ENCHANT_ILLUSION_SPEC_1
11 TRANSMOG_APPEARANCE_SPEC_2
12 ENCHANT_ILLUSION_SPEC_2
13 TRANSMOG_APPEARANCE_SPEC_3
14 ENCHANT_ILLUSION_SPEC_3
15 TRANSMOG_APPEARANCE_SPEC_4
16 ENCHANT_ILLUSION_SPEC_4
17 CHALLENGE_MAP_CHALLENGE_MODE_ID MapChallengeMode.db2
18 CHALLENGE_KEYSTONE_LEVEL
19 CHALLENGE_KEYSTONE_AFFIX_ID_1 KeystoneAffix.db2
20 CHALLENGE_KEYSTONE_AFFIX_ID_2
21 CHALLENGE_KEYSTONE_AFFIX_ID_3
22 CHALLENGE_KEYSTONE_AFFIX_ID_4
23 ARTIFACT_KNOWLEDGE_LEVEL
24 ARTIFACT_TIER
25 TRANSMOG_APPEARANCE_SPEC_5
26 PVP_RATING
27 ENCHANT_ILLUSION_SPEC_5
28 CONTENT_TUNING_ID ContentTuning.db2
29 CHANGE_MODIFIED_CRAFTING_STAT_1
30 CHANGE_MODIFIED_CRAFTING_STAT_2
31 TRANSMOG_SECONDARY_APPEARANCE_ALL_SPECS
32 TRANSMOG_SECONDARY_APPEARANCE_SPEC_1
33 TRANSMOG_SECONDARY_APPEARANCE_SPEC_2
34 TRANSMOG_SECONDARY_APPEARANCE_SPEC_3
35 TRANSMOG_SECONDARY_APPEARANCE_SPEC_4
36 TRANSMOG_SECONDARY_APPEARANCE_SPEC_5
37 SOULBIND_CONDUIT_RANK

Example:  [Missing Diplomat's Pauldrons] from Heroic Deadmines

"|cff0070dd|Hitem:63470::::::::53:257::2:1:4198:2:28:1199:9:35::::|h[Missing Diplomat's Pauldrons]|h|r"
15: 2    -- numModifiers
16: 28   -- modifierType1 (CONTENT_TUNING_ID)
17: 1199 -- modifierValue1
18: 9    -- modifierType2 (TIMEWALKER_LEVEL)
19: 35   -- modifierValue2

Bonus IDs

They can be used for storing random suffixes (e.g. "of the Fireflash"), random bonuses (e.g. bonusID 40 is +Avoidance), raid types (see below), dungeon typing, random quest upgrades (see below for epic/rare), crafting upgrades (e.g. bonusID 526 is "Expert") and others. BonusIDs can adjust item levels, modify stats, change item quality, add item titles, append words to item names, add sockets, adjust appearance, adjust required equip level, and possibly many more.

Some examples of bonusIDs:

  • 448 - Warforged, +6 itemlevel
  • 449 - Heroic, +13 itemlevel
  • 450 - Mythic, +26 itemlevel
  • 451 - LFR, -12 itemlevel
  • 15 - Epic, +10 itemlevel
  • 171 - Rare, +5 itemlevel

Example: Level 86 / Item level 140  [Heart of Azeroth]

"|cffe6cc80|Hitem:158075::::::::53:257::11:4:4932:4933:6316:1554:::::|h[Heart of Azeroth]|h|r"
13: 4    -- numBonusIDs
14: 4932 -- bonusID1
15: 4933 -- bonusID2
16: 6316 -- bonusID3
17: 1554 -- bonusID4

Plain links

ItemLinks obtained from the Void Storage will give a generic GetItemInfo() link which only contain the itemID, linkLevel and specializationID since all modifications will have been removed.

Examples

"item:6948::::::::80:105::::::"
The first number is the ItemID for a  [Hearthstone]. The next 7 values are empty, which tells the client it has no enchants, gems, extra stats, and wasn't made by anyone. The 9th number, 80, means that the link applies to level 80 characters.
"item:18832:2564:::::::80:105::::::"
The first number is the ItemID for  [Brutality Blade]. The second number (enchantId) in this case denotes that it is enchanted with +15 agility.
"item:10242::::::614::80:105::::::"
The first number is the ItemID for  [Heavy Lamellar Gauntlets]. The seventh number (suffixId) adds to this item's name " of the Monkey" and adds +11 Agility and +11 Stamina.
"item:4388:::::::210677200:80:105::::::"
The first number is the ItemID for  [Discombobulator Ray]. The eighth number adds the information that this particular item only has 4 uses left and was made by Kirov.

Artifacts

For the Holy Priest Artifact  [T'uure, Beacon of the Naaru]

"|cffe6cc80|Hitem:128825::140844:140839:152044::::53:257::9:2:739:1522:2:8:749:24:1:3:3520:1472:3337:3:3520:1472:3337:3:3610:1472:3528:|h[T'uure, Beacon of the Naaru]|h|r"
 0: "item"
 1: 128825 -- itemID
 2:        -- enchantID
 3: 140844 -- gemID1 (Archaic Nathrezim Keepsake)
 4: 140839 -- gemID2 (Parasitic Spore)
 5: 152044 -- gemID3 (Spark of Everburning Light)
 6:        -- gemID4
 7:        -- suffixID
 8:        -- uniqueID
 9: 53 	   -- linkLevel
10: 257    -- specializationID (Holy)
11:        -- modifiersMask 
12: 9      -- context
13: 2 	   -- numBonusIDs
14: 739    -- bonusID1
15: 1522   -- bonusID2
16: 2      -- numModifiers
17: 8      -- modifierType1 (ITEM_MODIFIER_ARTIFACT_APPEARANCE_ID)
18: 749    -- modifierValue1 (ArtifactAppearanceID)
19: 24     -- modifierType2 (ITEM_MODIFIER_ARTIFACT_TIER)
20: 1      -- modifierValue2
21: 3      -- relic1NumBonusIDs
22: 3520   -- relic1BonusID1
23: 1472   -- relic1BonusID2
24: 3337   -- relic1BonusID3
25: 3      -- relic2NumBonusIDs
26: 3520   -- relic2BonusID1
27: 1472   -- relic2BonusID2
28: 3337   -- relic2BonusID3
29: 3      -- relic3NumBonusIDs
30: 3610   -- relic3BonusID1
31: 1472   -- relic3BonusID2
32: 3528   -- relic3BonusID3
33:

Inspecting

You can inspect a hyperlink from the in-game chat window

/dump "[Red Winter Hat]"
> "|cff1eff00|Hitem:21524::::::::53:257::::::::|h[Red Winter Hat]|h|r"

From an addon, when clicking a hyperlink in-game

hooksecurefunc("SetItemRef", function(link, text)
	print(text:gsub("|", "||"))
	for k, v in pairs({strsplit(":", link)}) do
		if #v > 0 then
			print(k-1, v)
		end
	end
end)
"|cff1eff00|Hitem:21524::::::::53:257::::::::|h[Red Winter Hat]|h|r"
0, "item"
1, "21524"
9, "53"
10, "257

Patch changes

Lone 0's in item strings have been removed so something like ":0:0:0:" has become "::::". 3 new segments have also been added to the end of the item string but their use is unknown at this time.