Package org.bukkit.enchantments
Class Enchantment
java.lang.Object
org.bukkit.enchantments.Enchantment
- All Implemented Interfaces:
Keyed
- Direct Known Subclasses:
EnchantmentWrapper
public abstract class Enchantment extends Object implements Keyed
The various type of enchantments that may be added to armour or weapons
-
Field Summary
Fields Modifier and Type Field Description static Enchantment
ARROW_DAMAGE
Provides extra damage when shooting arrows from bowsstatic Enchantment
ARROW_FIRE
Sets entities on fire when hit by arrows shot from a bowstatic Enchantment
ARROW_INFINITE
Provides infinite arrows when shooting a bowstatic Enchantment
ARROW_KNOCKBACK
Provides a knockback when an entity is hit by an arrow from a bowstatic Enchantment
BINDING_CURSE
Item cannot be removedstatic Enchantment
CHANNELING
Strikes lightning when a mob is hit with a trident if conditions are stormystatic Enchantment
DAMAGE_ALL
Increases damage against all targetsstatic Enchantment
DAMAGE_ARTHROPODS
Increases damage against arthropod targetsstatic Enchantment
DAMAGE_UNDEAD
Increases damage against undead targetsstatic Enchantment
DEPTH_STRIDER
Increases walking speed while in waterstatic Enchantment
DIG_SPEED
Increases the rate at which you mine/digstatic Enchantment
DURABILITY
Decreases the rate at which a tool looses durabilitystatic Enchantment
FIRE_ASPECT
When attacking a target, has a chance to set them on firestatic Enchantment
FROST_WALKER
Freezes any still water adjacent to ice / frost which player is walking onstatic Enchantment
IMPALING
Deals more damage to mobs that live in the oceanstatic Enchantment
KNOCKBACK
All damage to other targets will knock them back when hitstatic Enchantment
LOOT_BONUS_BLOCKS
Provides a chance of gaining extra loot when destroying blocksstatic Enchantment
LOOT_BONUS_MOBS
Provides a chance of gaining extra loot when killing monstersstatic Enchantment
LOYALTY
Causes a thrown trident to return to the player who threw itstatic Enchantment
LUCK
Decreases odds of catching worthless junkstatic Enchantment
LURE
Increases rate of fish biting your hookstatic Enchantment
MENDING
Allows mending the item using experience orbsstatic Enchantment
MULTISHOT
Shoot multiple arrows from crossbowsstatic Enchantment
OXYGEN
Decreases the rate of air loss whilst underwaterstatic Enchantment
PIERCING
Crossbow projectiles pierce entitiesstatic Enchantment
PROTECTION_ENVIRONMENTAL
Provides protection against environmental damagestatic Enchantment
PROTECTION_EXPLOSIONS
Provides protection against explosive damagestatic Enchantment
PROTECTION_FALL
Provides protection against fall damagestatic Enchantment
PROTECTION_FIRE
Provides protection against fire damagestatic Enchantment
PROTECTION_PROJECTILE
Provides protection against projectile damagestatic Enchantment
QUICK_CHARGE
Charges crossbows quicklystatic Enchantment
RIPTIDE
When it is rainy, launches the player in the direction their trident is thrownstatic Enchantment
SILK_TOUCH
Allows blocks to drop themselves instead of fragments (for example, stone instead of cobblestone)static Enchantment
SOUL_SPEED
Walk quicker on soul blocksstatic Enchantment
SWEEPING_EDGE
Increases damage against targets when using a sweep attackstatic Enchantment
THORNS
Damages the attackerstatic Enchantment
VANISHING_CURSE
Item disappears instead of droppingstatic Enchantment
WATER_WORKER
Increases the speed at which a player may mine underwater -
Constructor Summary
Constructors Constructor Description Enchantment(NamespacedKey key)
-
Method Summary
Modifier and Type Method Description abstract boolean
canEnchantItem(ItemStack item)
Checks if this Enchantment may be applied to the givenItemStack
.abstract boolean
conflictsWith(Enchantment other)
Check if this enchantment conflicts with another enchantment.boolean
equals(Object obj)
static Enchantment
getByKey(NamespacedKey key)
Gets the Enchantment at the specified keystatic Enchantment
getByName(String name)
Deprecated.enchantments are badly named, usegetByKey(org.bukkit.NamespacedKey)
.abstract EnchantmentTarget
getItemTarget()
Gets the type ofItemStack
that may fit this Enchantment.NamespacedKey
getKey()
Return the namespaced identifier for this object.abstract int
getMaxLevel()
Gets the maximum level that this Enchantment may become.abstract String
getName()
Deprecated.enchantments are badly named, usegetKey()
.abstract int
getStartLevel()
Gets the level that this Enchantment should start atint
hashCode()
static boolean
isAcceptingRegistrations()
Checks if this is accepting Enchantment registrations.abstract boolean
isCursed()
Deprecated.cursed enchantments are no longer special.abstract boolean
isTreasure()
Checks if this enchantment is a treasure enchantment.static void
registerEnchantment(Enchantment enchantment)
Registers an enchantment with the given ID and object.static void
stopAcceptingRegistrations()
Stops accepting any enchantment registrationsString
toString()
static Enchantment[]
values()
Gets an array of all the registeredEnchantment
s
-
Field Details
-
PROTECTION_ENVIRONMENTAL
Provides protection against environmental damage -
PROTECTION_FIRE
Provides protection against fire damage -
PROTECTION_FALL
Provides protection against fall damage -
PROTECTION_EXPLOSIONS
Provides protection against explosive damage -
PROTECTION_PROJECTILE
Provides protection against projectile damage -
OXYGEN
Decreases the rate of air loss whilst underwater -
WATER_WORKER
Increases the speed at which a player may mine underwater -
THORNS
Damages the attacker -
DEPTH_STRIDER
Increases walking speed while in water -
FROST_WALKER
Freezes any still water adjacent to ice / frost which player is walking on -
BINDING_CURSE
Item cannot be removed -
DAMAGE_ALL
Increases damage against all targets -
DAMAGE_UNDEAD
Increases damage against undead targets -
DAMAGE_ARTHROPODS
Increases damage against arthropod targets -
KNOCKBACK
All damage to other targets will knock them back when hit -
FIRE_ASPECT
When attacking a target, has a chance to set them on fire -
LOOT_BONUS_MOBS
Provides a chance of gaining extra loot when killing monsters -
SWEEPING_EDGE
Increases damage against targets when using a sweep attack -
DIG_SPEED
Increases the rate at which you mine/dig -
SILK_TOUCH
Allows blocks to drop themselves instead of fragments (for example, stone instead of cobblestone) -
DURABILITY
Decreases the rate at which a tool looses durability -
LOOT_BONUS_BLOCKS
Provides a chance of gaining extra loot when destroying blocks -
ARROW_DAMAGE
Provides extra damage when shooting arrows from bows -
ARROW_KNOCKBACK
Provides a knockback when an entity is hit by an arrow from a bow -
ARROW_FIRE
Sets entities on fire when hit by arrows shot from a bow -
ARROW_INFINITE
Provides infinite arrows when shooting a bow -
LUCK
Decreases odds of catching worthless junk -
LURE
Increases rate of fish biting your hook -
LOYALTY
Causes a thrown trident to return to the player who threw it -
IMPALING
Deals more damage to mobs that live in the ocean -
RIPTIDE
When it is rainy, launches the player in the direction their trident is thrown -
CHANNELING
Strikes lightning when a mob is hit with a trident if conditions are stormy -
MULTISHOT
Shoot multiple arrows from crossbows -
QUICK_CHARGE
Charges crossbows quickly -
PIERCING
Crossbow projectiles pierce entities -
MENDING
Allows mending the item using experience orbs -
VANISHING_CURSE
Item disappears instead of dropping -
SOUL_SPEED
Walk quicker on soul blocks
-
-
Constructor Details
-
Method Details
-
getKey
Description copied from interface:Keyed
Return the namespaced identifier for this object. -
getName
Deprecated.enchantments are badly named, usegetKey()
.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
Gets the type ofItemStack
that may fit this Enchantment.- Returns:
- Target type of the Enchantment
-
isTreasure
public abstract boolean isTreasure()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.cursed enchantments are no longer special. Will return true only forBINDING_CURSE
andVANISHING_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
Check if this enchantment conflicts with another enchantment.- Parameters:
other
- The enchantment to check against- Returns:
- True if there is a conflict.
-
canEnchantItem
Checks if this Enchantment may be applied to the givenItemStack
.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
-
equals
-
hashCode
public int hashCode() -
toString
-
registerEnchantment
Registers an enchantment with the given ID and object.Generally not to be used from within a plugin.
- Parameters:
enchantment
- Enchantment to register
-
isAcceptingRegistrations
public static boolean isAcceptingRegistrations()Checks if this is accepting Enchantment registrations.- Returns:
- True if the server Implementation may add enchantments
-
stopAcceptingRegistrations
public static void stopAcceptingRegistrations()Stops accepting any enchantment registrations -
getByKey
@Contract("null -> null") @Nullable public static Enchantment getByKey(@Nullable NamespacedKey key)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, usegetByKey(org.bukkit.NamespacedKey)
.Gets the Enchantment at the specified name- Parameters:
name
- Name to fetch- Returns:
- Resulting Enchantment, or null if not found
-
values
Gets an array of all the registeredEnchantment
s- Returns:
- Array of enchantments
-