WoW:API GetAuctionItemInfo - Revision history

Move page script: Move page script moved page API GetAuctionItemInfo to WoW:API GetAuctionItemInfo without leaving a redirect

2023-08-15T04:45:43Z

Move page script moved page API GetAuctionItemInfo to API GetAuctionItemInfo without leaving a redirect

← Older revision	Revision as of 04:45, 15 August 2023
(No difference)

Bear: /* Parameters */

2023-06-03T17:55:17Z

Parameters

← Older revision		Revision as of 17:55, 3 June 2023
Line 12:		Line 12:
	:::*"bidder" - An item the player has bid on, the "Bids" 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.		:::*"owner" - An item the player has up for auction, the "Auctions" tab in the dialog.

	:;index		:;index
	:: Integer - The index of the item in the list to retrieve info from (normally 1-50, inclusive)		:: Integer - The index of the item in the list to retrieve info from (normally 1-50, inclusive)

Bear: /* Notes */

2013-10-01T05:12:53Z

Notes

@@ Line 1: / Line 1: @@
-{{wowapi}} __NOTOC__
+{{wowapi}}
 Retrieves info about one item in the current retrieved list of items from the Auction House.
-  name, texture, count, quality, canUse, level, levelColHeader, minBid, minIncrement, buyoutPrice, bidAmount, highBidder, owner, saleStatus, itemId, hasAllInfo = GetAuctionItemInfo("type", index);
+  local name, texture, count, quality, canUse, level, levelColHeader, minBid,
-==Parameters==
+== Parameters ==
-===Arguments===
+=== Arguments ===
-:;type : String -  One of the following:
+:;type
 :::*"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.
-==Example==
+:;index
-  local name, texture, count, quality, canUse, level, levelColHeader, minBid, minIncrement, buyoutPrice, bidAmount, highBidder, owner, saleStatus, itemId, hasAllInfo = GetAuctionItemInfo("owner", 1);
+:: Integer - The index of the item in the list to retrieve info from (normally 1-50, inclusive)
 Retrieves info about the first item in the list of your currently auctioned items.
-== Notes ==
+== Details ==
+Note that the 'owner' field can be 'nil'. This happens because the auction listing internally contains player GUIDs rather than names, and the WoW client does not query the server for names until GetAuctionItemInfo is actually called for the item, and the result takes one [[RTT]] to arrive. The 'GUID to name' mapping is then stored in a name resolution cache, which gets cleared upon log-out, not UI reload.
 Blizzard's standard auction house view overcomes this problem by reacting to AUCTION_ITEM_LIST_UPDATE and re-querying the items.
 However, this event-driven approach does not really work for e.g. scanner engines. There, the correct solution is to re-query items with nil owners for a short time (a low number of seconds). There IS a possibility that it NEVER returns something - this happens when someone puts something up for auction and then deletes his character.
-Also note that these GUID-to-name queries cause client-to-server bandwidth; 14 bytes each (WoW 2.3.2). For a normal 50-item page this is of course negligeable, but for a full-AH scan on a medium-size server, you easily generate enough traffic to disconnect yourself if you do not throttle the rate at which you send queries. See [[ChatThrottleLib]] for information on client-to-server bandwidth.
+== Notes ==

WoWWiki>Chemical66: Updated return values

2012-04-26T16:53:33Z

Updated return values

← Older revision		Revision as of 16:53, 26 April 2012
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===

WoWWiki>WoWWiki-Waldo: saleStatus return value added

2008-12-29T17:06:43Z

saleStatus return value added

← Older revision		Revision as of 17:06, 29 December 2008
Line 3:		Line 3:
	name, texture, count, quality, canUse, level,		name, texture, count, quality, canUse, level,
	minBid, minIncrement, buyoutPrice, bidAmount,		minBid, minIncrement, buyoutPrice, bidAmount,
	highBidder, owner = GetAuctionItemInfo("type", index);		highBidder, owner, saleStatus = GetAuctionItemInfo("type", index);

	==Parameters==		==Parameters==
Line 25:		Line 25:
	:;highBidder : a boolean that is true if the current player is the highest bidder, otherwise nil		:;highBidder : a boolean that is true if the current player is the highest bidder, otherwise nil
	:;owner : the player that is selling the item		:;owner : the player that is selling the item
			:;saleStatus : 1 for sold 0 for unsold

	==Example==		==Example==

WoWWiki>Iprice: Note about zero count on sold auctions

2008-10-21T00:37:14Z

Note about zero count on sold auctions

← Older revision		Revision as of 00:37, 21 October 2008
Line 15:		Line 15:
	:;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		:;count : a number containing the number 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

WoWWiki>Mikk: /* Notes */ Explain that resolution is cached

2008-03-10T18:42:36Z

Notes: Explain that resolution is cached

@@ Line 1: / Line 1: @@
 {{wowapi}} __NOTOC__
 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, count, quality, canUse, level,
 ==Parameters==
@@ Line 31: / Line 33: @@
 ===Result===
 Retrieves info about the first item in the list of your currently auctioned items.

WoWWiki>Starlightblunder: {{wowapi}}, formatting.

2006-12-23T17:04:31Z

{{wowapi}}, formatting.

← Older revision		Revision as of 17:04, 23 December 2006
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.

WoWWiki>Muert at 04:32, 4 January 2006

2006-01-04T04:32:18Z

← Older revision		Revision as of 04:32, 4 January 2006
Line 49:		Line 49:
	----		----
	{{Template:WoW API}}		{{Template:WoW API}}
	~~[[Category:API Functions\|GetAuctionItemInfo]]~~
	~~[[Category:API Auction Functions\|GetAuctionItemInfo]]~~

WoWWiki>Inglais at 12:42, 27 August 2005

2005-08-27T12:42:16Z

← Older revision		Revision as of 12:42, 27 August 2005
Line 49:		Line 49:
	----		----
	{{Template:WoW API}}		{{Template:WoW API}}
			[[Category:API Functions\|GetAuctionItemInfo]]
			[[Category:API Auction Functions\|GetAuctionItemInfo]]