C_AuctionHouse

namespaceavailable in: camelot

Status in wowlua

86 functions: 49 implemented, 4 recorded, 33 guessed. 47 events, 22 of them fired by the emulator on its own.

Functions

function	what it does	status
`CalculateCommodityDeposit`	Returns required deposit for posting a commodity and quantity. `(itemID: number, duration: number, quantity: number): number?`	guessed
`CalculateItemDeposit`	Returns required deposit for posting a specific item and quantity. `(item: ItemLocationMixin, duration: number, quantity: number): number?`	implemented
`CanCancelAuction`	Returns if the auction can be cancelled. If it can't, load it with QueryOwnedAuctions. `(ownedAuctionID: number): boolean`	implemented
`CancelAuction`	Cancels an auction. `(ownedAuctionID: number)`	implemented
`CancelCommoditiesPurchase`	Abort an incomplete commodity purchase to avoid it conflicting with another purchase. `()`	implemented
`CancelSell`	Stop posting auctions for an non-commodity item. `()`	guessed
`CloseAuctionHouse`	Close the auction house window. `()`	implemented
`ConfirmCommoditiesPurchase`	Completes a commodity item purchase. `(itemID: number, quantity: number)`	implemented
`ConfirmPostCommodity`	Confirms posting the commodity at the auction house. · by wowlua `(item: ItemLocationMixin, duration: number, quantity: number, unitPrice: number)`	guessed
`ConfirmPostItem`	Confirms posting the item at the auction house. · by wowlua `(item: ItemLocationMixin, duration: number, quantity: number, bid: number?, buyout: number?)`	guessed
`FavoritesAreAvailable`	Whether the auction house favorites are available. · by wowlua `(): boolean`	implemented
`GetAuctionInfoByID`	Returns information about the auction. · by wowlua `(auctionID: number): AuctionInfo?`	guessed
`GetAuctionItemSubClasses`	Returns the item subclasses of the item class that the auction house lists. · by wowlua `(classID: number): number[]`	recorded
`GetAvailablePostCount`	Returns the available quantity of an item for posting. `(item: ItemLocationMixin): number`	implemented
`GetBidInfo`	Returns information about the player's bid at the index. · by wowlua `(bidIndex: number): BidInfo?`	guessed
`GetBidType`	Returns the item key of the bid type at the index. · by wowlua `(bidTypeIndex: number): ItemKey?`	guessed
`GetBids`	Returns the player's bids. · by wowlua `(): BidInfo[]`	guessed
`GetBrowseResults`	Returns the currently loaded summary results resulting from SendBrowseQuery. `(): BrowseResultInfo[]`	implemented
`GetCancelCost`	Returns the cost for cancelling a specific owned auction. This is non-zero if it has a bid. `(ownedAuctionID: number): number`	implemented
`GetCommoditySearchResultInfo`	Returns search results for a commodity item. `(itemID: number, commoditySearchResultIndex: number): CommoditySearchResultInfo?`	implemented
`GetCommoditySearchResultsQuantity`	Returns how many of the commodity is on sale. `(itemID: number): number`	implemented
`GetExtraBrowseInfo`	Returns the level (from 1-120, BfA levels) that some items would be crafted at. `(itemKey: ItemKey): number?`	guessed
`GetFilterGroups`	Returns groups of filters for use in the Filter dropdown in the Buy tab. `(): AuctionHouseFilterGroup[]`	recorded
`GetItemCommodityStatus`	Returns if the item is a commodity, item or neither. `(item: ItemLocationMixin): ItemCommodityStatus`	implemented
`GetItemKeyFromItem`	Returns an auction house item key from an item location. `(item: ItemLocationMixin): ItemKey`	implemented
`GetItemKeyInfo`	Returns more details about an item from its item key, including its name. `(itemKey: ItemKey, restrictQualityToFilter: boolean): ItemKeyInfo?`	implemented
`GetItemKeyRequiredLevel`	Returns the required level to use an item found on the auction house. `(itemKey: ItemKey): number?`	guessed
`GetItemKeySampleLink`	Returns a link for an item in this key's results with player-applied enchants, gems and reforges stripped `(itemKey: ItemKey): string?`	guessed
`GetItemSearchResultInfo`	Returns search results for an item. `(itemKey: ItemKey, itemSearchResultIndex: number): ItemSearchResultInfo?`	implemented
`GetItemSearchResultsQuantity`	Returns how many of the item is available on the auction house. `(itemKey: ItemKey): number`	guessed
`GetMaxBidItemBid`	Returns the highest bid among the player's bids. · by wowlua `(): number?`	guessed
`GetMaxBidItemBuyout`	Returns the highest buyout among the player's bids. · by wowlua `(): number?`	guessed
`GetMaxCommoditySearchResultPrice`	Returns the highest price in the commodity's search results. · by wowlua `(itemID: number): number?`	guessed
`GetMaxItemSearchResultBid`	Returns the highest bid in the item's search results. · by wowlua `(itemKey: ItemKey): number?`	guessed
`GetMaxItemSearchResultBuyout`	Returns the highest buyout in the item's search results. · by wowlua `(itemKey: ItemKey): number?`	guessed
`GetMaxOwnedAuctionBid`	Returns the highest bid among the player's auctions. · by wowlua `(): number?`	guessed
`GetMaxOwnedAuctionBuyout`	Returns the highest buyout among the player's auctions. · by wowlua `(): number?`	implemented
`GetNumBidTypes`	Returns the number of item types the player has bid on. · by wowlua `(): number`	implemented
`GetNumBids`	Returns the number of the player's bids. · by wowlua `(): number`	implemented
`GetNumCommoditySearchResults`	Returns the number of commodity results, the different prices. `(itemID: number): number`	implemented
`GetNumItemSearchResults`	Returns the number of item results, the different auctions. `(itemKey: ItemKey): number`	implemented
`GetNumOwnedAuctionTypes`	Returns the number of item types among the player's auctions. · by wowlua `(): number`	implemented
`GetNumOwnedAuctions`	Returns the number of auctions the player has active on the auction house. `(): number`	implemented
`GetNumReplicateItems`	Returns the amount of auctions. `(): number`	guessed
`GetOwnedAuctionInfo`	Returns information for one of the player's active auctions. `(ownedAuctionIndex: number): OwnedAuctionInfo?`	implemented
`GetOwnedAuctionType`	Returns the item key of the player's auction type at the index. · by wowlua `(ownedAuctionTypeIndex: number): ItemKey?`	guessed
`GetOwnedAuctions`	Returns the player's auctions. · by wowlua `(): OwnedAuctionInfo[]`	implemented
`GetQuoteDurationRemaining`	Returns how long the current commodity price quote stays valid. · by wowlua `(): number`	implemented
`GetReplicateItemBattlePetInfo`	Returns display info for a battle pet from a ReplicateItems result. `(index: number): (number?, number?)`	guessed
`GetReplicateItemInfo`	Returns information about the specified auction. `(index: number): (string?, number?, number, number, boolean?, number, string?, number, number, number, number, string?, string?, string?, string?, number, number, boolean?)`	implemented
`GetReplicateItemLink`	Returns the item link (if loaded) for an item from a ReplicateItems result. `(index: number): string?`	guessed
`GetReplicateItemTimeLeft`	Returns the time left for an auction. `(index: number): number`	guessed
`GetTimeLeftBandInfo`	Identifies the breakpoints for describing an auction's remaining duration using time-left bands. `(timeLeftBand: AuctionHouseTimeLeftBand): (number, number)`	guessed
`HasFavorites`	Whether the player has favorite auction house items. · by wowlua `(): boolean`	implemented
`HasFullBidResults`	Whether all of the player's bids have been received. · by wowlua `(): boolean`	implemented
`HasFullBrowseResults`	Returns if the last group of summary results (groups of 500) is available. `(): boolean`	implemented
`HasFullCommoditySearchResults`	Whether all search results for the commodity have been received. · by wowlua `(itemID: number): boolean`	implemented
`HasFullItemSearchResults`	Whether all search results for the item have been received. · by wowlua `(itemKey: ItemKey): boolean`	implemented
`HasFullOwnedAuctionResults`	Whether all of the player's auctions have been received. · by wowlua `(): boolean`	implemented
`HasMaxFavorites`	Whether the player has as many favorite items as allowed. · by wowlua `(): boolean`	guessed
`HasSearchResults`	Whether there are search results for the item key. · by wowlua `(itemKey: ItemKey): boolean`	implemented
`IsFavoriteItem`	Whether the item is a favorite. · by wowlua `(itemKey: ItemKey): boolean`	implemented
`IsSellItemValid`	Returns true if an item from your bag can be posted on the auction house. `(item: ItemLocationMixin, displayError: boolean): boolean`	implemented
`IsThrottledMessageSystemReady`	Returns if the next query will be throttled, either delayed or cancelled. `(): boolean`	implemented
`MakeItemKey`	Returns an auction house item key. `(itemID: number, itemLevel: number, itemSuffix: number, battlePetSpeciesID: number): ItemKey`	implemented
`PlaceBid`	Places a bid on a non-commodity item. `(auctionID: number, bidAmount: number)`	guessed
`PostCommodity`	Posts a commodity item on the auction house. `(item: ItemLocationMixin, duration: number, quantity: number, unitPrice: number): boolean`	guessed
`PostItem`	Posts an item on the auction house. `(item: ItemLocationMixin, duration: number, quantity: number, bid: number?, buyout: number?): boolean`	implemented
`QueryBids`	Requests the player's bids from the auction house. · by wowlua `(sorts: AuctionHouseSortType[], auctionIDs: number[])`	implemented
`QueryOwnedAuctions`	Queries the auction house for the player's active auctions. `(sorts: AuctionHouseSortType[])`	implemented
`RefreshCommoditySearchResults`	Requests up-to-date search results for the commodity. · by wowlua `(itemID: number)`	implemented
`RefreshItemSearchResults`	Requests up-to-date search results for the item. · by wowlua `(itemKey: ItemKey, minLevelFilter: number?, maxLevelFilter: number?)`	implemented
`ReplicateItems`	Queries all auctions listed on the Auction House. `()`	guessed
`RequestMoreBrowseResults`	Requests the next page of browse results. · by wowlua `()`	implemented
`RequestMoreCommoditySearchResults`	Requests more search results for the commodity. · by wowlua `(itemID: number): boolean`	guessed
`RequestMoreItemSearchResults`	Requests more search results for the item. · by wowlua `(itemKey: ItemKey): boolean`	guessed
`RequestOwnedAuctionBidderInfo`	Requests the name of the highest bidder on the player's auction. · by wowlua `(auctionID: number): string`	implemented
`SearchForFavorites`	Searches for favorited items. `(sorts: AuctionHouseSortType[])`	guessed
`SearchForItemKeys`	Queries the auction house for summary results of up to 100 specific items. `(itemKeys: ItemKey[], sorts: AuctionHouseSortType[])`	guessed
`SendBrowseQuery`	Queries the auction house using search parameters. `(query: AuctionHouseBrowseQuery)`	implemented
`SendSearchQuery`	Queries an item in the auction house. `(itemKey: ItemKey, sorts: AuctionHouseSortType[], separateOwnerItems: boolean, minLevelFilter: number, maxLevelFilter: number)`	implemented
`SendSellSearchQuery`	Search for all auctions that are variants of a piece of gear, determined a specific item ID. `(itemKey: ItemKey, sorts: AuctionHouseSortType[], separateOwnerItems: boolean)`	implemented
`SetFavoriteItem`	Adds the item to or removes it from the favorites. · by wowlua `(itemKey: ItemKey, setFavorite: boolean)`	guessed
`ShouldAutoPopulatePrice`	Whether the price is filled in automatically when posting. · by wowlua `(): boolean`	recorded
`StartCommoditiesPurchase`	Starts a commodity item purchase. `(itemID: number, quantity: number)`	implemented
`SupportsCopperValues`	Whether auction prices can include copper. · by wowlua `(): boolean`	recorded

"by wowlua": no one documents this function, so wowlua wrote the description from its name, signature and behaviour.

Events

event	payload	fired by the emulator
`AUCTION_CANCELED`	`auctionID: number`	implemented
`AUCTION_HOUSE_AUCTIONS_EXPIRED`	`auctionID: number`	not implemented
`AUCTION_HOUSE_AUCTION_CREATED`	`auctionID: number`	implemented
`AUCTION_HOUSE_BROWSE_FAILURE`	`no payload`	not implemented
`AUCTION_HOUSE_BROWSE_RESULTS_ADDED`	`addedBrowseResults: BrowseResultInfo[]`	implemented
`AUCTION_HOUSE_BROWSE_RESULTS_UPDATED`	`no payload`	implemented
`AUCTION_HOUSE_CLOSED`	`no payload`	implemented
`AUCTION_HOUSE_DISABLED`	`no payload`	not implemented
`AUCTION_HOUSE_FAVORITES_UPDATED`	`no payload`	not implemented
`AUCTION_HOUSE_ITEM_DELIVERY_DELAY_UPDATE`	`purchasedItemDeliveryDelay: number, cancelledItemDeliveryDelay: number`	implemented
`AUCTION_HOUSE_NEW_BID_RECEIVED`	`auctionID: number`	not implemented
`AUCTION_HOUSE_NEW_RESULTS_RECEIVED`	`itemKey: ItemKey?`	implemented
`AUCTION_HOUSE_POST_ERROR`	`no payload`	not implemented
`AUCTION_HOUSE_POST_WARNING`	`no payload`	not implemented
`AUCTION_HOUSE_PURCHASE_COMPLETED`	`auctionID: number`	implemented
`AUCTION_HOUSE_SCRIPT_DEPRECATED`	`no payload`	not implemented
`AUCTION_HOUSE_SHOW`	`no payload`	implemented
`AUCTION_HOUSE_SHOW_COMMODITY_WON_NOTIFICATION`	`commodityName: string, commodityQuantity: number`	implemented
`AUCTION_HOUSE_SHOW_ERROR`	`error: AuctionHouseError`	not implemented
`AUCTION_HOUSE_SHOW_FORMATTED_NOTIFICATION`	`notification: AuctionHouseNotification, text: string, auctionID: number?`	not implemented
`AUCTION_HOUSE_SHOW_NOTIFICATION`	`notification: AuctionHouseNotification`	not implemented
`AUCTION_HOUSE_THROTTLED_MESSAGE_DROPPED`	`no payload`	not implemented
`AUCTION_HOUSE_THROTTLED_MESSAGE_QUEUED`	`no payload`	implemented
`AUCTION_HOUSE_THROTTLED_MESSAGE_RESPONSE_RECEIVED`	`no payload`	implemented
`AUCTION_HOUSE_THROTTLED_MESSAGE_SENT`	`no payload`	implemented
`AUCTION_HOUSE_THROTTLED_SYSTEM_READY`	`no payload`	implemented
`AUCTION_MULTISELL_FAILURE`	`no payload`	not implemented
`AUCTION_MULTISELL_START`	`numRepetitions: number`	not implemented
`AUCTION_MULTISELL_UPDATE`	`createdCount: number, totalToCreate: number`	not implemented
`BIDS_UPDATED`	`no payload`	implemented
`BID_ADDED`	`bidID: number`	not implemented
`COMMODITY_PRICE_UNAVAILABLE`	`no payload`	not implemented
`COMMODITY_PRICE_UPDATED`	`updatedUnitPrice: number, updatedTotalPrice: number`	implemented
`COMMODITY_PURCHASED`	`itemID: number, quantity: number`	not implemented
`COMMODITY_PURCHASE_FAILED`	`no payload`	not implemented
`COMMODITY_PURCHASE_SUCCEEDED`	`no payload`	implemented
`COMMODITY_SEARCH_RESULTS_ADDED`	`itemID: number`	not implemented
`COMMODITY_SEARCH_RESULTS_RECEIVED`	`no payload`	implemented
`COMMODITY_SEARCH_RESULTS_UPDATED`	`itemID: number`	implemented
`EXTRA_BROWSE_INFO_RECEIVED`	`itemID: number`	not implemented
`ITEM_KEY_ITEM_INFO_RECEIVED`	`itemID: number`	implemented
`ITEM_PURCHASED`	`itemID: number`	not implemented
`ITEM_SEARCH_RESULTS_ADDED`	`itemKey: ItemKey`	not implemented
`ITEM_SEARCH_RESULTS_UPDATED`	`itemKey: ItemKey, newAuctionID: number?`	implemented
`OWNED_AUCTIONS_UPDATED`	`no payload`	implemented
`OWNED_AUCTION_BIDDER_INFO_RECEIVED`	`auctionID: number, bidderName: string`	not implemented
`REPLICATE_ITEM_LIST_UPDATE`	`no payload`	not implemented

An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("AUCTION_HOUSE_AUCTIONS_EXPIRED").

Structures

AuctionHouseBrowseQuery · searchString, sorts, minLevel?, maxLevel?, filters?, itemClassFilters?
AuctionHouseFilterGroup · category, filters
AuctionHouseItemClassFilter · classID, subClassID?, inventoryType?
AuctionHouseSortType · sortOrder, reverseSort
AuctionInfo · itemKey, itemLink?, minBid?, bidAmount?, buyoutAmount?, bidder?
BidInfo · auctionID, itemKey, itemLink?, timeLeft, minBid?, bidAmount?, buyoutAmount?, bidder?
BrowseResultInfo · itemKey, appearanceLink?, totalQuantity, minPrice, containsOwnerItem
CommoditySearchResultInfo · itemID, quantity, unitPrice, auctionID, owners, totalNumberOfOwners, timeLeftSeconds?, numOwnerItems, containsOwnerItem, containsAccountItem
ItemKey · itemID, itemLevel, itemSuffix, battlePetSpeciesID
ItemKeyInfo · itemID, battlePetSpeciesID, itemName, battlePetLink?, appearanceLink?, quality, iconFileID, isPet, isCommodity, isEquipment
ItemSearchResultInfo · itemKey, owners, totalNumberOfOwners, timeLeft, auctionID, quantity, itemLink?, containsOwnerItem, containsAccountItem, containsSocketedItem, bidder?, minBid?, bidAmount?, buyoutAmount?, timeLeftSeconds?
OwnedAuctionInfo · auctionID, itemKey, itemLink?, status, quantity, timeLeftSeconds?, timeLeft?, bidAmount?, buyoutAmount?, bidder?
ReplicateItemInfo · name?, texture?, count, qualityID, usable?, level, levelType?, minBid, minIncrement, buyoutPrice, bidAmount, highBidder?, bidderFullName?, owner?, ownerFullName?, saleStatus, itemID, hasAllInfo?

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (AuctionHouse system, camelot 1.60.1). Descriptions: Blizzard's API documentation (Blizzard_APIDocumentationGenerated); warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗; written by wowlua where no documentation describes the entry.