com.elmakers.mine.bukkit.api.spell

Interface CastingCost

All Superinterfaces:

Cost

public interface CastingCost
extends Cost

This reprsents a cost required to cast a Spell.

A Spell may have one or more (or no) CastingCost records assigned to it.

A CastingCost can be XP (or "Mana" when provided by a wand) or Material (reagents) as costs, or a combination of both.

Method Summary

Modifier and Type	Method and Description
int	getMana() Returns the raw mana cost.
int	getMana(CostReducer reducer) Returns the Mana amount to deduct
int	getXP() Deprecated.
int	getXP(CostReducer reducer) Deprecated.
boolean	has(Spell spell) Check to see if a given spell cast should succeed, given that it has any required costs.
void	refund(Spell spell) Refund this cost, giving it back to the caster of the target spell.
void	use(Spell spell) Use this cost, taking it from the caster of the target spell

Methods inherited from interface com.elmakers.mine.bukkit.api.item.Cost

checkSupported, convert, deduct, deduct, deduct, deduct, getBalance, getDescription, getDescription, getFullDescription, getFullDescription, getItemStack, getType, give, has, has, has, has, isEmpty, isEmpty, isItem, scale

Method Detail

getXP

@Deprecated
int getXP()

Deprecated.

Returns the raw XP cost.

Returns:

The raw XP cost, without reduction.

getXP

@Deprecated
int getXP(CostReducer reducer)

Deprecated.

Returns the XP amount to deduct

Parameters:

reducer - The CostReducer to use to calculate costs

Returns:

The XP amount cost

getMana

int getMana()

Returns the raw mana cost.

Returns:

The raw mana cost, without reduction.

getMana

int getMana(CostReducer reducer)

Returns the Mana amount to deduct

Parameters:

reducer - The CostReducer to use to calculate costs

Returns:

The Mana amount cost

has

boolean has(Spell spell)

Check to see if a given spell cast should succeed, given that it has any required costs.

Parameters:

spell - the spell being cast

Returns:

true if the caster of the spell has this cost

use

void use(Spell spell)

Use this cost, taking it from the caster of the target spell

Parameters:

spell - the spell being cast

refund

void refund(Spell spell)

Refund this cost, giving it back to the caster of the target spell.

Parameters:

spell - the spell refunding the cost