WoW:API GetAuctionItemInfo: Difference between revisions

m
{{wowapi}}, formatting.
No edit summary
m ({{wowapi}}, formatting.)
Line 1: Line 1:
<center>'''GetAuctionItemInfo''' ''-Documentation by Sarf-''</center>
{{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, minBid, minIncrement, buyoutPrice, bidAmount, highBidder, owner  = GetAuctionItemInfo("type", index);


name, texture, ... = GetAuctionItemInfo("type", index);
==Parameters==
 
===Arguments===
----
:;type : String -  One of the following:
;''Arguments''
:::*"list" - An item up for auction, the "Browse" tab in the dialog.
:(String type, Number index)
:::*"bidder" - An item the player has bid on, the "Bids" tab in the dialog.
 
:::*"owner" - An item the player has up for auction, the "Auctions" tab in the dialog.
:;type : One of the following:
:;index : Integer - The index of the item in the list to retrieve info from (normally 1-50, inclusive)
:::;"list" : An item up for auction, the "Browse" tab in the dialog.
===Returns===
:::;"bidder" : An item the player has bid on, the "Bids" tab in the dialog.
:::;"owner" : An item the player has up for auction, the "Auctions" tab in the dialog.
 
:;index : The index of the item in the list to retrieve info from (normally 1-50, inclusive)
 
----
;''Returns''
 
:;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
Line 32: Line 24:
:;owner : the player that is selling the item
:;owner : the player that is selling the item


----
==Example==
;''Example''
  local name, texture, count, quality, canUse, level,  
  name, texture, count, quality, canUse, level,  
  minBid, minIncrement, buyoutPrice, bidAmount,  
  minBid, minIncrement, buyoutPrice, bidAmount,  
  highBidder, owner = GetAuctionItemInfo("owner", offset + i);
  highBidder, owner = GetAuctionItemInfo("owner", 1);
 
;''Result''
 
Retrieves info about an item in the current list of auction items. Affects nothing other than the return values.
 
----
;''Description''
 
: Retrieves info about an item in the current list of auction items.


----
===Result===
{{Template:WoW API}}
Retrieves info about the first item in the list of your currently auctioned items.