WoW:API QueryAuctionItems: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
(More wikifying. Note about CanSendAuctionQuery's second return) |
||
| Line 3: | Line 3: | ||
Will return information about items in the auction house. There must be a delay of about 3 second between queries. Use [[API CanSendAuctionQuery|CanSendAuctionQuery]]() to determine if a query can be done. | Will return information about items in the auction house. There must be a delay of about 3 second between queries. Use [[API CanSendAuctionQuery|CanSendAuctionQuery]]() to determine if a query can be done. | ||
QueryAuctionItems("name", "minLevel", "maxLevel", invTypeIndex, classIndex, subclassIndex, page, isUsable, qualityIndex) | QueryAuctionItems("name", "minLevel", "maxLevel", | ||
invTypeIndex, classIndex, subclassIndex, | |||
page, isUsable, qualityIndex, getAll | |||
) | |||
== Arguments == | |||
:(string type, string type, string type, index value, ) | :(string type, string type, string type, index value, ) | ||
| Line 36: | Line 38: | ||
:::;INVTYPE_WEAPON : Both weapon slots | :::;INVTYPE_WEAPON : Both weapon slots | ||
:::;nil : no restrictions | :::;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. | :;classIndex : Items not in this class won't be returned. Index corresponds to the index returned by [[API GetAuctionItemClasses|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. | :;subclassIndex : Items not in this subclass won't be returned. Index corresponds to the index used in [[API GetAuctionItemSubClasses|GetAuctionItemSubClasses]](index) or nil for no restrictions. | ||
:;page : What page in the auctionhouse this shows up | :;page : What page in the auctionhouse this shows up | ||
:;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) | |||
== Example == | |||
QueryAuctionItems("",10, 19, "", 2, nil, 0, nil, 3) | QueryAuctionItems("",10, 19, "", 2, nil, 0, nil, 3) | ||
=== Result === | |||
:Finds twink gear! (blue armor between lvl 10 and 19) | :Finds twink gear! (blue armor between lvl 10 and 19) | ||
| Line 58: | Line 55: | ||
:also, the First page is page (0) zero | :also, the First page is page (0) zero | ||
== Notes == | |||
Revision as of 07:52, 17 March 2008
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)
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