WoW:API QueryAuctionItems: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(More wikifying. Note about CanSendAuctionQuery's second return)
(Note that getAll param doesn't actually do anything yet.)
Line 43: Line 43:
:;isUsable : Is useable by the player (nil = no restrictions)
:;isUsable : Is useable by the player (nil = no restrictions)
:;qualityIndex : The items' quality (nil = no restrictions)
:;qualityIndex : The items' quality (nil = no restrictions)
:;getAll : Download the ENTIRE auction house as one single page. Only allowed when [[API CanSendAuctionQuery|CanSendAuctionQuery]]() returns true as its second return (~every 15 minutes). May disconnect people with low bandwidth. Also see notes on client-to-server traffic in [[API GetAuctionItemInfo|GetAuctionItemInfo]]() (Added in 2.3)
:;getAll : Download the ENTIRE auction house as one single page. Only allowed when [[API CanSendAuctionQuery|CanSendAuctionQuery]]() returns true as its second return (~every 15 minutes). May disconnect people with low bandwidth. Also see notes on client-to-server traffic in [[API GetAuctionItemInfo|GetAuctionItemInfo]]() (Added in 2.3) While this has been 'added', it is marked as [http://forums.worldofwarcraft.com/thread.html?topicId=879058320&sid=1 **DISABLED UNTIL A FUTURE PATCH** ] and does appear to do nothing.





Revision as of 13:10, 31 May 2008

WoW API < QueryAuctionItems

Will return information about items in the auction house. There must be a delay of about 3 second between queries. Use CanSendAuctionQuery() to determine if a query can be done.

QueryAuctionItems("name", "minLevel", "maxLevel", 
  invTypeIndex, classIndex, subclassIndex, 
  page, isUsable, qualityIndex, getAll
)

Arguments

(string type, string type, string type, index value, )
name
A part of the item's name (or the complete name) or "" for no retrenchment.
minLevel
Items below this level won't be returned. Either a number or "" for no restrictions.
maxLevel
Items above this level won't be returned. Either a number or "" for no restrictions.
invtypeIndex
Character's slotposition in which the item can be placed in. Can be one of the following values:
INVTYPE_HEAD
Head slot
INVTYPE_NECK
Neck slot
INVTYPE_SHOULDER
Shoulder slot
INVTYPE_BODY
Body slot
INVTYPE_CHEST
Chest slot
INVTYPE_WAIST
Waist slot
INVTYPE_LEGS
Leg slot
INVTYPE_FEET
Feet slot
INVTYPE_WRIST
Wrist slot
INVTYPE_HAND
Hand slot
INVTYPE_FINGER
Finger slot
INVTYPE_TRINKET
Trinket slot
INVTYPE_CLOAK
Cloak slot
INVTYPE_HOLDABLE
unknown
INVTYPE_WEAPONMAINHAND
Weapon mainhand slot
INVTYPE_ROBE
Robe slot
INVTYPE_TABARD
Tabard slot
INVTYPE_BAG
Container slot
INVTYPE_2HWEAPON
2handed weapon (takes two slots)
INVTYPE_RANGED
Ranged weapon slot
INVTYPE_SHIELD
Shield slot
INVTYPE_WEAPON
Both weapon slots
nil
no restrictions
classIndex
Items not in this class won't be returned. Index corresponds to the index returned by GetAuctionItemClasses() or nil for no restrictions.
subclassIndex
Items not in this subclass won't be returned. Index corresponds to the index used in GetAuctionItemSubClasses(index) or nil for no restrictions.
page
What page in the auctionhouse this shows up
isUsable
Is useable by the player (nil = no restrictions)
qualityIndex
The items' quality (nil = no restrictions)
getAll
Download the ENTIRE auction house as one single page. Only allowed when CanSendAuctionQuery() returns true as its second return (~every 15 minutes). May disconnect people with low bandwidth. Also see notes on client-to-server traffic in GetAuctionItemInfo() (Added in 2.3) While this has been 'added', it is marked as **DISABLED UNTIL A FUTURE PATCH** and does appear to do nothing.


Example

QueryAuctionItems("",10, 19, "", 2, nil, 0, nil, 3)

Result

Finds twink gear! (blue armor between lvl 10 and 19)
still unsure how to use the forth argument
also, the First page is page (0) zero

Notes