com.elmakers.mine.bukkit.api.magic

Interface MageController

public interface MageController

The controller is used for more advanced plugin interaction, and is used heavily by Spells themselves to interact with the Magic plugin's internal functionality.

Method Summary

Modifier and Type	Method and Description
Automaton	addAutomaton(org.bukkit.Location location, String templateKey, String creatorId, String creatorName, org.bukkit.configuration.ConfigurationSection parameters) Deprecated.
void	addFlightExemption(org.bukkit.entity.Player player)
void	addFlightExemption(org.bukkit.entity.Player player, int duration)
MagicBlock	addMagicBlock(org.bukkit.Location location, String templateKey, String creatorId, String creatorName, org.bukkit.configuration.ConfigurationSection parameters)
MagicNPC	addNPC(Mage creator, String name)
boolean	applyModel(org.bukkit.entity.Entity entity, org.bukkit.configuration.ConfigurationSection configuration) Deprecated.
void	cancelScheduledUndo(UndoList undoList)
boolean	canCreateWorlds()
boolean	canTarget(org.bukkit.entity.Entity attacker, org.bukkit.entity.Entity target) Check whether or not one entity is allowed to target another.
boolean	cast(Mage mage, String spellName, org.bukkit.configuration.ConfigurationSection parameters, org.bukkit.command.CommandSender sender)
boolean	cast(String spellName, String[] parameters) Cast a specific Spell, with optional parameters.
String	checkRequirements(MageContext context, Collection<Requirement> requirements)
void	checkResourcePack(org.bukkit.command.CommandSender sender)
void	cleanItem(org.bukkit.inventory.ItemStack itemStack) Remove all custom Magic data from an item, but leave other metadata intact.
boolean	commitAll()
boolean	commitOnQuit()
org.bukkit.World	copyWorld(String worldName, org.bukkit.World copyFrom)
org.bukkit.inventory.ItemStack	createBrushItem(String brushKey)
org.bukkit.inventory.ItemStack	createBrushItem(String materialKey, Wand wand, boolean isItem)
org.bukkit.inventory.ItemStack	createDisabledItem(String magicItemKey, Mage mage)
boolean	createElemental(org.bukkit.Location location, String templateName, org.bukkit.command.CommandSender creator) Create an Elemental of a specific type at a certain location.
org.bukkit.inventory.ItemStack	createGenericItem(String itemKey)
org.bukkit.inventory.ItemStack	createItem(String magicItemKey)
org.bukkit.inventory.ItemStack	createItem(String magicItemKey, boolean brief)
org.bukkit.inventory.ItemStack	createItem(String magicItemKey, Mage mage)
org.bukkit.inventory.ItemStack	createItem(String magicItemKey, Mage mage, boolean brief, ItemUpdatedCallback callback)
ItemData	createItemData(org.bukkit.inventory.ItemStack match)
boolean	createLight(org.bukkit.Location location, int lightlevel, boolean async)
MaterialAndData	createMaterialAndData(org.bukkit.Material material, byte legacyBlockData)
MaterialAndData	createMaterialAndData(org.bukkit.Material material, String blockData)
MaterialAndData	createMaterialAndData(String materialKey)
org.bukkit.inventory.ItemStack	createSpellItem(String spellKey)
org.bukkit.inventory.ItemStack	createSpellItem(String spellKey, boolean brief)
org.bukkit.inventory.ItemStack	createSpellItem(String spellKey, Mage mage, boolean brief)
Wand	createUpgrade(String wandKey)
Wand	createWand(org.bukkit.inventory.ItemStack item) Creates a copy of the given item and turns it into a Wand.
Wand	createWand(String wandKey) Create a new Wand from a template.
org.bukkit.World	createWorld(String worldName)
boolean	damageElemental(org.bukkit.entity.Entity entity, double damage, int fireTicks, org.bukkit.command.CommandSender attacker) Damage the Elemental represented by the given Entity.
boolean	deleteLight(org.bukkit.Location location, boolean async)
void	deleteMage(String id)
void	depositVaultCurrency(org.bukkit.OfflinePlayer player, double amount)
String	describeItem(org.bukkit.inventory.ItemStack item)
org.bukkit.inventory.ItemStack	deserialize(org.bukkit.configuration.ConfigurationSection root, String key) Use this to safely load a Magic ItemStack from a config.
void	disableDrops(org.bukkit.entity.Entity entity)
void	disableItemSpawn()
void	disablePhysics(int interval)
boolean	disguise(org.bukkit.entity.Entity entity, org.bukkit.configuration.ConfigurationSection configuration)
boolean	elementalsEnabled() Check to see if the Elementals plugin is present an enabled.
void	enableItemSpawn()
void	forgetMage(Mage mage) This will remove a Mage after their undo queue and pending spell casts have completed.
Collection<org.bukkit.entity.Entity>	getActiveMobs()
Collection<PlayerWarp>	getAllPlayerWarps(String key)
Collection<String>	getAlternateResourcePacks()
MagicAPI	getAPI()
Collection<String>	getArenaKeys()
Collection<String>	getArenaTemplateKeys()
MagicAttribute	getAttribute(String attributeKey)
Set<String>	getAttributes() Get all attributes, including those registered by external plugins.
Collection<String>	getAutoDiscoverRecipeKeys()
Mage	getAutomaton(String id, String name)
Collection<String>	getAutomatonTemplateKeys() Deprecated.
String	getAutoWandKey(org.bukkit.Material material)
double	getBlockDurability(org.bukkit.block.Block block)
Currency	getBlockExchangeCurrency()
Mage	getBlockMage(String id, String name)
String	getBlockSkin(org.bukkit.Material blockType)
Collection<String>	getBrushKeys()
Set<org.bukkit.Material>	getBuildingMaterials()
MaterialSet	getBuildingMaterialSet()
Double	getBuiltinAttribute(String attributeKey)
Collection<SpellCategory>	getCategories()
SpellCategory	getCategory(String key)
File	getConfigFolder()
Mage	getConsoleMage()
Currency	getCurrency(String key)
Set<String>	getCurrencyKeys()
org.bukkit.entity.Entity	getDamageSource(org.bukkit.entity.Entity entity) Finds the underlying damage source of an entity.
Set<String>	getDamageTypes()
File	getDataFolder()
List<DeathLocation>	getDeathLocations(org.bukkit.entity.Player player)
Icon	getDefaultIcon()
String	getDefaultWandTemplate()
Set<org.bukkit.Material>	getDestructibleMaterials()
String	getDestructibleMaterials(Mage mage, org.bukkit.Location location)
MaterialSet	getDestructibleMaterialSet()
Double	getEarns(org.bukkit.inventory.ItemStack item)
Double	getEarns(org.bukkit.inventory.ItemStack item, String currency)
Collection<String>	getEffectKeys()
Collection<EffectPlayer>	getEffects(String effectKey) Retrieve a list of effects defined in effects.yml
double	getElementalScale(org.bukkit.entity.Entity entity) Get the current scale of an Elemental.
String	getEntityDisplayName(org.bukkit.entity.Entity entity)
String	getEntityName(org.bukkit.entity.Entity entity)
String	getExample() Get the primary example loaded via "example: ..." in config.yml
Collection<String>	getExamples() Return all example configs that are available built into the plugin
Collection<String>	getExternalExamples() Return all external example configs that are referenced by the builtin configs or have been loaded with the mconfig command
String	getExternalExampleURL(String exampleKey) Return the URL for an existing loaded example This may be from the builtin configs, or one that was previously fetched via the mconfig command
String	getHeroesSkillPrefix()
Map<String,org.bukkit.Location>	getHomeLocations(org.bukkit.entity.Player player) Deprecated.
Icon	getIcon(String key)
Set<String>	getIconKeys()
Wand	getIfWand(org.bukkit.inventory.ItemStack item) Only returns a Wand instance of the item is already a wand.
Set<String>	getInternalAttributes() Get all attributes defined in attributes.yml or other configs.
ItemData	getItem(org.bukkit.inventory.ItemStack match)
ItemData	getItem(String key)
String	getItemKey(org.bukkit.inventory.ItemStack item)
Set<String>	getItemKeys()
Kit	getKit(String key)
Set<String>	getKitKeys()
int	getLightCount()
Collection<String>	getLoadedExamples() Return all example configs that have been loaded via example: or add_examples: in config.yml
Collection<String>	getLocalizations() Return all builtin localizations.
Collection<org.bukkit.Chunk>	getLockedChunks()
Logger	getLogger() Retrieve the Logger for this API instance.
Collection<LostWand>	getLostWands() Return a list of all known LostWand records.
Mage	getMage(org.bukkit.command.CommandSender sender)
Mage	getMage(org.bukkit.entity.Entity entity)
Mage	getMage(org.bukkit.entity.Player player)
Mage	getMage(String id, String name)
Set<String>	getMageClassKeys()
MageClassTemplate	getMageClassTemplate(String key)
Collection<Mage>	getMages()
MagicBlock	getMagicBlock(String name)
Collection<MagicBlock>	getMagicBlocks()
Collection<String>	getMagicBlockTemplateKeys()
Warp	getMagicWarp(String warpKey)
Collection<? extends Warp>	getMagicWarps()
org.bukkit.inventory.ItemStack	getMap(int mapId)
MapController	getMaps() Get Magic's URLMap controller, for generating custom image maps.
Set<org.bukkit.Material>	getMaterialSet(String string) Deprecated.
MaterialSetManager	getMaterialSetManager()
Collection<String>	getMaterialSets() Deprecated.
int	getMaxHeight(org.bukkit.World world)
int	getMaxUndoPersistSize()
int	getMaxWandFillLevel()
String	getMessagePrefix()
Messages	getMessages() Get Magic's localization store.
int	getMessageThrottle()
int	getMinHeight(org.bukkit.World world)
EntityData	getMob(org.bukkit.configuration.ConfigurationSection parameters)
EntityData	getMob(org.bukkit.entity.Entity entity)
EntityData	getMob(String key)
EntityData	getMobByName(String name)
org.bukkit.Material	getMobEgg(org.bukkit.entity.EntityType mobType)
Set<String>	getMobKeys() Will not return hidden mobs
Set<String>	getMobKeys(boolean includeHidden)
Collection<Mage>	getMobMages()
String	getMobSkin(org.bukkit.entity.EntityType mobType)
ModelEngine	getModelEngine() ModelEngine integration
ModifierTemplate	getModifierTemplate(String key)
Collection<String>	getModifierTemplateKeys()
String	getMythicMobKey(org.bukkit.entity.Entity entity)
Double	getMythicMobLevel(org.bukkit.entity.Entity entity)
MagicNPC	getNPC(org.bukkit.entity.Entity entity)
MagicNPC	getNPC(String id)
MagicNPC	getNPC(UUID id)
Set<String>	getNPCKeys()
Collection<MagicNPC>	getNPCs()
ItemData	getOrCreateItem(String key)
ItemData	getOrCreateItemOrWand(String key) Deprecated.
ItemData	getOrCreateMagicItem(String key) Deprecated.
WandUpgradePath	getPath(String key)
Boolean	getPersonalCastPermission(org.bukkit.entity.Player player, SpellTemplate spell, org.bukkit.Location location)
String	getPlaceholder(org.bukkit.entity.Player player, String namespace, String placeholder)
Collection<String>	getPlayerNames()
String	getPlayerSkin(org.bukkit.entity.Player player)
Set<String>	getPlayerWarpProviderKeys()
Collection<PlayerWarp>	getPlayerWarps(org.bukkit.entity.Player player, String key)
org.bukkit.plugin.Plugin	getPlugin() Retrieve the Plugin that owns this controller.
Random	getRandom() Retrieve a static Random instance to use for randomization.
Collection<String>	getRecipeKeys()
MaterialAndData	getRedstoneReplacement()
String	getReflectiveMaterials(Mage mage, org.bukkit.Location location)
Boolean	getRegionCastPermission(org.bukkit.entity.Player player, SpellTemplate spell, org.bukkit.Location location)
Mage	getRegisteredMage(org.bukkit.entity.Entity entity)
Mage	getRegisteredMage(String mageId)
Collection<Requirement>	getRequirements(org.bukkit.configuration.ConfigurationSection configuration)
String	getResourcePackURL()
String	getResourcePackURL(org.bukkit.command.CommandSender sender)
Set<org.bukkit.Material>	getRestrictedMaterials()
MaterialSet	getRestrictedMaterialSet()
String	getSkillsSpell() Get the spell that should be cast when a player uses the /mskills command.
org.bukkit.inventory.ItemStack	getSkull(org.bukkit.entity.Entity entity, String itemName) Deprecated.
org.bukkit.inventory.ItemStack	getSkull(org.bukkit.entity.Entity entity, String itemName, ItemUpdatedCallback callback)
org.bukkit.inventory.ItemStack	getSkull(org.bukkit.entity.Player player, String itemName)
org.bukkit.inventory.ItemStack	getSkull(String ownerName, String itemName) Deprecated.
org.bukkit.inventory.ItemStack	getSkull(String ownerName, String itemName, ItemUpdatedCallback callback)
org.bukkit.inventory.ItemStack	getSkull(UUID uuid, String itemName, ItemUpdatedCallback callback)
org.bukkit.inventory.ItemStack	getSpawnEgg(String mobType)
String	getSpell(org.bukkit.inventory.ItemStack item)
String	getSpellArgs(org.bukkit.inventory.ItemStack item)
Set<String>	getSpellOverrides(Mage mage, org.bukkit.Location location)
SpellTemplate	getSpellTemplate(String key)
Collection<String>	getSpellTemplateKeys()
Collection<SpellTemplate>	getSpellTemplates()
Collection<SpellTemplate>	getSpellTemplates(boolean showHidden)
int	getSPMaximum()
org.bukkit.Location	getTownLocation(org.bukkit.entity.Player player)
Set<org.bukkit.entity.EntityType>	getUndoEntityTypes()
org.bukkit.inventory.ItemStack	getURLSkull(String url)
Wand	getWand(org.bukkit.configuration.ConfigurationSection config)
Wand	getWand(org.bukkit.inventory.ItemStack item) Obtains a wand from an item stack.
String	getWandKey(org.bukkit.inventory.ItemStack item)
Set<String>	getWandPathKeys()
Object	getWandProperty(org.bukkit.inventory.ItemStack itemStack, String key)
<T> T	getWandProperty(org.bukkit.inventory.ItemStack itemStack, String key, T defaultValue)
WandTemplate	getWandTemplate(String key)
Collection<String>	getWandTemplateKeys()
Collection<WandTemplate>	getWandTemplates()
org.bukkit.Location	getWarp(String warpName)
Double	getWorth(org.bukkit.inventory.ItemStack item)
Double	getWorth(org.bukkit.inventory.ItemStack item, String currency)
Double	getWorth(org.bukkit.Material material, String currency)
double	getWorthBase()
org.bukkit.inventory.ItemStack	getWorthItem()
double	getWorthItemAmount()
double	getWorthSkillPoints()
double	getWorthXP()
void	giveItemToPlayer(org.bukkit.entity.Player player, org.bukkit.inventory.ItemStack itemStack)
boolean	hasBypassPermission(org.bukkit.command.CommandSender sender)
boolean	hasCastPermission(org.bukkit.command.CommandSender sender, SpellTemplate spell)
boolean	hasDisguises()
boolean	hasItem(org.bukkit.entity.Player player, org.bukkit.inventory.ItemStack item)
boolean	hasPermission(org.bukkit.command.CommandSender sender, String pNode)
boolean	hasPermission(org.bukkit.command.CommandSender sender, String pNode, boolean defaultValue) Deprecated.
boolean	hasPermission(org.bukkit.entity.Entity entity, String pNode)
void	info(String debug) Log a message, but only if debug messages are enabled
void	info(String debug, int debugLevel)
boolean	inTaggedRegion(org.bukkit.Location location, Set<String> tags)
boolean	isDamaging()
boolean	isDisguised(org.bukkit.entity.Entity entity)
boolean	isElemental(org.bukkit.entity.Entity entity) Check to see if the given Entity is an Elemental, or part of an Elemental.
boolean	isExitAllowed(org.bukkit.entity.Player player, org.bukkit.Location location)
boolean	isFileLockingEnabled()
boolean	isFriendly(org.bukkit.entity.Entity source, org.bukkit.entity.Entity target) This checks scoreboard teams or integrated party groupings, as configured and provided by other plugins, to see if two entities are "friends" with one another.
boolean	isLegacyIconsEnabled()
boolean	isLightingAvailable()
boolean	isLocked(org.bukkit.block.Block block)
boolean	isMage(org.bukkit.entity.Entity entity)
boolean	isMagic(org.bukkit.inventory.ItemStack item)
boolean	isMagicNPC(org.bukkit.entity.Entity entity)
boolean	isMythicMobKey(String mythicMobKey)
boolean	isNPC(org.bukkit.entity.Entity entity) Check to see if the given Entity is an NPC of any kind.
boolean	isPathUpgradingEnabled()
boolean	isPet(org.bukkit.entity.Entity entity)
boolean	isPVPAllowed(org.bukkit.entity.Player player, org.bukkit.Location location)
boolean	isResourcePackEnabled()
boolean	isResourcePackEnabledByDefault()
boolean	isResourcePackSetByServer()
boolean	isSkill(org.bukkit.inventory.ItemStack item)
boolean	isSPEarnEnabled()
boolean	isSpellProgressionEnabled()
boolean	isSpellUpgradingEnabled()
boolean	isSPEnabled()
boolean	isStaticNPC(org.bukkit.entity.Entity entity)
boolean	isUndoable(org.bukkit.Material material)
boolean	isUrlIconsEnabled()
boolean	isVanished(org.bukkit.entity.Entity entity)
boolean	isVaultCurrencyEnabled()
boolean	isWand(org.bukkit.inventory.ItemStack item)
boolean	isWandUpgrade(org.bukkit.inventory.ItemStack item)
boolean	itemsAreEqual(org.bukkit.inventory.ItemStack first, org.bukkit.inventory.ItemStack second)
boolean	itemsAreEqual(org.bukkit.inventory.ItemStack first, org.bukkit.inventory.ItemStack second, boolean ignoreDamage)
void	loadConfigurationQuietly(org.bukkit.command.CommandSender sender)
Collection<EffectPlayer>	loadEffects(org.bukkit.configuration.ConfigurationSection configuration, String effectKey)
Collection<EffectPlayer>	loadEffects(org.bukkit.configuration.ConfigurationSection configuration, String effectKey, String logContext)
Collection<EffectPlayer>	loadEffects(org.bukkit.configuration.ConfigurationSection configuration, String effectKey, String logContext, org.bukkit.configuration.ConfigurationSection parameterMap)
void	loadItemTemplate(String key, org.bukkit.configuration.ConfigurationSection itemNode)
EntityData	loadMob(org.bukkit.configuration.ConfigurationSection configuration)
Schematic	loadSchematic(String name)
void	loadWandTemplate(String key, org.bukkit.configuration.ConfigurationSection wandNode)
void	lockChunk(org.bukkit.Chunk chunk)
void	logBlockChange(Mage mage, org.bukkit.block.BlockState priorState, org.bukkit.block.BlockState newState)
void	managePlayerData(boolean external, boolean backupInventories)
void	onEntitiesLoaded(org.bukkit.Chunk chunk, List<org.bukkit.entity.Entity> entities)
boolean	onEntityPickupItem(org.bukkit.entity.Entity entity, org.bukkit.entity.Item item)
void	onPlayerJump(org.bukkit.entity.Player player, org.bukkit.util.Vector velocity)
void	onResourcePackStatus(org.bukkit.entity.Player player, ResourcePackStatus status)
void	playEffects(String effectKey, EffectContext context)
void	playEffects(String effectKey, org.bukkit.Location sourceLocation, org.bukkit.Location targetLocation)
boolean	promptNoResourcePack(org.bukkit.entity.Player player)
boolean	promptResourcePack(org.bukkit.entity.Player player)
boolean	register(MagicProvider provider) Register an implementation of one or more MageProvider interfaces.
void	registerMob(org.bukkit.entity.Entity entity, EntityData entityData)
void	removeFlightExemption(org.bukkit.entity.Player player)
void	removeMage(Mage mage)
void	removeMage(String id)
boolean	removeMagicBlock(org.bukkit.Location location)
void	removeNPC(MagicNPC npc)
org.bukkit.entity.Entity	replaceMob(org.bukkit.entity.Entity targetEntity, EntityData replaceType, boolean force, org.bukkit.event.entity.CreatureSpawnEvent.SpawnReason reason)
void	scheduleUndo(UndoList undoList)
boolean	sendMail(org.bukkit.command.CommandSender sender, String fromPlayer, String toPlayer, String message)
void	sendPlayerToServer(org.bukkit.entity.Player player, String server)
boolean	sendResourcePack(org.bukkit.entity.Player player)
boolean	sendResourcePackToAllPlayers(org.bukkit.command.CommandSender sender)
void	sendToMages(String message, org.bukkit.Location location)
void	serialize(org.bukkit.configuration.ConfigurationSection root, String key, org.bukkit.inventory.ItemStack item) Use this to safely save a Magic ItemStack to a config.
void	setDisableSpawnReplacement(boolean disable)
boolean	setElementalScale(org.bukkit.entity.Entity entity, double scale) Change the scale of an Elemental, making it bigger or smaller.
void	setForceSpawn(boolean force)
void	setMythicMobLevel(org.bukkit.entity.Entity entity, double level)
String	setPlaceholders(org.bukkit.entity.Player player, String message)
void	setSkullOwner(org.bukkit.block.Skull skull, String ownerName)
void	setSkullOwner(org.bukkit.block.Skull block, UUID uuid)
boolean	showConsoleCastFeedback()
boolean	soundsEnabled() Check to see if Magic sounds are enabled.
org.bukkit.entity.Entity	spawnMob(String key, org.bukkit.Location location)
org.bukkit.entity.Entity	spawnMythicMob(String mythicMobKey, org.bukkit.Location location)
boolean	takeItem(org.bukkit.entity.Player player, org.bukkit.inventory.ItemStack item)
void	timeSkipped(org.bukkit.World world, long skippedAmount)
UndoList	undoAny(org.bukkit.block.Block target)
UndoList	undoRecent(org.bukkit.block.Block target, int timeout)
void	unloadItemTemplate(String key)
void	unloadWandTemplate(String key)
void	unlockChunk(org.bukkit.Chunk chunk)
void	update(BlockList blockList)
void	updateBlock(org.bukkit.block.Block block)
void	updateBlock(String worldName, int x, int y, int z)
void	updateConfiguration(org.bukkit.command.CommandSender sender) Update all fetched examples and then reload configuration
boolean	updateLight(org.bukkit.Location location)
boolean	updateLight(org.bukkit.Location location, boolean force)
void	updateVolume(String worldName, int minx, int miny, int minz, int maxx, int maxy, int maxz)
void	warpPlayerToServer(org.bukkit.entity.Player player, String server, String warp)

Method Detail

getLogger

Logger getLogger()

Retrieve the Logger for this API instance.

Returns:

The logger being used by the API provider (usually MagicPlugin).

info

void info(String debug)

Log a message, but only if debug messages are enabled

Parameters:

debug - The message to log

info

void info(String debug,
          int debugLevel)

getPlugin

org.bukkit.plugin.Plugin getPlugin()

Retrieve the Plugin that owns this controller.

This will generally be the MagicPlugin, but.. maybe not always?

Returns:

The owning plugin instance

getAPI

MagicAPI getAPI()

getConfigFolder

File getConfigFolder()

getDataFolder

File getDataFolder()

getLostWands

Collection<LostWand> getLostWands()

Return a list of all known LostWand records.

Returns:

A list of all known LostWand data.

createWand

@Nonnull
Wand createWand(@Nonnull
                         org.bukkit.inventory.ItemStack item)

Creates a copy of the given item and turns it into a Wand.

Parameters:

item - The item to get a wand of.

Returns:

The wand of this item.

createWand

@Nullable
Wand createWand(String wandKey)

Create a new Wand from a template.

Once created, a Wand is a unique item. It "remembers" which template it was created from, but this is currently not used for anything.

Parameters:

wandKey - The template key, or blank for a default wand.

Returns:

A new Wand instance, with a useable ItemStack.

createItem

@Nullable
org.bukkit.inventory.ItemStack createItem(String magicItemKey)

createItem

@Nullable
org.bukkit.inventory.ItemStack createItem(String magicItemKey,
                                                    Mage mage)

createItem

@Nullable
org.bukkit.inventory.ItemStack createItem(String magicItemKey,
                                                    boolean brief)

createItem

@Nullable
org.bukkit.inventory.ItemStack createItem(String magicItemKey,
                                                    Mage mage,
                                                    boolean brief,
                                                    ItemUpdatedCallback callback)

createGenericItem

@Nullable
org.bukkit.inventory.ItemStack createGenericItem(String itemKey)

createUpgrade

Wand createUpgrade(String wandKey)

createSpellItem

@Nullable
org.bukkit.inventory.ItemStack createSpellItem(String spellKey)

createSpellItem

@Nullable
org.bukkit.inventory.ItemStack createSpellItem(String spellKey,
                                                         boolean brief)

createSpellItem

@Nullable
org.bukkit.inventory.ItemStack createSpellItem(String spellKey,
                                                         Mage mage,
                                                         boolean brief)

createBrushItem

@Nullable
org.bukkit.inventory.ItemStack createBrushItem(String brushKey)

createBrushItem

@Nullable
org.bukkit.inventory.ItemStack createBrushItem(String materialKey,
                                                         Wand wand,
                                                         boolean isItem)

createDisabledItem

@Nullable
org.bukkit.inventory.ItemStack createDisabledItem(String magicItemKey,
                                                            Mage mage)

getIfWand

@Nullable
Wand getIfWand(org.bukkit.inventory.ItemStack item)

Only returns a Wand instance of the item is already a wand.

getWand

Wand getWand(org.bukkit.inventory.ItemStack item)

Obtains a wand from an item stack. (No copying is done)

Parameters:

item - The item to get a wand of.

Returns:

The wand of this item.

Throws:

IllegalArgumentException - If the item is not a wand.

getWand

Wand getWand(org.bukkit.configuration.ConfigurationSection config)

getWandTemplate

@Nullable
WandTemplate getWandTemplate(String key)

getWandTemplateKeys

Collection<String> getWandTemplateKeys()

getWandTemplates

Collection<WandTemplate> getWandTemplates()

loadWandTemplate

void loadWandTemplate(String key,
                      org.bukkit.configuration.ConfigurationSection wandNode)

unloadWandTemplate

void unloadWandTemplate(String key)

describeItem

@Nonnull
String describeItem(org.bukkit.inventory.ItemStack item)

getItemKey

String getItemKey(org.bukkit.inventory.ItemStack item)

getWandKey

@Nullable
String getWandKey(org.bukkit.inventory.ItemStack item)

takeItem

boolean takeItem(org.bukkit.entity.Player player,
                 org.bukkit.inventory.ItemStack item)

hasItem

boolean hasItem(org.bukkit.entity.Player player,
                org.bukkit.inventory.ItemStack item)

getCategory

@Nullable
SpellCategory getCategory(String key)

getCategories

Collection<SpellCategory> getCategories()

getSpellTemplateKeys

Collection<String> getSpellTemplateKeys()

getSpellTemplates

Collection<SpellTemplate> getSpellTemplates()

getSpellTemplates

Collection<SpellTemplate> getSpellTemplates(boolean showHidden)

getAutomatonTemplateKeys

@Deprecated
Collection<String> getAutomatonTemplateKeys()

Deprecated.

getMagicBlockTemplateKeys

Collection<String> getMagicBlockTemplateKeys()

getRecipeKeys

Collection<String> getRecipeKeys()

getAutoDiscoverRecipeKeys

Collection<String> getAutoDiscoverRecipeKeys()

getArenaKeys

Collection<String> getArenaKeys()

getArenaTemplateKeys

Collection<String> getArenaTemplateKeys()

getSpellTemplate

@Nullable
SpellTemplate getSpellTemplate(String key)

getWandPathKeys

Set<String> getWandPathKeys()

getPath

@Nullable
WandUpgradePath getPath(String key)

updateBlock

void updateBlock(org.bukkit.block.Block block)

updateBlock

void updateBlock(String worldName,
                 int x,
                 int y,
                 int z)

updateVolume

void updateVolume(String worldName,
                  int minx,
                  int miny,
                  int minz,
                  int maxx,
                  int maxy,
                  int maxz)

update

void update(BlockList blockList)

canCreateWorlds

boolean canCreateWorlds()

getMaxUndoPersistSize

int getMaxUndoPersistSize()

loadSchematic

@Nullable
Schematic loadSchematic(String name)

getMaterialSetManager

MaterialSetManager getMaterialSetManager()

Returns:

Manager of material sets.

getMaterialSets

@Deprecated
Collection<String> getMaterialSets()

Deprecated.

getMaterialSet

@Nullable
 @Deprecated
Set<org.bukkit.Material> getMaterialSet(String string)

Deprecated.

sendToMages

void sendToMages(String message,
                 org.bukkit.Location location)

getMages

Collection<Mage> getMages()

getMobMages

Collection<Mage> getMobMages()

getActiveMobs

Collection<org.bukkit.entity.Entity> getActiveMobs()

removeMage

void removeMage(Mage mage)

removeMage

void removeMage(String id)

forgetMage

void forgetMage(Mage mage)

This will remove a Mage after their undo queue and pending spell casts have completed.

getMessagePrefix

String getMessagePrefix()

getSpellOverrides

@Nullable
Set<String> getSpellOverrides(Mage mage,
                                        org.bukkit.Location location)

getReflectiveMaterials

@Nullable
String getReflectiveMaterials(Mage mage,
                                        org.bukkit.Location location)

getDestructibleMaterials

@Nullable
String getDestructibleMaterials(Mage mage,
                                          org.bukkit.Location location)

getDestructibleMaterials

Set<org.bukkit.Material> getDestructibleMaterials()

getBuildingMaterials

Set<org.bukkit.Material> getBuildingMaterials()

getRestrictedMaterials

Set<org.bukkit.Material> getRestrictedMaterials()

getDestructibleMaterialSet

MaterialSet getDestructibleMaterialSet()

getBuildingMaterialSet

MaterialSet getBuildingMaterialSet()

getRestrictedMaterialSet

MaterialSet getRestrictedMaterialSet()

getPlayerNames

Collection<String> getPlayerNames()

getMessageThrottle

int getMessageThrottle()

isMage

boolean isMage(@Nonnull
               org.bukkit.entity.Entity entity)

getMage

@Nonnull
Mage getMage(@Nonnull
                      org.bukkit.command.CommandSender sender)

getMage

@Nonnull
Mage getMage(@Nonnull
                      org.bukkit.entity.Player player)

getMage

@Nonnull
Mage getMage(@Nonnull
                      org.bukkit.entity.Entity entity)

getMage

@Nonnull
Mage getMage(@Nonnull
                      String id,
                      @Nonnull
                      String name)

getRegisteredMage

@Nullable
Mage getRegisteredMage(@Nonnull
                                 String mageId)

getRegisteredMage

@Nullable
Mage getRegisteredMage(@Nonnull
                                 org.bukkit.entity.Entity entity)

getAutomaton

@Nonnull
Mage getAutomaton(@Nonnull
                           String id,
                           @Nonnull
                           String name)

getBlockMage

@Nonnull
Mage getBlockMage(@Nonnull
                           String id,
                           @Nonnull
                           String name)

getConsoleMage

@Nonnull
Mage getConsoleMage()

showConsoleCastFeedback

boolean showConsoleCastFeedback()

getBrushKeys

Collection<String> getBrushKeys()

commitAll

boolean commitAll()

disablePhysics

void disablePhysics(int interval)

hasPermission

@Deprecated
boolean hasPermission(org.bukkit.command.CommandSender sender,
                                  String pNode,
                                  boolean defaultValue)

Deprecated.

hasPermission

boolean hasPermission(org.bukkit.command.CommandSender sender,
                      String pNode)

hasPermission

boolean hasPermission(org.bukkit.entity.Entity entity,
                      String pNode)

hasCastPermission

boolean hasCastPermission(org.bukkit.command.CommandSender sender,
                          SpellTemplate spell)

getRegionCastPermission

@Nullable
Boolean getRegionCastPermission(org.bukkit.entity.Player player,
                                          SpellTemplate spell,
                                          org.bukkit.Location location)

getPersonalCastPermission

@Nullable
Boolean getPersonalCastPermission(org.bukkit.entity.Player player,
                                            SpellTemplate spell,
                                            org.bukkit.Location location)

isPVPAllowed

boolean isPVPAllowed(org.bukkit.entity.Player player,
                     org.bukkit.Location location)

isExitAllowed

boolean isExitAllowed(org.bukkit.entity.Player player,
                      org.bukkit.Location location)

hasBypassPermission

boolean hasBypassPermission(org.bukkit.command.CommandSender sender)

canTarget

boolean canTarget(org.bukkit.entity.Entity attacker,
                  org.bukkit.entity.Entity target)

Check whether or not one entity is allowed to target another.

This takes into account region-based PVP permissions, mob protection, scoreboard teams and parties via other plugins, depending on global settings.

PvP and friendly fire checks can be overridden on a per-spell or global basis.

Parameters:

attacker - The attacking entity

target - The entity potentially being targeted

Returns:

true if "attacker" can target "target"

isFriendly

boolean isFriendly(org.bukkit.entity.Entity source,
                   org.bukkit.entity.Entity target)

This checks scoreboard teams or integrated party groupings, as configured and provided by other plugins, to see if two entities are "friends" with one another.

This is primarily used for "only_friendly: true" spells to disallow targeting non-friend players.

Parameters:

source - The source entity

target - The target entity

Returns:

true if "source" and "target" are considered friendly.

isUrlIconsEnabled

boolean isUrlIconsEnabled()

isLegacyIconsEnabled

boolean isLegacyIconsEnabled()

getUndoEntityTypes

Set<org.bukkit.entity.EntityType> getUndoEntityTypes()

sendMail

boolean sendMail(org.bukkit.command.CommandSender sender,
                 String fromPlayer,
                 String toPlayer,
                 String message)

getWarp

@Nullable
org.bukkit.Location getWarp(String warpName)

getTownLocation

@Nullable
org.bukkit.Location getTownLocation(org.bukkit.entity.Player player)

getHomeLocations

@Deprecated
 @Nullable
Map<String,org.bukkit.Location> getHomeLocations(org.bukkit.entity.Player player)

Deprecated.

This method is deprecated, it doesn't allow for two homes with the same name. Use getPlayerWarps instead, "fields" is the correct key to specify to get the PreciousStones homes that this method returns.

giveItemToPlayer

void giveItemToPlayer(org.bukkit.entity.Player player,
                      org.bukkit.inventory.ItemStack itemStack)

undoAny

@Nullable
UndoList undoAny(org.bukkit.block.Block target)

undoRecent

@Nullable
UndoList undoRecent(org.bukkit.block.Block target,
                              int timeout)

scheduleUndo

void scheduleUndo(UndoList undoList)

cancelScheduledUndo

void cancelScheduledUndo(UndoList undoList)

getEntityName

String getEntityName(org.bukkit.entity.Entity entity)

getEntityDisplayName

String getEntityDisplayName(org.bukkit.entity.Entity entity)

getMaxWandFillLevel

int getMaxWandFillLevel()

getWorthBase

double getWorthBase()

getWorthXP

double getWorthXP()

getWorthSkillPoints

double getWorthSkillPoints()

getWorthItem

@Nullable
org.bukkit.inventory.ItemStack getWorthItem()

getWorthItemAmount

double getWorthItemAmount()

getCurrencyKeys

@Nonnull
Set<String> getCurrencyKeys()

getCurrency

Currency getCurrency(String key)

itemsAreEqual

boolean itemsAreEqual(org.bukkit.inventory.ItemStack first,
                      org.bukkit.inventory.ItemStack second)

itemsAreEqual

boolean itemsAreEqual(org.bukkit.inventory.ItemStack first,
                      org.bukkit.inventory.ItemStack second,
                      boolean ignoreDamage)

addFlightExemption

void addFlightExemption(org.bukkit.entity.Player player,
                        int duration)

addFlightExemption

void addFlightExemption(org.bukkit.entity.Player player)

removeFlightExemption

void removeFlightExemption(org.bukkit.entity.Player player)

elementalsEnabled

boolean elementalsEnabled()

Check to see if the Elementals plugin is present an enabled.

If so, Magic will work as a passthrough API.

createElemental

boolean createElemental(org.bukkit.Location location,
                        String templateName,
                        org.bukkit.command.CommandSender creator)

Create an Elemental of a specific type at a certain location.

Parameters:

location - The location at which to create the elemental.

templateName - The name of the elemental's template description

creator - The creator of the elemental, may be null.

Returns:

False on failure, such as if there are already too many elementals in the world.

isElemental

boolean isElemental(org.bukkit.entity.Entity entity)

Check to see if the given Entity is an Elemental, or part of an Elemental.

Parameters:

entity - The entity to check

Returns:

true if this Entity is an Elemental, or part of one.

isNPC

boolean isNPC(org.bukkit.entity.Entity entity)

Check to see if the given Entity is an NPC of any kind.

This currently integrates with Citizens.

isStaticNPC

boolean isStaticNPC(org.bukkit.entity.Entity entity)

isPet

boolean isPet(org.bukkit.entity.Entity entity)

isMagicNPC

boolean isMagicNPC(org.bukkit.entity.Entity entity)

isVanished

boolean isVanished(org.bukkit.entity.Entity entity)

disableDrops

void disableDrops(org.bukkit.entity.Entity entity)

damageElemental

boolean damageElemental(org.bukkit.entity.Entity entity,
                        double damage,
                        int fireTicks,
                        org.bukkit.command.CommandSender attacker)

Damage the Elemental represented by the given Entity.

Parameters:

entity - The entity to use to determine which Elemental to damage.

damage - The amount of damage to apply.

fireTicks - The duration of fire, if any, to apply.

attacker - The attacker, initiator of damage. May be a command block or console, or null.

Returns:

False if the entity is not a living Elemental.

setElementalScale

boolean setElementalScale(org.bukkit.entity.Entity entity,
                          double scale)

Change the scale of an Elemental, making it bigger or smaller.

Elementals will limit their own size within sane limits. (0.1 - 5.0 for instance).

Parameters:

entity - The entity representing the Elemental to scale

scale - The new scale

Returns:

False if the entity is not an Elemental, or other failure

getElementalScale

double getElementalScale(org.bukkit.entity.Entity entity)

Get the current scale of an Elemental.

Parameters:

entity - The entity representing the Elemental to interrogate

Returns:

The scale of the elemental, or 0 on error.

soundsEnabled

boolean soundsEnabled()

Check to see if Magic sounds are enabled.

Returns:

true if sounds are enabled.

getRedstoneReplacement

MaterialAndData getRedstoneReplacement()

getMessages

Messages getMessages()

Get Magic's localization store.

Returns:

The Messages controller for getting in-game text.

getMaps

MapController getMaps()

Get Magic's URLMap controller, for generating custom image maps.

deserialize

@Nullable
org.bukkit.inventory.ItemStack deserialize(org.bukkit.configuration.ConfigurationSection root,
                                                     String key)

Use this to safely load a Magic ItemStack from a config.

serialize

void serialize(org.bukkit.configuration.ConfigurationSection root,
               String key,
               org.bukkit.inventory.ItemStack item)

Use this to safely save a Magic ItemStack to a config.

isLocked

boolean isLocked(org.bukkit.block.Block block)

sendPlayerToServer

void sendPlayerToServer(org.bukkit.entity.Player player,
                        String server)

warpPlayerToServer

void warpPlayerToServer(org.bukkit.entity.Player player,
                        String server,
                        String warp)

isDisguised

boolean isDisguised(org.bukkit.entity.Entity entity)

hasDisguises

boolean hasDisguises()

isPathUpgradingEnabled

boolean isPathUpgradingEnabled()

isSpellUpgradingEnabled

boolean isSpellUpgradingEnabled()

isSpellProgressionEnabled

boolean isSpellProgressionEnabled()

isSPEnabled

boolean isSPEnabled()

isSPEarnEnabled

boolean isSPEarnEnabled()

isVaultCurrencyEnabled

boolean isVaultCurrencyEnabled()

depositVaultCurrency

void depositVaultCurrency(org.bukkit.OfflinePlayer player,
                          double amount)

getSPMaximum

int getSPMaximum()

deleteMage

void deleteMage(String id)

disableItemSpawn

void disableItemSpawn()

enableItemSpawn

void enableItemSpawn()

setForceSpawn

void setForceSpawn(boolean force)

getSpell

@Nullable
String getSpell(org.bukkit.inventory.ItemStack item)

getSpellArgs

@Nullable
String getSpellArgs(org.bukkit.inventory.ItemStack item)

getNPCKeys

Set<String> getNPCKeys()

getMobKeys

Set<String> getMobKeys()

Will not return hidden mobs

getMobKeys

Set<String> getMobKeys(boolean includeHidden)

spawnMob

@Nullable
org.bukkit.entity.Entity spawnMob(String key,
                                            org.bukkit.Location location)

getMob

@Nullable
EntityData getMob(String key)

getMob

@Nullable
EntityData getMob(org.bukkit.configuration.ConfigurationSection parameters)

getMob

@Nullable
EntityData getMob(org.bukkit.entity.Entity entity)

replaceMob

@Nullable
org.bukkit.entity.Entity replaceMob(org.bukkit.entity.Entity targetEntity,
                                              EntityData replaceType,
                                              boolean force,
                                              org.bukkit.event.entity.CreatureSpawnEvent.SpawnReason reason)

getMobByName

@Nullable
EntityData getMobByName(String name)

loadMob

EntityData loadMob(org.bukkit.configuration.ConfigurationSection configuration)

getBlockSkin

@Nullable
String getBlockSkin(org.bukkit.Material blockType)

getMobSkin

@Nullable
String getMobSkin(org.bukkit.entity.EntityType mobType)

getPlayerSkin

@Nullable
String getPlayerSkin(org.bukkit.entity.Player player)

getMobEgg

@Nullable
org.bukkit.Material getMobEgg(org.bukkit.entity.EntityType mobType)

getSkull

@Nonnull
 @Deprecated
org.bukkit.inventory.ItemStack getSkull(org.bukkit.entity.Entity entity,
                                                              String itemName)

Deprecated.

getSkull

@Nonnull
org.bukkit.inventory.ItemStack getSkull(org.bukkit.entity.Entity entity,
                                                 String itemName,
                                                 ItemUpdatedCallback callback)

getSkull

@Nonnull
org.bukkit.inventory.ItemStack getSkull(org.bukkit.entity.Player player,
                                                 String itemName)

getSkull

@Nonnull
 @Deprecated
org.bukkit.inventory.ItemStack getSkull(String ownerName,
                                                              String itemName)

Deprecated.

getSkull

@Nonnull
org.bukkit.inventory.ItemStack getSkull(String ownerName,
                                                 String itemName,
                                                 ItemUpdatedCallback callback)

getSkull

@Nonnull
org.bukkit.inventory.ItemStack getSkull(UUID uuid,
                                                 String itemName,
                                                 ItemUpdatedCallback callback)

getMap

@Nonnull
org.bukkit.inventory.ItemStack getMap(int mapId)

setSkullOwner

void setSkullOwner(org.bukkit.block.Skull skull,
                   String ownerName)

setSkullOwner

void setSkullOwner(org.bukkit.block.Skull block,
                   UUID uuid)

getURLSkull

@Nonnull
org.bukkit.inventory.ItemStack getURLSkull(String url)

checkResourcePack

void checkResourcePack(org.bukkit.command.CommandSender sender)

sendResourcePackToAllPlayers

boolean sendResourcePackToAllPlayers(org.bukkit.command.CommandSender sender)

sendResourcePack

boolean sendResourcePack(org.bukkit.entity.Player player)

promptResourcePack

boolean promptResourcePack(org.bukkit.entity.Player player)

promptNoResourcePack

boolean promptNoResourcePack(org.bukkit.entity.Player player)

getResourcePackURL

@Nullable
String getResourcePackURL()

getResourcePackURL

@Nullable
String getResourcePackURL(org.bukkit.command.CommandSender sender)

isResourcePackEnabledByDefault

boolean isResourcePackEnabledByDefault()

isResourcePackEnabled

boolean isResourcePackEnabled()

isResourcePackSetByServer

boolean isResourcePackSetByServer()

getAlternateResourcePacks

Collection<String> getAlternateResourcePacks()

commitOnQuit

boolean commitOnQuit()

getMaxHeight

int getMaxHeight(org.bukkit.World world)

getMinHeight

int getMinHeight(org.bukkit.World world)

getItemKeys

Set<String> getItemKeys()

getItem

@Nullable
ItemData getItem(String key)

getItem

@Nullable
ItemData getItem(org.bukkit.inventory.ItemStack match)

createItemData

@Nullable
ItemData createItemData(org.bukkit.inventory.ItemStack match)

getOrCreateItem

@Nullable
ItemData getOrCreateItem(String key)

getOrCreateItemOrWand

@Nullable
 @Deprecated
ItemData getOrCreateItemOrWand(String key)

Deprecated.

Redirects to getOrCreateItem

getOrCreateMagicItem

@Nullable
 @Deprecated
ItemData getOrCreateMagicItem(String key)

Deprecated.

Redirects to getOrCreateItem

unloadItemTemplate

void unloadItemTemplate(String key)

loadItemTemplate

void loadItemTemplate(String key,
                      org.bukkit.configuration.ConfigurationSection itemNode)

getWorth

@Nullable
Double getWorth(org.bukkit.inventory.ItemStack item)

getWorth

@Nullable
Double getWorth(org.bukkit.inventory.ItemStack item,
                          String currency)

getWorth

@Nullable
Double getWorth(org.bukkit.Material material,
                          String currency)

getEarns

@Nullable
Double getEarns(org.bukkit.inventory.ItemStack item)

getEarns

@Nullable
Double getEarns(org.bukkit.inventory.ItemStack item,
                          String currency)

disguise

boolean disguise(org.bukkit.entity.Entity entity,
                 org.bukkit.configuration.ConfigurationSection configuration)

applyModel

@Deprecated
boolean applyModel(org.bukkit.entity.Entity entity,
                               org.bukkit.configuration.ConfigurationSection configuration)

Deprecated.

Use getModelEngine instead

getModelEngine

ModelEngine getModelEngine()

ModelEngine integration

managePlayerData

void managePlayerData(boolean external,
                      boolean backupInventories)

getDefaultWandTemplate

String getDefaultWandTemplate()

getHeroesSkillPrefix

String getHeroesSkillPrefix()

getWandProperty

@Nullable
Object getWandProperty(org.bukkit.inventory.ItemStack itemStack,
                                 String key)

getWandProperty

@Nonnull
<T> T getWandProperty(org.bukkit.inventory.ItemStack itemStack,
                               @Nonnull
                               String key,
                               @Nonnull
                               T defaultValue)

cleanItem

void cleanItem(org.bukkit.inventory.ItemStack itemStack)

Remove all custom Magic data from an item, but leave other metadata intact.

getMageClassKeys

Set<String> getMageClassKeys()

getMageClassTemplate

MageClassTemplate getMageClassTemplate(String key)

getModifierTemplate

@Nullable
ModifierTemplate getModifierTemplate(String key)

getModifierTemplateKeys

@Nonnull
Collection<String> getModifierTemplateKeys()

createLight

boolean createLight(org.bukkit.Location location,
                    int lightlevel,
                    boolean async)

deleteLight

boolean deleteLight(org.bukkit.Location location,
                    boolean async)

updateLight

boolean updateLight(org.bukkit.Location location,
                    boolean force)

updateLight

boolean updateLight(org.bukkit.Location location)

isLightingAvailable

boolean isLightingAvailable()

getLightCount

int getLightCount()

checkRequirements

@Nullable
String checkRequirements(@Nonnull
                                   MageContext context,
                                   @Nullable
                                   Collection<Requirement> requirements)

getDamageTypes

@Nonnull
Set<String> getDamageTypes()

getAttributes

@Nonnull
Set<String> getAttributes()

Get all attributes, including those registered by external plugins. Note that this does not include the "bowpull" or other specialty attributes.

Returns:

a Set of all attributes registered.

getInternalAttributes

@Nonnull
Set<String> getInternalAttributes()

Get all attributes defined in attributes.yml or other configs.

Returns:

a Set of all attributes configured in Magic configs.

getBuiltinAttribute

Double getBuiltinAttribute(String attributeKey)

isWand

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

isWandUpgrade

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

isSkill

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

isMagic

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

getLoadedExamples

@Nonnull
Collection<String> getLoadedExamples()

Return all example configs that have been loaded via example: or add_examples: in config.yml

Returns:

A list, possibly empty, of examples loaded

getExample

@Nullable
String getExample()

Get the primary example loaded via "example: ..." in config.yml

Returns:

the primary example, or null if none is enabled

getExamples

@Nonnull
Collection<String> getExamples()

Return all example configs that are available built into the plugin

Returns:

A list of all builtin examples

getExternalExamples

@Nonnull
Collection<String> getExternalExamples()

Return all external example configs that are referenced by the builtin configs or have been loaded with the mconfig command

getExternalExampleURL

@Nullable
String getExternalExampleURL(String exampleKey)

Return the URL for an existing loaded example This may be from the builtin configs, or one that was previously fetched via the mconfig command

getLocalizations

@Nonnull
Collection<String> getLocalizations()

Return all builtin localizations. These are represented as ISO language codes.

Returns:

A list of all builtin localizations

getBlockDurability

double getBlockDurability(@Nonnull
                          org.bukkit.block.Block block)

getSkillsSpell

@Nonnull
String getSkillsSpell()

Get the spell that should be cast when a player uses the /mskills command.

Returns:

The key of the skill selector spell, "skills" by default.

getRandom

@Nonnull
Random getRandom()

Retrieve a static Random instance to use for randomization.

Returns:

An instance of Random

getEffects

@Nonnull
Collection<EffectPlayer> getEffects(@Nonnull
                                             String effectKey)

Retrieve a list of effects defined in effects.yml

Parameters:

effectKey - The effect key

Returns:

A collection of effect players

getEffectKeys

@Nonnull
Collection<String> getEffectKeys()

playEffects

void playEffects(@Nonnull
                 String effectKey,
                 @Nonnull
                 org.bukkit.Location sourceLocation,
                 @Nonnull
                 org.bukkit.Location targetLocation)

playEffects

void playEffects(@Nonnull
                 String effectKey,
                 @Nonnull
                 EffectContext context)

loadEffects

@Nullable
Collection<EffectPlayer> loadEffects(org.bukkit.configuration.ConfigurationSection configuration,
                                               String effectKey)

loadEffects

@Nullable
Collection<EffectPlayer> loadEffects(org.bukkit.configuration.ConfigurationSection configuration,
                                               String effectKey,
                                               String logContext)

loadEffects

@Nullable
Collection<EffectPlayer> loadEffects(org.bukkit.configuration.ConfigurationSection configuration,
                                               String effectKey,
                                               String logContext,
                                               org.bukkit.configuration.ConfigurationSection parameterMap)

logBlockChange

void logBlockChange(@Nonnull
                    Mage mage,
                    @Nonnull
                    org.bukkit.block.BlockState priorState,
                    @Nonnull
                    org.bukkit.block.BlockState newState)

inTaggedRegion

boolean inTaggedRegion(org.bukkit.Location location,
                       Set<String> tags)

isFileLockingEnabled

boolean isFileLockingEnabled()

getPlaceholder

@Nullable
String getPlaceholder(org.bukkit.entity.Player player,
                                String namespace,
                                String placeholder)

setPlaceholders

@Nonnull
String setPlaceholders(org.bukkit.entity.Player player,
                                String message)

getAttribute

@Nullable
MagicAttribute getAttribute(String attributeKey)

isUndoable

boolean isUndoable(@Nonnull
                   org.bukkit.Material material)

getNPCs

@Nonnull
Collection<MagicNPC> getNPCs()

removeNPC

void removeNPC(MagicNPC npc)

addNPC

@Nullable
MagicNPC addNPC(Mage creator,
                          String name)

getNPC

@Nullable
MagicNPC getNPC(@Nullable
                          org.bukkit.entity.Entity entity)

getNPC

@Nullable
MagicNPC getNPC(UUID id)

getNPC

@Nullable
MagicNPC getNPC(String id)

registerMob

void registerMob(@Nonnull
                 org.bukkit.entity.Entity entity,
                 @Nonnull
                 EntityData entityData)

getLockedChunks

@Nonnull
Collection<org.bukkit.Chunk> getLockedChunks()

lockChunk

void lockChunk(org.bukkit.Chunk chunk)

unlockChunk

void unlockChunk(org.bukkit.Chunk chunk)

getAutoWandKey

@Nullable
String getAutoWandKey(@Nonnull
                                org.bukkit.Material material)

getPlayerWarpProviderKeys

@Nonnull
Set<String> getPlayerWarpProviderKeys()

getPlayerWarps

@Nullable
Collection<PlayerWarp> getPlayerWarps(@Nonnull
                                                org.bukkit.entity.Player player,
                                                String key)

getAllPlayerWarps

@Nullable
Collection<PlayerWarp> getAllPlayerWarps(String key)

register

boolean register(MagicProvider provider)

Register an implementation of one or more MageProvider interfaces.

Parameters:

provider - The provider to register

Returns:

false if none of the implemented interfaces were recognized

loadConfigurationQuietly

void loadConfigurationQuietly(org.bukkit.command.CommandSender sender)

updateConfiguration

void updateConfiguration(org.bukkit.command.CommandSender sender)

Update all fetched examples and then reload configuration

getDeathLocations

@Nullable
List<DeathLocation> getDeathLocations(org.bukkit.entity.Player player)

cast

boolean cast(String spellName,
             String[] parameters)

Cast a specific Spell, with optional parameters.

The parameters are generally in alternating key/value format, such as {"radius", "32", "range", "64"}

This Spell will be cast using the COMMAND Mage.

Parameters:

spellName - The key name of the Spell to cast

parameters - A list of parameters, as if cast from the command-line.

Returns:

true if the spell succeeds, else false

cast

boolean cast(Mage mage,
             String spellName,
             org.bukkit.configuration.ConfigurationSection parameters,
             org.bukkit.command.CommandSender sender)

setDisableSpawnReplacement

void setDisableSpawnReplacement(boolean disable)

getMagicWarp

@Nullable
Warp getMagicWarp(String warpKey)

getMagicWarps

@Nonnull
Collection<? extends Warp> getMagicWarps()

getMagicBlocks

@Nonnull
Collection<MagicBlock> getMagicBlocks()

getMagicBlock

@Nullable
MagicBlock getMagicBlock(String name)

addMagicBlock

@Nullable
MagicBlock addMagicBlock(@Nonnull
                                   org.bukkit.Location location,
                                   @Nonnull
                                   String templateKey,
                                   String creatorId,
                                   String creatorName,
                                   @Nullable
                                   org.bukkit.configuration.ConfigurationSection parameters)

removeMagicBlock

boolean removeMagicBlock(@Nonnull
                         org.bukkit.Location location)

addAutomaton

@Deprecated
 @Nullable
Automaton addAutomaton(@Nonnull
                                              org.bukkit.Location location,
                                              @Nonnull
                                              String templateKey,
                                              String creatorId,
                                              String creatorName,
                                              @Nullable
                                              org.bukkit.configuration.ConfigurationSection parameters)

Deprecated.

getKitKeys

@Nonnull
Set<String> getKitKeys()

getKit

@Nullable
Kit getKit(String key)

getBlockExchangeCurrency

@Nullable
Currency getBlockExchangeCurrency()

getSpawnEgg

@Nullable
org.bukkit.inventory.ItemStack getSpawnEgg(String mobType)

getDamageSource

org.bukkit.entity.Entity getDamageSource(org.bukkit.entity.Entity entity)

Finds the underlying damage source of an entity. For example, the shooter in case of an arrow.

Parameters:

entity - The entity to check the damage source for.

Returns:

The underlying damage source, will be non-null iff entity is non-null.

isDamaging

boolean isDamaging()

createWorld

org.bukkit.World createWorld(String worldName)

copyWorld

org.bukkit.World copyWorld(String worldName,
                           org.bukkit.World copyFrom)

createMaterialAndData

MaterialAndData createMaterialAndData(org.bukkit.Material material,
                                      String blockData)

createMaterialAndData

MaterialAndData createMaterialAndData(org.bukkit.Material material,
                                      byte legacyBlockData)

createMaterialAndData

MaterialAndData createMaterialAndData(String materialKey)

timeSkipped

void timeSkipped(org.bukkit.World world,
                 long skippedAmount)

onPlayerJump

void onPlayerJump(org.bukkit.entity.Player player,
                  org.bukkit.util.Vector velocity)

spawnMythicMob

@Nullable
org.bukkit.entity.Entity spawnMythicMob(String mythicMobKey,
                                                  org.bukkit.Location location)

getMythicMobKey

@Nullable
String getMythicMobKey(org.bukkit.entity.Entity entity)

getMythicMobLevel

@Nullable
Double getMythicMobLevel(org.bukkit.entity.Entity entity)

setMythicMobLevel

void setMythicMobLevel(org.bukkit.entity.Entity entity,
                       double level)

isMythicMobKey

boolean isMythicMobKey(String mythicMobKey)

onResourcePackStatus

void onResourcePackStatus(org.bukkit.entity.Player player,
                          ResourcePackStatus status)

getIconKeys

@Nonnull
Set<String> getIconKeys()

getIcon

@Nullable
Icon getIcon(String key)

getDefaultIcon

@Nonnull
Icon getDefaultIcon()

onEntitiesLoaded

void onEntitiesLoaded(org.bukkit.Chunk chunk,
                      List<org.bukkit.entity.Entity> entities)

onEntityPickupItem

boolean onEntityPickupItem(org.bukkit.entity.Entity entity,
                           org.bukkit.entity.Item item)

getRequirements

Collection<Requirement> getRequirements(org.bukkit.configuration.ConfigurationSection configuration)