io.github.nucleuspowered.nucleus.api.service

Interface NucleusServerShopService

public interface NucleusServerShopService

A service to get the current prices of an item.

Method Summary

Modifier and Type	Method and Description
Optional<Double>	getBuyPrice(org.spongepowered.api.block.BlockState type) Gets the buy price of an item (that is, how much a server will sell an item to a player for).
default Optional<Double>	getBuyPrice(org.spongepowered.api.item.inventory.ItemStack itemStack) Gets the buy price of an item (that is, how much a server will sell an item to a player for).
Optional<Double>	getBuyPrice(org.spongepowered.api.item.inventory.ItemStackSnapshot itemStackSnapshot) Gets the buy price of an item (that is, how much a server will sell an item to a player for).
default Optional<Double>	getBuyPrice(org.spongepowered.api.item.ItemType type) Gets the buy price of an item (that is, how much a server will sell an item to a player for).
Map<org.spongepowered.api.CatalogType,Double>	getBuyPrices() Gets all the server buy prices.
Optional<Double>	getSellPrice(org.spongepowered.api.block.BlockState type) Gets the sell price of an item (that is, how much a server will buy an item from a player for).
default Optional<Double>	getSellPrice(org.spongepowered.api.item.inventory.ItemStack itemStack) Gets the sell price of an item (that is, how much a server will buy an item from a player for).
Optional<Double>	getSellPrice(org.spongepowered.api.item.inventory.ItemStackSnapshot itemStackSnapshot) Gets the sell price of an item (that is, how much a server will buy an item from a player for).
default Optional<Double>	getSellPrice(org.spongepowered.api.item.ItemType type) Gets the sell price of an item (that is, how much a server will buy an item from a player for).
Map<org.spongepowered.api.CatalogType,Double>	getSellPrices() Gets all the server sell prices.

Method Detail

getBuyPrices

Map<org.spongepowered.api.CatalogType,Double> getBuyPrices()

Gets all the server buy prices.

Note that the CatalogType could either be an ItemType or a BlockState

Returns:

The buy prices

getSellPrices

Map<org.spongepowered.api.CatalogType,Double> getSellPrices()

Gets all the server sell prices.

Note that the CatalogType could either be an ItemType or a BlockState

Returns:

The buy prices

getBuyPrice

default Optional<Double> getBuyPrice(org.spongepowered.api.item.ItemType type)

Gets the buy price of an item (that is, how much a server will sell an item to a player for).

Parameters:

type - The item to check.

Returns:

The price, or Optional if not being sold.

getBuyPrice

Optional<Double> getBuyPrice(org.spongepowered.api.block.BlockState type)
                      throws NucleusException

Gets the buy price of an item (that is, how much a server will sell an item to a player for).

Parameters:

type - The item to check.

Returns:

The price, or Optional if not being sold.

Throws:

NucleusException - if the BlockState does not map to an item.

getBuyPrice

default Optional<Double> getBuyPrice(org.spongepowered.api.item.inventory.ItemStack itemStack)

Gets the buy price of an item (that is, how much a server will sell an item to a player for).

Parameters:

itemStack - The item to check.

Returns:

The price, or Optional if not being sold.

getBuyPrice

Optional<Double> getBuyPrice(org.spongepowered.api.item.inventory.ItemStackSnapshot itemStackSnapshot)

Gets the buy price of an item (that is, how much a server will sell an item to a player for).

Parameters:

itemStackSnapshot - The item to check.

Returns:

The price, or Optional if not being sold.

getSellPrice

default Optional<Double> getSellPrice(org.spongepowered.api.item.ItemType type)

Gets the sell price of an item (that is, how much a server will buy an item from a player for).

Parameters:

type - The item to check.

Returns:

The price, or Optional if not being bought.

getSellPrice

Optional<Double> getSellPrice(org.spongepowered.api.block.BlockState type)
                       throws NucleusException

Gets the sell price of an item (that is, how much a server will buy an item from a player for).

Parameters:

type - The item to check.

Returns:

The price, or Optional if not being bought.

Throws:

NucleusException - if the BlockState does not map to an item.

getSellPrice

default Optional<Double> getSellPrice(org.spongepowered.api.item.inventory.ItemStack itemStack)

Gets the sell price of an item (that is, how much a server will buy an item from a player for).

Parameters:

itemStack - The item to check.

Returns:

The price, or Optional if not being bought.

getSellPrice

Optional<Double> getSellPrice(org.spongepowered.api.item.inventory.ItemStackSnapshot itemStackSnapshot)

Gets the sell price of an item (that is, how much a server will buy an item from a player for).

Parameters:

itemStackSnapshot - The item to check.

Returns:

The price, or Optional if not being bought.