WoW:API GetMerchantItemInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(→‎Returns: explain quantity better)
Line 9: Line 9:
:;name : String - The name of the item
:;name : String - The name of the item
:;texture : String - The texture that represents the item's icon
:;texture : String - The texture that represents the item's icon
:;price : Number - The price of the item (in copper)
:;price : Number - The price of the item (in copper).  Note that if quantity is greater than one (i.e. the item is sold in batches by default), then this is the price per batch, not the unit price.
:;quantity : Number - The quantity that will be purchased (the ''batch size'', e.g. 5 for vials)
:;quantity : Number - The quantity that will be purchased (the ''batch size'', e.g. 5 for vials)
:;numAvailable : Number - The number of this item that the merchant has in stock. -1 for unlimited stock.
:;numAvailable : Number - The number of this item that the merchant has in stock. -1 for unlimited stock.

Revision as of 20:14, 14 April 2011

WoW API < GetMerchantItemInfo

Returns information about a merchant's item.

name, texture, price, quantity, numAvailable, isUsable, extendedCost = GetMerchantItemInfo(index)

Parameters

Arguments

index
Number - The index of the item in the merchant's inventory

Returns

name
String - The name of the item
texture
String - The texture that represents the item's icon
price
Number - The price of the item (in copper). Note that if quantity is greater than one (i.e. the item is sold in batches by default), then this is the price per batch, not the unit price.
quantity
Number - The quantity that will be purchased (the batch size, e.g. 5 for vials)
numAvailable
Number - The number of this item that the merchant has in stock. -1 for unlimited stock.
isUsable
Number - Is 1 if the player can use this item, nil otherwise
extendedCost
Number - Is 1 if the item has extended (PvP) cost info, nil otherwise

Example

local name, texture, price, quantity, numAvailable, isUsable, extendedCost = GetMerchantItemInfo(4);
message(name .. " " .. price .. "c");

Result

A message stating the name and price of the item in merchant slot 4 appears.

See also