WoW:API ChatFrame OnHyperlinkShow: Difference between revisions

Revision as of 07:11, 26 November 2008

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

This function is implemented in Lua here FrameXML/ChatFrame.lua.

ChatFrame_OnHyperlinkShow(reference, link, linktext, mousebutton)

This function is called when a user clicks on a link in the chatframe (i.e. on an itemlink).

(reference, link, linktext, mousebutton)

reference: table - no current known example - unknown contents
link: String - a 3 part value. Possible format: "AddOnName_OR_UnitType|LinkText|SomeIDInteger" - For example "myAddon|add|1" where "myAddon" is the addon that received the message, "add" is the link text, and unsure what the number "1" is. Have seen examples of formats "unit|playername|SomeIDInteger" for example "player|jackelmyer|1111". Note 1111 wasn't the actual value but it was 4 digits.
linktext: String - the visual text value of the link - For example "MyLinksText" where "MyLinkText" is the value displayed in the chatframe
mousebutton: String - the mousebutton which was pressed - For example "LeftButton"

@@ Line 2: / Line 2: @@
-  ChatFrame_OnHyperlinkShow(reference, link, button)
+  ChatFrame_OnHyperlinkShow(reference, link, linktext, mousebutton)
 This function is called when a user clicks on a link in the chatframe (i.e. on an itemlink).
@@ Line 9: / Line 9: @@
 == Parameters ==
 === Arguments ===
-:(reference, link, button)
+:(reference, link, linktext, mousebutton)
-:;itemString : String - the [[itemString]] -  For example: "item:14344:0:0:0"
+:;reference : table - no current known example - unknown contents
-:;link : String - the complete [[itemLink]] - For exmaple: "|cff0070dd|Hitem:14344:0:0:0|h[itemname]|h|r
+:;link : String - a 3 part value.  Possible format:  "AddOnName_OR_UnitType|LinkText|SomeIDInteger" - For example "myAddon|add|1" where "myAddon" is the addon that received the message, "add" is the link text, and unsure what the number "1" is.  Have seen examples of formats "unit|playername|SomeIDInteger" for example "player|jackelmyer|1111".  Note 1111 wasn't the actual value but it was 4 digits.
-:;button : String - the mousebutton which was pressed - For exmaple "LeftButton"
+:;linktext : String - the visual text value of the link - For example "MyLinksText" where "MyLinkText" is the value displayed in the chatframe
+:;mousebutton : String - the mousebutton which was pressed - For example "LeftButton"
 === Returns ===
 :;nil