org.bukkit.enchantments

Class EnchantmentWrapper

java.lang.Object

org.bukkit.enchantments.Enchantment

org.bukkit.enchantments.EnchantmentWrapper

All Implemented Interfaces:

Keyed

public class EnchantmentWrapper
extends Enchantment

A simple wrapper for ease of selecting Enchantments

Field Summary

Fields inherited from class org.bukkit.enchantments.Enchantment

ARROW_DAMAGE, ARROW_FIRE, ARROW_INFINITE, ARROW_KNOCKBACK, BINDING_CURSE, CHANNELING, DAMAGE_ALL, DAMAGE_ARTHROPODS, DAMAGE_UNDEAD, DEPTH_STRIDER, DIG_SPEED, DURABILITY, FIRE_ASPECT, FROST_WALKER, IMPALING, KNOCKBACK, LOOT_BONUS_BLOCKS, LOOT_BONUS_MOBS, LOYALTY, LUCK, LURE, MENDING, MULTISHOT, OXYGEN, PIERCING, PROTECTION_ENVIRONMENTAL, PROTECTION_EXPLOSIONS, PROTECTION_FALL, PROTECTION_FIRE, PROTECTION_PROJECTILE, QUICK_CHARGE, RIPTIDE, SILK_TOUCH, SWEEPING_EDGE, THORNS, VANISHING_CURSE, WATER_WORKER

Constructor Summary

Constructors

Constructor and Description
EnchantmentWrapper(@NotNull String name)

Method Summary

Modifier and Type	Method and Description
boolean	canEnchantItem(@NotNull ItemStack item) Checks if this Enchantment may be applied to the given ItemStack.
boolean	conflictsWith(@NotNull Enchantment other) Check if this enchantment conflicts with another enchantment.
@NotNull Enchantment	getEnchantment() Gets the enchantment bound to this wrapper
@NotNull EnchantmentTarget	getItemTarget() Gets the type of ItemStack that may fit this Enchantment.
int	getMaxLevel() Gets the maximum level that this Enchantment may become.
@NotNull String	getName() Gets the unique name of this enchantment
int	getStartLevel() Gets the level that this Enchantment should start at
boolean	isCursed() Checks if this enchantment is a cursed enchantment Cursed enchantments are found the same way treasure enchantments are
boolean	isTreasure() Checks if this enchantment is a treasure enchantment.

Methods inherited from class org.bukkit.enchantments.Enchantment

equals, getByKey, getByName, getKey, hashCode, isAcceptingRegistrations, registerEnchantment, stopAcceptingRegistrations, toString, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EnchantmentWrapper

public EnchantmentWrapper(@NotNull
                          @NotNull String name)

Method Detail

getEnchantment

@NotNull
public @NotNull Enchantment getEnchantment()

Gets the enchantment bound to this wrapper

Returns:

Enchantment

getMaxLevel

public int getMaxLevel()

Description copied from class: Enchantment

Gets the maximum level that this Enchantment may become.

Specified by:

getMaxLevel in class Enchantment

Returns:

Maximum level of the Enchantment

getStartLevel

public int getStartLevel()

Description copied from class: Enchantment

Gets the level that this Enchantment should start at

Specified by:

getStartLevel in class Enchantment

Returns:

Starting level of the Enchantment

getItemTarget

@NotNull
public @NotNull EnchantmentTarget getItemTarget()

Description copied from class: Enchantment

Gets the type of ItemStack that may fit this Enchantment.

Specified by:

getItemTarget in class Enchantment

Returns:

Target type of the Enchantment

canEnchantItem

public boolean canEnchantItem(@NotNull
                              @NotNull ItemStack item)

Description copied from class: Enchantment

Checks if this Enchantment may be applied to the given ItemStack.

This does not check if it conflicts with any enchantments already applied to the item.

Specified by:

canEnchantItem in class Enchantment

Parameters:

item - Item to test

Returns:

True if the enchantment may be applied, otherwise False

getName

@NotNull
public @NotNull String getName()

Description copied from class: Enchantment

Gets the unique name of this enchantment

Specified by:

getName in class Enchantment

Returns:

Unique name

isTreasure

public boolean isTreasure()

Description copied from class: Enchantment

Checks if this enchantment is a treasure enchantment.
Treasure enchantments can only be received via looting, trading, or fishing.

Specified by:

isTreasure in class Enchantment

Returns:

true if the enchantment is a treasure enchantment

isCursed

public boolean isCursed()

Description copied from class: Enchantment

Checks if this enchantment is a cursed enchantment
Cursed enchantments are found the same way treasure enchantments are

Specified by:

isCursed in class Enchantment

Returns:

true if the enchantment is cursed

conflictsWith

public boolean conflictsWith(@NotNull
                             @NotNull Enchantment other)

Description copied from class: Enchantment

Check if this enchantment conflicts with another enchantment.

Specified by:

conflictsWith in class Enchantment

Parameters:

other - The enchantment to check against

Returns:

True if there is a conflict.