Package org.bukkit.enchantments

Class Enchantment

java.lang.Object

org.bukkit.enchantments.Enchantment

All Implemented Interfaces:

Keyed, Translatable

Direct Known Subclasses:

EnchantmentWrapper

public abstract class Enchantment
extends Object
implements Keyed, Translatable

The various type of enchantments that may be added to armour or weapons

Field Summary

Fields

Modifier and Type	Field	Description
static final Enchantment	AQUA_AFFINITY	Increases the speed at which a player may mine underwater
static final Enchantment	BANE_OF_ARTHROPODS	Increases damage against arthropod targets
static final Enchantment	BINDING_CURSE	Item cannot be removed
static final Enchantment	BLAST_PROTECTION	Provides protection against explosive damage
static final Enchantment	BREACH	Reduces armor effectiveness against maces
static final Enchantment	CHANNELING	Strikes lightning when a mob is hit with a trident if conditions are stormy
static final Enchantment	DENSITY	Increases fall damage of maces
static final Enchantment	DEPTH_STRIDER	Increases walking speed while in water
static final Enchantment	EFFICIENCY	Increases the rate at which you mine/dig
static final Enchantment	FEATHER_FALLING	Provides protection against fall damage
static final Enchantment	FIRE_ASPECT	When attacking a target, has a chance to set them on fire
static final Enchantment	FIRE_PROTECTION	Provides protection against fire damage
static final Enchantment	FLAME	Sets entities on fire when hit by arrows shot from a bow
static final Enchantment	FORTUNE	Provides a chance of gaining extra loot when destroying blocks
static final Enchantment	FROST_WALKER	Freezes any still water adjacent to ice / frost which player is walking on
static final Enchantment	IMPALING	Deals more damage to mobs that live in the ocean
static final Enchantment	INFINITY	Provides infinite arrows when shooting a bow
static final Enchantment	KNOCKBACK	All damage to other targets will knock them back when hit
static final Enchantment	LOOTING	Provides a chance of gaining extra loot when killing monsters
static final Enchantment	LOYALTY	Causes a thrown trident to return to the player who threw it
static final Enchantment	LUCK_OF_THE_SEA	Decreases odds of catching worthless junk
static final Enchantment	LURE	Increases rate of fish biting your hook
static final Enchantment	MENDING	Allows mending the item using experience orbs
static final Enchantment	MULTISHOT	Shoot multiple arrows from crossbows
static final Enchantment	PIERCING	Crossbow projectiles pierce entities
static final Enchantment	POWER	Provides extra damage when shooting arrows from bows
static final Enchantment	PROJECTILE_PROTECTION	Provides protection against projectile damage
static final Enchantment	PROTECTION	Provides protection against environmental damage
static final Enchantment	PUNCH	Provides a knockback when an entity is hit by an arrow from a bow
static final Enchantment	QUICK_CHARGE	Charges crossbows quickly
static final Enchantment	RESPIRATION	Decreases the rate of air loss whilst underwater
static final Enchantment	RIPTIDE	When it is rainy, launches the player in the direction their trident is thrown
static final Enchantment	SHARPNESS	Increases damage against all targets
static final Enchantment	SILK_TOUCH	Allows blocks to drop themselves instead of fragments (for example, stone instead of cobblestone)
static final Enchantment	SMITE	Increases damage against undead targets
static final Enchantment	SOUL_SPEED	Walk quicker on soul blocks
static final Enchantment	SWEEPING_EDGE	Increases damage against targets when using a sweep attack
static final Enchantment	SWIFT_SNEAK	Walk quicker while sneaking
static final Enchantment	THORNS	Damages the attacker
static final Enchantment	UNBREAKING	Decreases the rate at which a tool looses durability
static final Enchantment	VANISHING_CURSE	Item disappears instead of dropping
static final Enchantment	WIND_BURST	Emits wind burst upon hitting enemy

Constructor Summary

Constructors

Constructor	Description
Enchantment()

Method Summary

Modifier and Type	Method	Description
abstract boolean	canEnchantItem(ItemStack item)	Checks if this Enchantment may be applied to the given ItemStack.
abstract boolean	conflictsWith(Enchantment other)	Check if this enchantment conflicts with another enchantment.
static Enchantment	getByKey(NamespacedKey key)	Deprecated. only for backwards compatibility, use Registry.get(NamespacedKey) instead
static Enchantment	getByName(String name)	Deprecated. enchantments are badly named, use getByKey(org.bukkit.NamespacedKey).
abstract EnchantmentTarget	getItemTarget()	Deprecated. enchantment groupings are now managed by tags, not categories
abstract int	getMaxLevel()	Gets the maximum level that this Enchantment may become.
abstract String	getName()	Deprecated. enchantments are badly named, use Keyed.getKey().
abstract int	getStartLevel()	Gets the level that this Enchantment should start at
abstract boolean	isCursed()	Deprecated. cursed enchantments are no longer special.
abstract boolean	isTreasure()	Deprecated. enchantment types are now managed by tags
static Enchantment[]	values()	Deprecated. use Registry.ENCHANTMENT.iterator()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.bukkit.Keyed

getKey

Methods inherited from interface org.bukkit.Translatable

getTranslationKey

Field Details

PROTECTION

public static final Enchantment PROTECTION

Provides protection against environmental damage

FIRE_PROTECTION

public static final Enchantment FIRE_PROTECTION

Provides protection against fire damage

FEATHER_FALLING

public static final Enchantment FEATHER_FALLING

Provides protection against fall damage

BLAST_PROTECTION

public static final Enchantment BLAST_PROTECTION

Provides protection against explosive damage

PROJECTILE_PROTECTION

public static final Enchantment PROJECTILE_PROTECTION

Provides protection against projectile damage

RESPIRATION

public static final Enchantment RESPIRATION

Decreases the rate of air loss whilst underwater

AQUA_AFFINITY

public static final Enchantment AQUA_AFFINITY

Increases the speed at which a player may mine underwater

THORNS

public static final Enchantment THORNS

Damages the attacker

DEPTH_STRIDER

public static final Enchantment DEPTH_STRIDER

Increases walking speed while in water

FROST_WALKER

public static final Enchantment FROST_WALKER

Freezes any still water adjacent to ice / frost which player is walking on

BINDING_CURSE

public static final Enchantment BINDING_CURSE

Item cannot be removed

SHARPNESS

public static final Enchantment SHARPNESS

Increases damage against all targets

SMITE

public static final Enchantment SMITE

Increases damage against undead targets

BANE_OF_ARTHROPODS

public static final Enchantment BANE_OF_ARTHROPODS

Increases damage against arthropod targets

KNOCKBACK

public static final Enchantment KNOCKBACK

All damage to other targets will knock them back when hit

FIRE_ASPECT

public static final Enchantment FIRE_ASPECT

When attacking a target, has a chance to set them on fire

LOOTING

public static final Enchantment LOOTING

Provides a chance of gaining extra loot when killing monsters

SWEEPING_EDGE

public static final Enchantment SWEEPING_EDGE

Increases damage against targets when using a sweep attack

EFFICIENCY

public static final Enchantment EFFICIENCY

Increases the rate at which you mine/dig

SILK_TOUCH

public static final Enchantment SILK_TOUCH

Allows blocks to drop themselves instead of fragments (for example, stone instead of cobblestone)

UNBREAKING

public static final Enchantment UNBREAKING

Decreases the rate at which a tool looses durability

FORTUNE

public static final Enchantment FORTUNE

Provides a chance of gaining extra loot when destroying blocks

POWER

public static final Enchantment POWER

Provides extra damage when shooting arrows from bows

PUNCH

public static final Enchantment PUNCH

Provides a knockback when an entity is hit by an arrow from a bow

FLAME

public static final Enchantment FLAME

Sets entities on fire when hit by arrows shot from a bow

INFINITY

public static final Enchantment INFINITY

Provides infinite arrows when shooting a bow

LUCK_OF_THE_SEA

public static final Enchantment LUCK_OF_THE_SEA

Decreases odds of catching worthless junk

LURE

public static final Enchantment LURE

Increases rate of fish biting your hook

LOYALTY

public static final Enchantment LOYALTY

Causes a thrown trident to return to the player who threw it

IMPALING

public static final Enchantment IMPALING

Deals more damage to mobs that live in the ocean

RIPTIDE

public static final Enchantment RIPTIDE

When it is rainy, launches the player in the direction their trident is thrown

CHANNELING

public static final Enchantment CHANNELING

Strikes lightning when a mob is hit with a trident if conditions are stormy

MULTISHOT

public static final Enchantment MULTISHOT

Shoot multiple arrows from crossbows

QUICK_CHARGE

public static final Enchantment QUICK_CHARGE

Charges crossbows quickly

PIERCING

public static final Enchantment PIERCING

Crossbow projectiles pierce entities

DENSITY

public static final Enchantment DENSITY

Increases fall damage of maces

BREACH

public static final Enchantment BREACH

Reduces armor effectiveness against maces

WIND_BURST

public static final Enchantment WIND_BURST

Emits wind burst upon hitting enemy

MENDING

public static final Enchantment MENDING

Allows mending the item using experience orbs

VANISHING_CURSE

public static final Enchantment VANISHING_CURSE

Item disappears instead of dropping

SOUL_SPEED

public static final Enchantment SOUL_SPEED

Walk quicker on soul blocks

SWIFT_SNEAK

public static final Enchantment SWIFT_SNEAK

Walk quicker while sneaking

Constructor Details

Enchantment

public Enchantment()

Method Details

getName

@NotNull
@Deprecated
public abstract String getName()

Deprecated.

enchantments are badly named, use Keyed.getKey().

Gets the unique name of this enchantment

Returns:

Unique name

getMaxLevel

public abstract int getMaxLevel()

Gets the maximum level that this Enchantment may become.

Returns:

Maximum level of the Enchantment

getStartLevel

public abstract int getStartLevel()

Gets the level that this Enchantment should start at

Returns:

Starting level of the Enchantment

getItemTarget

@NotNull
@Deprecated
public abstract EnchantmentTarget getItemTarget()

Deprecated.

enchantment groupings are now managed by tags, not categories

Gets the type of ItemStack that may fit this Enchantment.

Returns:

Target type of the Enchantment

isTreasure

@Deprecated
public abstract boolean isTreasure()

Deprecated.

enchantment types are now managed by tags

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

Returns:

true if the enchantment is a treasure enchantment

isCursed

@Deprecated
public abstract boolean isCursed()

Deprecated.

cursed enchantments are no longer special. Will return true only for BINDING_CURSE and VANISHING_CURSE.

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

Returns:

true if the enchantment is cursed

conflictsWith

public abstract boolean conflictsWith(@NotNull
 Enchantment other)

Check if this enchantment conflicts with another enchantment.

Parameters:

other - The enchantment to check against

Returns:

True if there is a conflict.

canEnchantItem

public abstract boolean canEnchantItem(@NotNull
 ItemStack item)

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.

Parameters:

item - Item to test

Returns:

True if the enchantment may be applied, otherwise False

getByKey

@Contract("null -> null")
@Nullable
@Deprecated
public static Enchantment getByKey(@Nullable
 NamespacedKey key)

Deprecated.

only for backwards compatibility, use Registry.get(NamespacedKey) instead

Gets the Enchantment at the specified key

Parameters:

key - key to fetch

Returns:

Resulting Enchantment, or null if not found

getByName

@Deprecated
@Contract("null -> null")
@Nullable
public static Enchantment getByName(@Nullable
 String name)

Deprecated.

enchantments are badly named, use getByKey(org.bukkit.NamespacedKey).

Gets the Enchantment at the specified name

Parameters:

name - Name to fetch

Returns:

Resulting Enchantment, or null if not found

values

@NotNull
@Deprecated
public static Enchantment[] values()

Deprecated.

use Registry.ENCHANTMENT.iterator()

Gets an array of all the registered Enchantments

Returns:

Array of enchantments