WoW:API GameTooltip SetHyperlink: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
(Updated example itemStrings to have 8 fields for WoW 2.0)
Line 12: Line 12:


:; [[itemString]] : string - a string representing an ingame item or enchant. For instance:
:; [[itemString]] : string - a string representing an ingame item or enchant. For instance:
::: "item:16846:0:0:0" is the link id for the "Giantstalker's Helm".
::: "item:16846:0:0:0:0:0:0:0" is the link id for the "Giantstalker's Helm".
::: "enchant:23804" is the link id for "Enchant Weapon - Mighty Intellect".
::: "enchant:23804" is the link id for "Enchant Weapon - Mighty Intellect".


Line 29: Line 29:
== Example ==
== Example ==


  GameTooltip:SetHyperlink("item:16846:0:0:0");
  GameTooltip:SetHyperlink("item:16846:0:0:0:0:0:0:0");


=== Result ===
=== Result ===


:this will replace the currently showing tooltip with one containing the information for the Giantstalker Helm
:this will replace the currently showing tooltip with one containing the information for the Giantstalker Helm

Revision as of 08:19, 7 January 2007

Widget API ← GameTooltip < SetHyperlink

Syntax

SetHyperlink( link );


Parameters

Arguments

itemString
string - a string representing an ingame item or enchant. For instance:
"item:16846:0:0:0:0:0:0:0" is the link id for the "Giantstalker's Helm".
"enchant:23804" is the link id for "Enchant Weapon - Mighty Intellect".

Returns

unknown, probably nil

Remarks

Calling this function with the same link which is currently shown, will close the Tooltip.
If you attempt to reference an item that is not in your local cache, i.e. you've never seen it before, the client will query the server for information about that item. If that particular item has not been seen since last server restart, the server will disconnect the client.
Calling this function with an enchant id that does not exist, will give the error message "Unknown link type".

Example

GameTooltip:SetHyperlink("item:16846:0:0:0:0:0:0:0");

Result

this will replace the currently showing tooltip with one containing the information for the Giantstalker Helm