com.elmakers.mine.bukkit.api.item

Interface Cost

All Known Subinterfaces:

CastingCost

public interface Cost

Represents an abstract cost that may be one of several types: mana, XP, SP, Vault currency, or an item stack.

Method Summary

Modifier and Type	Method and Description
boolean	checkSupported(MageController controller, String... fallbackTypes) Convert this to cost to a different type if the current cost is not supported.
void	convert(MageController controller, String newType) Change the type of this cost, converting the amount using global conversion configurations.
void	deduct(Mage mage) Deduct these costs from the specified Mage
void	deduct(Mage mage, CasterProperties caster, CostReducer reducer) Deduct these costs from the specified Mage
void	deduct(Mage mage, Wand wand) Deduct these costs from the specified Mage
void	deduct(Mage mage, Wand wand, CostReducer reducer) Deduct these costs from the specified Mage
double	getBalance(Mage mage, CasterProperties caster) Get the amount of this cost type a Mage has.
String	getDescription(Messages messages) Get a human-readable description of this cost.
String	getDescription(Messages messages, CostReducer reducer) Get a human-readable description of this cost.
String	getFullDescription(Messages messages) Get a human-readable description of this cost.
String	getFullDescription(Messages messages, CostReducer reducer) Get a human-readable description of this cost.
org.bukkit.inventory.ItemStack	getItemStack() Get a copy of the item represented by this cost.
String	getType() This will return the currency type key or item key.
boolean	give(Mage mage, CasterProperties caster) Give these costs to the specified Mage
boolean	has(Mage mage) Whether or not a mage has the required costs.
boolean	has(Mage mage, CasterProperties caster, CostReducer reducer) Whether or not a mage has the required costs.
boolean	has(Mage mage, Wand wand) Whether or not a mage has the required costs.
boolean	has(Mage mage, Wand wand, CostReducer reducer) Whether or not a mage has the required costs.
boolean	isEmpty() Whether or not this record has any costs associated with it.
boolean	isEmpty(CostReducer reducer) Whether or not this record has any costs associated with it.
boolean	isItem() Check to see if this Cost is an ItemStack
void	scale(double scale) Multiply this cost by a scale value.

Method Detail

isEmpty

boolean isEmpty()

Whether or not this record has any costs associated with it.

Returns:

False if this has any non-zero costs.

isEmpty

boolean isEmpty(CostReducer reducer)

Whether or not this record has any costs associated with it.

Parameters:

reducer - The CostReducer to use for calculating costs

Returns:

False if this has any non-zero costs.

has

boolean has(Mage mage,
            CasterProperties caster,
            CostReducer reducer)

Whether or not a mage has the required costs.

Parameters:

mage - The mage to check for costs

caster - A optional caster, to be used for mana costs

reducer - An optional scale for costs

Returns:

True if the mage has these costs.

has

boolean has(Mage mage,
            Wand wand,
            CostReducer reducer)

Whether or not a mage has the required costs.

Parameters:

mage - The mage to check for costs

wand - A optional wand, to be used for mana costs

reducer - An optional scale for costs

Returns:

True if the mage has these costs.

has

boolean has(Mage mage,
            Wand wand)

Whether or not a mage has the required costs.

Parameters:

mage - The mage to check for costs

wand - A optional wand, to be used for mana costs

Returns:

True if the mage has these costs.

has

boolean has(Mage mage)

Whether or not a mage has the required costs.

Parameters:

mage - The mage to check for costs

Returns:

True if the mage has these costs.

deduct

void deduct(Mage mage,
            CasterProperties caster,
            CostReducer reducer)

Deduct these costs from the specified Mage

Parameters:

mage - The mage to check for costs

caster - A optional caster, to be used for mana costs

reducer - An optional scale for costs

deduct

void deduct(Mage mage,
            Wand wand)

Deduct these costs from the specified Mage

Parameters:

mage - The mage to check for costs

wand - A optional wand, to be used for mana costs

deduct

void deduct(Mage mage,
            Wand wand,
            CostReducer reducer)

Deduct these costs from the specified Mage

Parameters:

mage - The mage to check for costs

wand - A optional wand, to be used for mana costs

reducer - An optional scale for costs

deduct

void deduct(Mage mage)

Deduct these costs from the specified Mage

Parameters:

mage - The mage to check for costs

give

boolean give(Mage mage,
             CasterProperties caster)

Give these costs to the specified Mage

Parameters:

mage - The mage to give these costs to

caster - A optional caster, to be used for mana costs

Returns:

false if the costs could not be given (e.g. mage is at max already)

getBalance

double getBalance(Mage mage,
                  CasterProperties caster)

Get the amount of this cost type a Mage has.

Parameters:

mage - The mage to check

caster - A optional caster, to be used for mana costs

Returns:

the amount of this cost type the Mage has.

getDescription

String getDescription(Messages messages,
                      CostReducer reducer)

Get a human-readable description of this cost.

For XP, display text will be determined by the CostReducer if it uses Mana.

This does not include the amount, and only the label - e.g. "Bread" or "Mana" or "XP".

Parameters:

messages - The Messages class for looking up localizations

reducer - An optional scale for costs

Returns:

A printable String to display this casting cost to a Player.

getDescription

String getDescription(Messages messages)

Get a human-readable description of this cost.

For XP, display text will be determined by the CostReducer if it uses Mana.

This does not include the amount, and only the label - e.g. "Bread" or "Mana" or "XP".

Parameters:

messages - The Messages class for looking up localizations

Returns:

A printable String to display this casting cost to a Player.

getFullDescription

String getFullDescription(Messages messages,
                          CostReducer reducer)

Get a human-readable description of this cost.

For XP, display text will be determined by the CostReducer if it uses Mana.

This includes the amount as well as the label - e.g. "2 Bread" or "30 Mana" or "50 XP".

Parameters:

messages - The Messages class for looking up localizations

reducer - An optional scale for costs

Returns:

A printable String to display this casting cost to a Player.

getFullDescription

String getFullDescription(Messages messages)

Get a human-readable description of this cost.

For XP, display text will be determined by the CostReducer if it uses Mana.

This includes the amount as well as the label - e.g. "2 Bread" or "30 Mana" or "50 XP".

Parameters:

messages - The Messages class for looking up localizations

Returns:

A printable String to display this casting cost to a Player.

getType

@Nonnull
String getType()

This will return the currency type key or item key.

Returns:

The type or item key

getItemStack

org.bukkit.inventory.ItemStack getItemStack()

Get a copy of the item represented by this cost.

This will return null for non-item costs.

Returns:

The item cost, or null if none.

isItem

boolean isItem()

Check to see if this Cost is an ItemStack

Returns:

true if this cost is an item

scale

void scale(double scale)

Multiply this cost by a scale value.

Parameters:

scale - The cost multiplier.

checkSupported

boolean checkSupported(@Nonnull
                       MageController controller,
                       @Nonnull
                       String... fallbackTypes)

Convert this to cost to a different type if the current cost is not supported. If the first fallback is also not supported, the second fallback will be used.

Parameters:

controller - The controller to use to check for currency support

fallbackTypes - The types to use if this costs' type is not supported

Returns:

true if this cost was converted

convert

void convert(@Nonnull
             MageController controller,
             @Nonnull
             String newType)

Change the type of this cost, converting the amount using global conversion configurations.

Parameters:

controller - The controller to look up conversion rates

newType - The new type of this cost.