WoW:API GetCraftReagentItemLink: Difference between revisions

Revision as of 11:30, 28 September 2006

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

This command returns a required reagent (as an itemLink) for a specific craftable item from the currently visible tradeskill window.

reagentLink = GetCraftReagentItemLink(index, n)

(index, n)

index: Numeric - index of the requested craft receipt, where 1 is the top-most listed receipt.
n: Numeric - index of the Nth reagent for the receipt, where 1 is the first reagent.

@@ Line 1: / Line 1: @@
-This command returns a string, which is an item link.
+{{wowapi}} __NOTOC__
+This command returns a required reagent (as an [[itemLink]]) for a specific craftable item from the currently visible tradeskill window.
-  reagentLink = GetCraftReagentItemLink(index, n);
+  reagentLink = GetCraftReagentItemLink(index, n)
 == Parameters ==
 === Arguments ===
-:;index : Numeric - starting at 1 going down to X number of possible crafts, where 1 is the top-most listed craft.
+:(index, n)
-:;n : Numeric - starting at 1 to X, where X is the total number of reagents said craft requires.
+:;index : Numeric - index of the requested craft receipt, where 1 is the top-most listed receipt.
+:;n : Numeric - index of the Nth reagent for the receipt, where 1 is the first reagent.
 === Returns ===
-:;reagentLink : String. Item link.
+:;reagentLink : String - [[itemLink]] for the requested reagent.
 == Details ==
+* If you specify an invalid index, nil is returned.
+* If there is no visible tradeskill window, nil is returned.
-----
+[[Category:World of Warcraft API]]
-__NOTOC__
-{{WoW API}}