WoW:API ChatFrame OnHyperlinkShow: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(3.0 minor change)
m (Move page script moved page API ChatFrame OnHyperlinkShow to API ChatFrame OnHyperlinkShow without leaving a redirect)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{framexmlfunc|FrameXML/ChatFrame.lua}} __NOTOC__
{{framexmlfunc|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).
This function is called when a user clicks on a link in the chatframe (i.e. on an itemlink).
ChatFrame_OnHyperlinkShow(chatFrame, link, text, button)


 
== Arguments ==
== Parameters ==
;chatFrame : table (Frame) - ChatFrame in which the link was clicked.
=== Arguments ===
;link : String - The link component of the clicked hyperlink. (e.g. "item:6948:0:0:0...")
:(reference, link, linktext, mousebutton)
;text : String - The label component of the clicked hyperlink. (e.g. "[Hearthstone]")
 
;button : String - Button clicking the hyperlink button. (e.g. "LeftButton")
:;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"
 
==update for 3.0==
the format is now
ChatFrame_OnHyperlinkShow(self, link, text, button)
 
=== Returns ===
:;nil

Latest revision as of 04:45, 15 August 2023

← WoW API < ChatFrame:OnHyperlinkShow

"I" iconThis function is implemented in Lua here FrameXML/ChatFrame.lua.

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

ChatFrame_OnHyperlinkShow(chatFrame, link, text, button)

Arguments[edit]

chatFrame
table (Frame) - ChatFrame in which the link was clicked.
link
String - The link component of the clicked hyperlink. (e.g. "item:6948:0:0:0...")
text
String - The label component of the clicked hyperlink. (e.g. "[Hearthstone]")
button
String - Button clicking the hyperlink button. (e.g. "LeftButton")
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_ChatFrame_OnHyperlinkShow&oldid=18649"