Interface AuctionHouseService

public interface AuctionHouseService

Player-to-player marketplace: list an item at a fixed price, or as an auction with bidding, optionally taxed on listing.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	AuctionHouseService.BidResult
static enum	AuctionHouseService.PurchaseResult

Method Summary

Modifier and Type	Method	Description
CompletableFuture<AuctionHouseService.BidResult>	bid(UUID bidder, long listingId, double amount)	Places a bid on an auction listing.
CompletableFuture<List<AuctionListing>>	browse(int page, int pageSize)	Active listings, newest first.
CompletableFuture<Boolean>	cancel(UUID seller, long listingId)
CompletableFuture<Boolean>	collectExpired(UUID seller, long listingId)	Collects a pending item: an unsold/expired fixed-price listing (as its seller) or a won auction (as the winning bidder).
CompletableFuture<List<AuctionListing>>	expiredAwaitingCollection(UUID seller)	Listings the player has something waiting on - see collectExpired(UUID, long).
CompletableFuture<AuctionListing>	list(UUID seller, org.bukkit.inventory.ItemStack item, double price)
CompletableFuture<AuctionListing>	listAuction(UUID seller, org.bukkit.inventory.ItemStack item, double startingBid)	Lists item as an auction starting at startingBid.
CompletableFuture<List<AuctionListing>>	listingsBySeller(UUID seller, boolean activeOnly)
CompletableFuture<AuctionHouseService.PurchaseResult>	purchase(UUID buyer, long listingId)

Method Details

list

CompletableFuture<AuctionListing> list(UUID seller,
 org.bukkit.inventory.ItemStack item,
 double price)

listAuction

CompletableFuture<AuctionListing> listAuction(UUID seller,
 org.bukkit.inventory.ItemStack item,
 double startingBid)

Lists item as an auction starting at startingBid.

purchase

CompletableFuture<AuctionHouseService.PurchaseResult> purchase(UUID buyer,
 long listingId)

bid

CompletableFuture<AuctionHouseService.BidResult> bid(UUID bidder,
 long listingId,
 double amount)

Places a bid on an auction listing. Charges amount immediately and refunds the previous highest bidder (if any) in the same operation, so a bidder's money is never at risk of vanishing between an outbid and the refund - both happen atomically under the listing's lock.

cancel

CompletableFuture<Boolean> cancel(UUID seller,
 long listingId)

browse

CompletableFuture<List<AuctionListing>> browse(int page,
 int pageSize)

Active listings, newest first.

listingsBySeller

CompletableFuture<List<AuctionListing>> listingsBySeller(UUID seller,
 boolean activeOnly)

expiredAwaitingCollection

CompletableFuture<List<AuctionListing>> expiredAwaitingCollection(UUID seller)

Listings the player has something waiting on - see collectExpired(UUID, long).

collectExpired

CompletableFuture<Boolean> collectExpired(UUID seller,
 long listingId)

Collects a pending item: an unsold/expired fixed-price listing (as its seller) or a won auction (as the winning bidder). Returns false if there's nothing to collect, the caller isn't the right party, or their inventory has no space.