org.spongepowered.api.item.merchant

Interface TradeOffer

All Superinterfaces:

DataSerializable

public interface TradeOffer
extends DataSerializable

Represents a trade offer that a Merchant may offer a Humanoid.

TradeOffers usually have a limited amount of times they can be used.

Also, trade offers are not guaranteed to have two buying items.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	TradeOffer.Builder Represents a builder to generate immutable TradeOffers.

Method Summary

Modifier and Type	Method and Description
static TradeOffer.Builder	builder() Creates a new TradeOffer.Builder to build a TradeOffer.
boolean	doesGrantExperience() Gets whether this trade offer will grant experience upon usage or not.
ItemStackSnapshot	getFirstBuyingItem() Gets the first buying item.
int	getMaxUses() Gets the current maximum uses of this offer.
Optional<ItemStackSnapshot>	getSecondBuyingItem() Gets the second buying item.
ItemStackSnapshot	getSellingItem() Gets the selling item the Merchant will give to the customer often in exchange for a single item or sometimes, two items from the following methods: getFirstBuyingItem() and getSecondBuyingItem().
int	getUses() Gets the current uses of this offer.
boolean	hasExpired() Checks if this trade offer has indeed passed the time of which the uses surpassed the maximum uses.
boolean	hasSecondItem() Returns whether this trade offer has a second item the merchant is buying from the customer.

Methods inherited from interface org.spongepowered.api.data.DataSerializable

getContentVersion, toContainer

Method Detail

builder

static TradeOffer.Builder builder()

Creates a new TradeOffer.Builder to build a TradeOffer.

Returns:

The new builder

getFirstBuyingItem

ItemStackSnapshot getFirstBuyingItem()

Gets the first buying item.

The first buying item is an item that the customer is selling to the merchant in exchange for getSellingItem().

Returns:

The first buying item

hasSecondItem

boolean hasSecondItem()

Returns whether this trade offer has a second item the merchant is buying from the customer.

Returns:

True if there is a second buying item

getSecondBuyingItem

Optional<ItemStackSnapshot> getSecondBuyingItem()

Gets the second buying item.

The second buying item is an item that the customer is selling to the merchant, along with the getFirstBuyingItem(), in exchange for getSellingItem().

Returns:

The second buying item, if available

getSellingItem

ItemStackSnapshot getSellingItem()

Gets the selling item the Merchant will give to the customer often in exchange for a single item or sometimes, two items from the following methods: getFirstBuyingItem() and getSecondBuyingItem().

Returns:

The selling item

getUses

int getUses()

Gets the current uses of this offer.

Usually, the uses of an offer are limited by the amount of getMaxUses(). Once the uses reaches the max uses, the offer may temporarily become disabled.

Returns:

The current uses of this trade offer

getMaxUses

int getMaxUses()

Gets the current maximum uses of this offer.

Usually, the uses of an offer are limited by the amount of maximum uses. Once the uses reaches the max uses, the offer may temporarily become disabled.

Returns:

The maximum uses of this trade offer

hasExpired

boolean hasExpired()

Checks if this trade offer has indeed passed the time of which the uses surpassed the maximum uses.

Returns:

True if the uses have surpassed the maximum uses

doesGrantExperience

boolean doesGrantExperience()

Gets whether this trade offer will grant experience upon usage or not.

Returns:

True if using this trade offer will grant experience