WoW:API GetAuctionItemInfo: Difference between revisions

Updated return values
(saleStatus return value added)
(Updated return values)
Line 1: Line 1:
{{wowapi}} __NOTOC__
{{wowapi}} __NOTOC__
Retrieves info about one item in the current retrieved list of items from the Auction House.
Retrieves info about one item in the current retrieved list of items from the Auction House.
  name, texture, count, quality, canUse, level,  
  name, texture, count, quality, canUse, level, levelColHeader, minBid, minIncrement, buyoutPrice, bidAmount, highBidder, owner, saleStatus, itemId, hasAllInfo = GetAuctionItemInfo("type", index);
minBid, minIncrement, buyoutPrice, bidAmount,  
highBidder, owner, saleStatus = GetAuctionItemInfo("type", index);


==Parameters==
==Parameters==
Line 15: Line 13:
:;name : a string containing the name of the item
:;name : a string containing the name of the item
:;texture : a string containing the name of the texture of the item
:;texture : a string containing the name of the texture of the item
:;count : a number containing the number of items in the auction item, zero if item is "sold" in the "owner" auctions
:;count : a number containing the amount of items in the auction item, zero if item is "sold" in the "owner" auctions
:;quality : an index into the [[API ITEM_QUALITY_COLORS|ITEM_QUALITY_COLORS]] array
:;quality : an index into the [[API ITEM_QUALITY_COLORS|ITEM_QUALITY_COLORS]] array
:;canUse : a boolean, true if the user can use the item, false if not
:;canUse : a boolean, true if the user can use the item, false if not
:;level : a number referring to the level required to use the item
:;level : a number referring to the level required to use the item
:;levelColHeader : unknown
:;minBid : the starting bid price
:;minBid : the starting bid price
:;minIncrement : the minimum amount of item at which to put the next bid
:;minIncrement : the minimum amount of item at which to put the next bid
Line 26: Line 25:
:;owner : the player that is selling the item
:;owner : the player that is selling the item
:;saleStatus : 1 for sold 0 for unsold
:;saleStatus : 1 for sold 0 for unsold
:;itemId : a number representing the item id
:;hasAllInfo: a boolean, true if all infos where retrieved


==Example==
==Example==
  local name, texture, count, quality, canUse, level,  
  local name, texture, count, quality, canUse, level, levelColHeader, minBid, minIncrement, buyoutPrice, bidAmount, highBidder, owner, saleStatus, itemId, hasAllInfo = GetAuctionItemInfo("owner", 1);
minBid, minIncrement, buyoutPrice, bidAmount,  
highBidder, owner = GetAuctionItemInfo("owner", 1);


===Result===
===Result===
Anonymous user