WoW:API GameTooltip SetHyperlink: Difference between revisions

WoW:API GameTooltip SetHyperlink (source)

Revision as of 11:49, 6 May 2007

139 bytes removed , 6 May 2007

m

another "better fit the boilerplate" change

Anonymous user

WoWWiki>Luke1410

@@ Line 1: / Line 1: @@
-{{widgetmethod}}
+{{widgetmethod}} __NOTOC__
-== Syntax ==
+Changes the item which is displayed in the tooltip according to the passed argument.
-  SetHyperlink(frame, link);
+  GameTooltip:SetHyperlink("itemString" or "itemLink")
--or-
- frame:SetHyperlink(link);
+== Arguments ==
+:("itemString" or "itemLink")
+:;"itemString" - [[itemString]] - Representing an in-game 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".
+:;"itemLink" - [[itemLink]] - A clickable string of an in-game item.
+== Returns ==
+:; nil
-== Parameters ==
+== Example ==
+ GameTooltip:SetHyperlink("item:16846:0:0:0:0:0:0:0")
-=== Arguments ===
+<big>'''Result'''</big>
+:This will replace the currently showing tooltip with one containing the information for the Giantstalker Helm.
-:; 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.
+== Details ==
 : Calling this function with the same link which is currently shown, will close the Tooltip.
@@ Line 34: / Line 28: @@
 : 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");
--or-
- ItemRefTooltip: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.