com.elmakers.mine.bukkit.api.magic

Interface CasterProperties

All Superinterfaces:

MagicConfigurable, MagicProperties

All Known Subinterfaces:

MageClass, Wand

public interface CasterProperties
extends MagicConfigurable

Method Summary

Modifier and Type	Method and Description
boolean	add(Wand other)
boolean	addBrush(String key)
boolean	addItem(org.bukkit.inventory.ItemStack item)
boolean	addSpell(String spellKey)
boolean	canProgress()
boolean	checkAndUpgrade(boolean quiet) Checks if this caster can be upgraded to the next ProgressionPath and if so upgrades it.
boolean	forceAddSpell(String key) Adds a spell to an otherwise locked set of properties
Double	getAttribute(String attributeKey)
Collection<String>	getBrushes()
MageController	getController()
org.bukkit.Color	getEffectColor()
int	getEffectiveManaMax()
int	getEffectiveManaRegeneration()
String	getEffectParticleName()
int	getLevel()
Mage	getMage()
float	getMana()
int	getManaMax()
int	getManaRegeneration()
int	getMaxSpells()
ProgressionPath	getPath()
Spell	getSpell(String spellKey) Returns a Spell for a given spell key, if this caster has the spell.
int	getSpellLevel(String spellKey)
Collection<String>	getSpells()
SpellTemplate	getSpellTemplate(String spellKey) Returns the SpellTemplate representing the requested spell key at the correct level.
boolean	hasBrush(String brushKey)
boolean	hasSpell(String spellKey)
boolean	isConsumeFree()
boolean	isCooldownFree()
boolean	isCostFree()
int	randomize(int totalLevels, boolean addSpells)
void	removeMana(float mana)
void	sendMessageKey(String messageKey, String... parameters)
void	setAttribute(String attributeKey, Double attributeValue)
void	setMana(float mana)
void	setManaMax(float manaMax)
void	setManaMax(int manaMax) Deprecated.
void	setManaRegeneration(float manaRegeneration)
void	setManaRegeneration(int manaRegeneration) Deprecated.
void	setPath(String path)
boolean	setSpellLevel(String spellKey, int level)
boolean	setSpelLLevel(String spellKey, int level) Deprecated.
boolean	upgradesAllowed()

Methods inherited from interface com.elmakers.mine.bukkit.api.magic.MagicConfigurable

configure, configure, getStorage, removeProperty, upgrade, upgrade

Methods inherited from interface com.elmakers.mine.bukkit.api.magic.MagicProperties

describe, describe, getBoolean, getBoolean, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getLong, getLong, getProperty, getProperty, getProperty, getSectionList, getString, getString, getStringList, hasProperty, isEmpty

Method Detail

getController

MageController getController()

hasSpell

boolean hasSpell(String spellKey)

hasBrush

boolean hasBrush(String brushKey)

getSpells

Collection<String> getSpells()

getBrushes

Collection<String> getBrushes()

addSpell

boolean addSpell(String spellKey)

addBrush

boolean addBrush(String key)

getMaxSpells

int getMaxSpells()

setSpelLLevel

@Deprecated
boolean setSpelLLevel(String spellKey,
                                  int level)

Deprecated.

setSpellLevel

boolean setSpellLevel(String spellKey,
                      int level)

getSpellLevel

int getSpellLevel(String spellKey)

getMage

Mage getMage()

removeMana

void removeMana(float mana)

getMana

float getMana()

getManaMax

int getManaMax()

getEffectiveManaMax

int getEffectiveManaMax()

setMana

void setMana(float mana)

setManaMax

@Deprecated
void setManaMax(int manaMax)

Deprecated.

setManaMax

void setManaMax(float manaMax)

getManaRegeneration

int getManaRegeneration()

getEffectiveManaRegeneration

int getEffectiveManaRegeneration()

setManaRegeneration

@Deprecated
void setManaRegeneration(int manaRegeneration)

Deprecated.

setManaRegeneration

void setManaRegeneration(float manaRegeneration)

getPath

@Nullable
ProgressionPath getPath()

getLevel

int getLevel()

setPath

void setPath(String path)

canProgress

boolean canProgress()

getAttribute

@Nullable
Double getAttribute(String attributeKey)

setAttribute

void setAttribute(String attributeKey,
                  Double attributeValue)

addItem

boolean addItem(org.bukkit.inventory.ItemStack item)

add

boolean add(Wand other)

upgradesAllowed

boolean upgradesAllowed()

forceAddSpell

boolean forceAddSpell(String key)

Adds a spell to an otherwise locked set of properties

getSpell

@Nullable
Spell getSpell(String spellKey)

Returns a Spell for a given spell key, if this caster has the spell.

Will return the correct spell level for the given spell, regardless of the level requested.

Parameters:

spellKey - The spell key to request

Returns:

the Spell, or null if not present here.

getSpellTemplate

@Nullable
SpellTemplate getSpellTemplate(String spellKey)

Returns the SpellTemplate representing the requested spell key at the correct level.

Parameters:

spellKey - The key of the spell being requested

Returns:

The SpellTemplate requested, or null if this class doesn't have the requested spell

checkAndUpgrade

boolean checkAndUpgrade(boolean quiet)

Checks if this caster can be upgraded to the next ProgressionPath and if so upgrades it.

Returns:

false if the player is blocked based on a path requirement

isCostFree

boolean isCostFree()

isConsumeFree

boolean isConsumeFree()

isCooldownFree

boolean isCooldownFree()

randomize

int randomize(int totalLevels,
              boolean addSpells)

getEffectColor

@Nullable
org.bukkit.Color getEffectColor()

getEffectParticleName

@Nullable
String getEffectParticleName()

sendMessageKey

void sendMessageKey(String messageKey,
                    String... parameters)