WoW:API GetAuctionItemInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
 
No edit summary
Line 3: Line 3:
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, ... = GetAuctionItemInfo("list", index);
  name, texture, ... = GetAuctionItemInfo("type", index);


----
----
;''Arguments''
;''Arguments''
:(String type, Number index)


:(String target, Number index)
:;type : One of the following:
 
:::;"list" : An item up for auction, the "Browse" tab in the dialog.
:;target : The target to retrieve info from - always "list", as far as I know
:::;"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)
:;index : The index of the item in the list to retrieve info from (normally 1-50, inclusive)
Line 27: Line 29:
:;buyoutPrice : zero if no buy out, otherwise it contains the buyout price of the auction item
:;buyoutPrice : zero if no buy out, otherwise it contains the buyout price of the auction item
:;bidAmount : the current highest bid, zero if no one has bid yet
:;bidAmount : the current highest bid, zero if no one has bid yet
:;highBidder : a boolean that is true if the current user is the highest bidder, otherwise false
:;highBidder : a boolean that is true if the current player is the highest bidder, otherwise nil
:;owner : the person that has laid the highest bid so far (I think)
:;owner : the player that is selling the item


----
----

Revision as of 16:39, 14 February 2005

GetAuctionItemInfo -Documentation by Sarf-

Retrieves info about one item in the current retrieved list of items from the Auction House.

name, texture, ... = GetAuctionItemInfo("type", index);

Arguments
(String type, Number index)
type
One of the following:
"list"
An item up for auction, the "Browse" tab in the dialog.
"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
texture
a string containing the name of the texture of the item
count
a number containing the number of items in the auction item
quality
an index into the ITEM_QUALITY_COLORS array
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
minBid
the starting bid price
minIncrement
the minimum amount of item at which to put the next bid
buyoutPrice
zero if no buy out, otherwise it contains the buyout price of the auction item
bidAmount
the current highest bid, zero if no one has bid yet
highBidder
a boolean that is true if the current player is the highest bidder, otherwise nil
owner
the player that is selling the item

Example
name, texture, count, quality, canUse, level, 
minBid, minIncrement, buyoutPrice, bidAmount, 
highBidder, owner = GetAuctionItemInfo("owner", offset + i);
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.

Template:WoW API