Widget API: GameTooltip:SetHyperlink

From AddOn Studio
Revision as of 13:47, 12 April 2007 by WoWWiki>Luke1410 (second argument can also be an itemLink)
Jump to navigation Jump to search

Widget API ← GameTooltip < SetHyperlink

Syntax

SetHyperlink(frame, link);


Parameters

Arguments

frame
frame object, of which the hyperlink should be set
link
itemString - 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".
or itemLink - a clickable string of an ingame item.

Returns

nil

Remarks

Calling this function with a non-table variable as first argument, will do nothing.
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(ItemRefTooltip, "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.