WoW:API GetMerchantItemCostItem: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(added 3rd return val to main chunj of article)
(elaborate on the itemIndex parameter)
Line 8: Line 8:


:;index : Number - The index of the item in the merchant's inventory
:;index : Number - The index of the item in the merchant's inventory
:;itemIndex : Number - The index for the required item type
:;itemIndex : Number - The index for the required item cost type.




Line 19: Line 19:


==Details==
==Details==
<!-- Details not appropriate for the main description can go here.  
itemIndex counts into the number of different "alternate currency" tokens required to buy the item under consideration.  For example, looking at the 25-player Tier 9 vendor, a chestpiece costs 75 Emblems of Triumph and 1 Trophy of the Crusade. This function would be called with arguments (N,1) to retrieve information about the Emblems and (N,2) to retrieve information about the Trophy, where N is the index of the chestpiece in the merchant window.
    REMOVE the section if you're just going to restate the intro line! -->


itemIndex should never be larger than the itemCount returned by [[API GetMerchantItemCostInfo|GetMerchantItemCostInfo]]
Most vendor items only use a single type of alternate currency token, so itemIndex will typically be 1.
 
itemIndex should never be larger than the itemCount returned by [[API GetMerchantItemCostInfo|GetMerchantItemCostInfo]].

Revision as of 01:24, 21 October 2009

WoW API < GetMerchantItemCostItem

itemTexture, itemValue, itemLink = GetMerchantItemCostItem(index, itemIndex)

Parameters

Arguments

index
Number - The index of the item in the merchant's inventory
itemIndex
Number - The index for the required item cost type.


Returns

itemTexture
String - The texture that represents the item's icon
itemValue
Number - The number of that item required
itemLink
String - An itemLink for the cost item.

Details

itemIndex counts into the number of different "alternate currency" tokens required to buy the item under consideration. For example, looking at the 25-player Tier 9 vendor, a chestpiece costs 75 Emblems of Triumph and 1 Trophy of the Crusade. This function would be called with arguments (N,1) to retrieve information about the Emblems and (N,2) to retrieve information about the Trophy, where N is the index of the chestpiece in the merchant window.

Most vendor items only use a single type of alternate currency token, so itemIndex will typically be 1.

itemIndex should never be larger than the itemCount returned by GetMerchantItemCostInfo.