WoW:API SetItemRef: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
<center>'''SetItemRef''' ''-Documentation by [[user:Deathshadow|Deathshadow]]-''</center>
<center>'''SetItemRef''' ''-Documentation by [[user:Deathshadow|Deathshadow]]-''</center>


Displays an item information box from a specified link.
Handles Links in Chat, orginally just Itemlinks but now also handles PlayerLinks.
 
  SetItemRef(link, text, button);
  SetItemRef(itemLink);


== Parameters ==
== Parameters ==
=== Arguments ===
=== Arguments ===
:itemLink
:;link : String - Link to Use, (eg 'item:3577:0:0:276308480' is a [Gold Bar], 'player:Kaso' is [Kaso]).
:;itemLink : String - itemLink is the item id (eg 'item:3577:0:0:276308480' is a [Gold Bar]).
:;text : String - The Text of the link, including Text Colour Infomation and itemlinks (eg The previous two examples :
:::'|cff1eff00|Hitem:3577:0:0:276308480|h[Gold Bar]|h|r'
:::'|Hplayer:Kaso|h[Kaso]|h'
 
:;button : String - The button used to click the notes 'LeftButton' or 'RightButton' Apparently, See Notes.


=== Returns ===
=== Returns ===
:;''Returns nil''
:;''Returns nil''


<br><center><i>Last updated: Patch 1.6.1</i></center>
== Notes ==
:This function is affected by ShiftKey, Ctrl Key and Depending On button Variable as shown in the following table:
 
<TABLE FRAME=BOX CELLSPACING=0 COLS=7 RULES=GROUPS BORDER=1>
<TR>
<TD WIDTH=86 HEIGHT=18 ALIGN=CENTER><BR></TD>
<TD COLSPAN=2 WIDTH=393 ALIGN=CENTER>Ctrl Key</TD>
<TD COLSPAN=2 WIDTH=237 ALIGN=CENTER>Shift Key</TD>
<TD COLSPAN=2 WIDTH=312 ALIGN=CENTER>None</TD>
</TR>
<TR>
<TD HEIGHT=17 ALIGN=CENTER><BR></TD>
<TD ALIGN=CENTER>Left Button</TD>
<TD ALIGN=CENTER>Right Button</TD>
<TD ALIGN=CENTER>Left Button</TD>
<TD ALIGN=CENTER>Right Button</TD>
<TD ALIGN=CENTER>Left Button</TD>
<TD ALIGN=CENTER>Right Button</TD>
</TR>
<TR>
<TD HEIGHT=18 ALIGN=CENTER>Player Link</TD>
<TD ALIGN=CENTER>#</TD>
<TD ALIGN=CENTER>#</TD>
<TD ALIGN=CENTER>Send Player /who</TD>
<TD ALIGN=CENTER>Send Player /who</TD>
<TD ALIGN=CENTER>Open Tell</TD>
<TD ALIGN=CENTER>Open Drop Down Tooltip</TD>
</TR>
<TR>
<TD HEIGHT=18 ALIGN=CENTER>Item Link</TD>
<TD ALIGN=CENTER>Show Dressing Room For Item</TD>
<TD ALIGN=CENTER>Show Dressing Room For Item</TD>
<TD ALIGN=CENTER>Link Item in Chat</TD>
<TD ALIGN=CENTER>Link Item in Chat</TD>
<TD ALIGN=CENTER>Show ItemRefToolTip</TD>
<TD ALIGN=CENTER>Show ItemRefToolTip</TD>
</TR>
</TABLE>
 
<br><center><i>Last updated: Patch 1.10.1</i></center>
----
----
__NOTOC__
__NOTOC__
{{Template:WoW API}}
{{Template:WoW API}}

Revision as of 15:09, 19 April 2006

SetItemRef -Documentation by Deathshadow-

Handles Links in Chat, orginally just Itemlinks but now also handles PlayerLinks.

SetItemRef(link, text, button);

Parameters

Arguments

link
String - Link to Use, (eg 'item:3577:0:0:276308480' is a [Gold Bar], 'player:Kaso' is [Kaso]).
text
String - The Text of the link, including Text Colour Infomation and itemlinks (eg The previous two examples :
'|cff1eff00|Hitem:3577:0:0:276308480|h[Gold Bar]|h|r'
'|Hplayer:Kaso|h[Kaso]|h'
button
String - The button used to click the notes 'LeftButton' or 'RightButton' Apparently, See Notes.

Returns

Returns nil

Notes

This function is affected by ShiftKey, Ctrl Key and Depending On button Variable as shown in the following table:

Ctrl Key Shift Key None

Left Button Right Button Left Button Right Button Left Button Right Button
Player Link # # Send Player /who Send Player /who Open Tell Open Drop Down Tooltip
Item Link Show Dressing Room For Item Show Dressing Room For Item Link Item in Chat Link Item in Chat Show ItemRefToolTip Show ItemRefToolTip


Last updated: Patch 1.10.1

Template:WoW API