java.lang.Object

cn.nukkit.item.enchantment.Enchantment

All Implemented Interfaces:: Cloneable

Direct Known Subclasses:: EnchantmentBindingCurse, EnchantmentBow, EnchantmentCrossbow, EnchantmentDamage, EnchantmentDurability, EnchantmentEfficiency, EnchantmentFireAspect, EnchantmentFrostWalker, EnchantmentKnockback, EnchantmentLoot, EnchantmentLure, EnchantmentMending, EnchantmentProtection, EnchantmentSilkTouch, EnchantmentSoulSpeed, EnchantmentSwiftSneak, EnchantmentThorns, EnchantmentTrident, EnchantmentVanishingCurse, EnchantmentWaterBreath, EnchantmentWaterWalker, EnchantmentWaterWorker

public abstract class Enchantment extends Object implements Cloneable

An enchantment that can be to applied to an item.

Author:: MagicDroidX (Nukkit Project)

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static enum

Enchantment.Rarity

How rare an enchantment is.
Field Summary

Fields

Modifier and Type

Field

Description

static final int

CUSTOM_ENCHANTMENT_ID

protected static Map<Identifier,Enchantment>

customEnchantments

static final Enchantment[]

EMPTY_ARRAY

protected static Enchantment[]

enchantments

final int

id

The internal ID which this enchantment got registered.

static final int

ID_BINDING_CURSE

static final int

ID_BOW_FLAME

static final int

ID_BOW_INFINITY

static final int

ID_BOW_KNOCKBACK

static final int

ID_BOW_POWER

static final int

ID_CROSSBOW_MULTISHOT

static final int

ID_CROSSBOW_PIERCING

static final int

ID_CROSSBOW_QUICK_CHARGE

static final int

ID_DAMAGE_ALL

static final int

ID_DAMAGE_ARTHROPODS

static final int

ID_DAMAGE_SMITE

static final int

ID_DURABILITY

static final int

ID_EFFICIENCY

static final int

ID_FIRE_ASPECT

static final int

ID_FORTUNE_DIGGING

static final int

ID_FORTUNE_FISHING

static final int

ID_FROST_WALKER

static final int

ID_KNOCKBACK

static final int

ID_LOOTING

static final int

ID_LURE

static final int

ID_MENDING

static final int

ID_PROTECTION_ALL

static final int

ID_PROTECTION_EXPLOSION

static final int

ID_PROTECTION_FALL

static final int

ID_PROTECTION_FIRE

static final int

ID_PROTECTION_PROJECTILE

static final int

ID_SILK_TOUCH

static final int

ID_SOUL_SPEED

static final int

ID_SWIFT_SNEAK

static final int

ID_THORNS

static final int

ID_TRIDENT_CHANNELING

static final int

ID_TRIDENT_IMPALING

static final int

ID_TRIDENT_LOYALTY

static final int

ID_TRIDENT_RIPTIDE

static final int

ID_VANISHING_CURSE

static final int

ID_WATER_BREATHING

static final int

ID_WATER_WALKER

static final int

ID_WATER_WORKER

protected final Identifier

identifier

protected int

level

The level of this enchantment.

protected final String

name

The name visible by the player, this is used in conjunction with getName(), unless modified with an override, the getter will automatically add "%enchantment." as prefix to grab the translation key

static final String

NAME_BINDING_CURSE

static final String

NAME_BOW_FLAME

static final String

NAME_BOW_INFINITY

static final String

NAME_BOW_KNOCKBACK

static final String

NAME_BOW_POWER

static final String

NAME_CROSSBOW_MULTISHOT

static final String

NAME_CROSSBOW_PIERCING

static final String

NAME_CROSSBOW_QUICK_CHARGE

static final String

NAME_DAMAGE_ALL

static final String

NAME_DAMAGE_ARTHROPODS

static final String

NAME_DAMAGE_SMITE

static final String

NAME_DURABILITY

static final String

NAME_EFFICIENCY

static final String

NAME_FIRE_ASPECT

static final String

NAME_FORTUNE_DIGGING

static final String

NAME_FORTUNE_FISHING

static final String

NAME_FROST_WALKER

static final String

NAME_KNOCKBACK

static final String

NAME_LOOTING

static final String

NAME_LURE

static final String

NAME_MENDING

static final String

NAME_PROTECTION_ALL

static final String

NAME_PROTECTION_EXPLOSION

static final String

NAME_PROTECTION_FALL

static final String

NAME_PROTECTION_FIRE

static final String

NAME_PROTECTION_PROJECTILE

static final String

NAME_SILK_TOUCH

static final String

NAME_SOUL_SPEED

static final String

NAME_SWIFT_SNEAK

static final String

NAME_THORNS

static final String

NAME_TRIDENT_CHANNELING

static final String

NAME_TRIDENT_IMPALING

static final String

NAME_TRIDENT_LOYALTY

static final String

NAME_TRIDENT_RIPTIDE

static final String

NAME_VANISHING_CURSE

static final String

NAME_WATER_BREATHING

static final String

NAME_WATER_WALKER

static final String

NAME_WATER_WORKER

EnchantmentType

type

The group of objects that this enchantment can be applied.

static final String[]

words
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

Enchantment(int id, String name, int weight, EnchantmentType type)

Deprecated.

protected

Enchantment(int id, String name, Enchantment.Rarity rarity, EnchantmentType type)

Constructs this instance using the given data and with level 1.

protected

Enchantment(Identifier identifier, String name, Enchantment.Rarity rarity, EnchantmentType type)

自定义附魔使用的构造函数
Method Summary

Modifier and Type

Method

Description

boolean

canEnchant(Item item)

Checks if the given item have a type which is compatible with this enchantment.

protected boolean

checkCompatibility(Enchantment enchantment)

Checks if this enchantment can be applied to an item that have the give enchantment without doing reverse check.

protected Enchantment

clone()

void

doAttack(Entity attacker, Entity entity)

当实体attacker使用具有附魔的武器攻击实体entity时触发

void

doPostAttack(Entity attacker, Entity entity)

当实体entity穿着附魔盔甲，被实体attacker攻击时触发

void

doPostHurt(Entity attacker, Entity entity)

目前没有任何作用

static Enchantment

get(int id)

Deprecated.

double

getDamageBonus(Entity entity)

当实体武器具有附魔时触发

static Enchantment

getEnchantment(int id)

The same as get(int) but returns a safe copy of the enchantment.

static Enchantment

getEnchantment(String name)

使用附魔标识符来获取附魔，原版附魔可以不加命名空间，但是自定义附魔必须加上命名空间才能获取

static Map<String,Integer>

getEnchantmentName2IDMap()

static Enchantment[]

getEnchantments()

Gets an array of all registered enchantments, the objects in the array are linked to the registry, it's not safe to change them.

int

getId()

The ID of this enchantment.

Identifier

getIdentifier()

获取该附魔的标识符，只有自定义附魔才有

int

getLevel()

The current level of this enchantment.

static String

getLevelString(int level)

int

getMaxEnchantAbility(int level)

The maximum enchantability for the given level as described in https://minecraft.gamepedia.com/Enchanting/Levels

int

getMaxEnchantableLevel()

The maximum level that can be obtained using an enchanting table.

int

getMaxLevel()

The maximum safe level which is possible with this enchantment.

int

getMinEnchantAbility(int level)

The minimum enchantability for the given level as described in https://minecraft.gamepedia.com/Enchanting/Levels

int

getMinLevel()

The minimum safe level which is possible with this enchantment.

String

getName()

String

getOriginalName()

float

getProtectionFactor(EntityDamageEvent event)

当实体盔甲具有附魔时触发

static String

getRandomName()

Enchantment.Rarity

getRarity()

How rare this enchantment is.

static Collection<Enchantment>

getRegisteredEnchantments()

Gets a collection with a safe copy of all enchantments that are currently registered.

int

getWeight()

Deprecated.
use Enchantment.Rarity.getWeight() instead

static void

init()

boolean

isCompatibleWith(Enchantment enchantment)

Returns true if and only if this enchantment is compatible with the other and the other is also compatible with this enchantment.

boolean

isItemAcceptable(Item item)

Deprecated.

boolean

isMajor()

static OK<?>

register(Enchantment... enchantments)

static OK<?>

register(Enchantment enchantment, boolean registerItem)

Enchantment

setLevel(int level)

Changes the level of this enchantment.

Enchantment

setLevel(int level, boolean safe)

Changes the level of this enchantment.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- EMPTY_ARRAY
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") public static final Enchantment[] EMPTY_ARRAY
- CUSTOM_ENCHANTMENT_ID
  
  @PowerNukkitXOnly @Since("1.19.60-r1") public static final int CUSTOM_ENCHANTMENT_ID
- enchantments
  
  protected static Enchantment[] enchantments
- customEnchantments
  
  @PowerNukkitXOnly @Since("1.19.60-r1") protected static Map<Identifier,Enchantment> customEnchantments
- ID_PROTECTION_ALL
  
  public static final int ID_PROTECTION_ALL
  See Also:
  
  Constant Field Values
- NAME_PROTECTION_ALL
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_PROTECTION_ALL
  See Also:
  
  Constant Field Values
- ID_PROTECTION_FIRE
  
  public static final int ID_PROTECTION_FIRE
  See Also:
  
  Constant Field Values
- NAME_PROTECTION_FIRE
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_PROTECTION_FIRE
  See Also:
  
  Constant Field Values
- ID_PROTECTION_FALL
  
  public static final int ID_PROTECTION_FALL
  See Also:
  
  Constant Field Values
- NAME_PROTECTION_FALL
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_PROTECTION_FALL
  See Also:
  
  Constant Field Values
- ID_PROTECTION_EXPLOSION
  
  public static final int ID_PROTECTION_EXPLOSION
  See Also:
  
  Constant Field Values
- NAME_PROTECTION_EXPLOSION
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_PROTECTION_EXPLOSION
  See Also:
  
  Constant Field Values
- ID_PROTECTION_PROJECTILE
  
  public static final int ID_PROTECTION_PROJECTILE
  See Also:
  
  Constant Field Values
- NAME_PROTECTION_PROJECTILE
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_PROTECTION_PROJECTILE
  See Also:
  
  Constant Field Values
- ID_THORNS
  
  public static final int ID_THORNS
  See Also:
  
  Constant Field Values
- NAME_THORNS
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_THORNS
  See Also:
  
  Constant Field Values
- ID_WATER_BREATHING
  
  public static final int ID_WATER_BREATHING
  See Also:
  
  Constant Field Values
- NAME_WATER_BREATHING
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_WATER_BREATHING
  See Also:
  
  Constant Field Values
- ID_WATER_WALKER
  
  public static final int ID_WATER_WALKER
  See Also:
  
  Constant Field Values
- NAME_WATER_WALKER
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_WATER_WALKER
  See Also:
  
  Constant Field Values
- ID_WATER_WORKER
  
  public static final int ID_WATER_WORKER
  See Also:
  
  Constant Field Values
- NAME_WATER_WORKER
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_WATER_WORKER
  See Also:
  
  Constant Field Values
- ID_DAMAGE_ALL
  
  public static final int ID_DAMAGE_ALL
  See Also:
  
  Constant Field Values
- NAME_DAMAGE_ALL
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_DAMAGE_ALL
  See Also:
  
  Constant Field Values
- ID_DAMAGE_SMITE
  
  public static final int ID_DAMAGE_SMITE
  See Also:
  
  Constant Field Values
- NAME_DAMAGE_SMITE
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_DAMAGE_SMITE
  See Also:
  
  Constant Field Values
- ID_DAMAGE_ARTHROPODS
  
  public static final int ID_DAMAGE_ARTHROPODS
  See Also:
  
  Constant Field Values
- NAME_DAMAGE_ARTHROPODS
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_DAMAGE_ARTHROPODS
  See Also:
  
  Constant Field Values
- ID_KNOCKBACK
  
  public static final int ID_KNOCKBACK
  See Also:
  
  Constant Field Values
- NAME_KNOCKBACK
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_KNOCKBACK
  See Also:
  
  Constant Field Values
- ID_FIRE_ASPECT
  
  public static final int ID_FIRE_ASPECT
  See Also:
  
  Constant Field Values
- NAME_FIRE_ASPECT
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_FIRE_ASPECT
  See Also:
  
  Constant Field Values
- ID_LOOTING
  
  public static final int ID_LOOTING
  See Also:
  
  Constant Field Values
- NAME_LOOTING
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_LOOTING
  See Also:
  
  Constant Field Values
- ID_EFFICIENCY
  
  public static final int ID_EFFICIENCY
  See Also:
  
  Constant Field Values
- NAME_EFFICIENCY
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_EFFICIENCY
  See Also:
  
  Constant Field Values
- ID_SILK_TOUCH
  
  public static final int ID_SILK_TOUCH
  See Also:
  
  Constant Field Values
- NAME_SILK_TOUCH
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_SILK_TOUCH
  See Also:
  
  Constant Field Values
- ID_DURABILITY
  
  public static final int ID_DURABILITY
  See Also:
  
  Constant Field Values
- NAME_DURABILITY
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_DURABILITY
  See Also:
  
  Constant Field Values
- ID_FORTUNE_DIGGING
  
  public static final int ID_FORTUNE_DIGGING
  See Also:
  
  Constant Field Values
- NAME_FORTUNE_DIGGING
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_FORTUNE_DIGGING
  See Also:
  
  Constant Field Values
- ID_BOW_POWER
  
  public static final int ID_BOW_POWER
  See Also:
  
  Constant Field Values
- NAME_BOW_POWER
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_BOW_POWER
  See Also:
  
  Constant Field Values
- ID_BOW_KNOCKBACK
  
  public static final int ID_BOW_KNOCKBACK
  See Also:
  
  Constant Field Values
- NAME_BOW_KNOCKBACK
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_BOW_KNOCKBACK
  See Also:
  
  Constant Field Values
- ID_BOW_FLAME
  
  public static final int ID_BOW_FLAME
  See Also:
  
  Constant Field Values
- NAME_BOW_FLAME
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_BOW_FLAME
  See Also:
  
  Constant Field Values
- ID_BOW_INFINITY
  
  public static final int ID_BOW_INFINITY
  See Also:
  
  Constant Field Values
- NAME_BOW_INFINITY
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_BOW_INFINITY
  See Also:
  
  Constant Field Values
- ID_FORTUNE_FISHING
  
  public static final int ID_FORTUNE_FISHING
  See Also:
  
  Constant Field Values
- NAME_FORTUNE_FISHING
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_FORTUNE_FISHING
  See Also:
  
  Constant Field Values
- ID_LURE
  
  public static final int ID_LURE
  See Also:
  
  Constant Field Values
- NAME_LURE
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_LURE
  See Also:
  
  Constant Field Values
- ID_FROST_WALKER
  
  public static final int ID_FROST_WALKER
  See Also:
  
  Constant Field Values
- NAME_FROST_WALKER
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_FROST_WALKER
  See Also:
  
  Constant Field Values
- ID_MENDING
  
  public static final int ID_MENDING
  See Also:
  
  Constant Field Values
- NAME_MENDING
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_MENDING
  See Also:
  
  Constant Field Values
- ID_BINDING_CURSE
  
  public static final int ID_BINDING_CURSE
  See Also:
  
  Constant Field Values
- NAME_BINDING_CURSE
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_BINDING_CURSE
  See Also:
  
  Constant Field Values
- ID_VANISHING_CURSE
  
  public static final int ID_VANISHING_CURSE
  See Also:
  
  Constant Field Values
- NAME_VANISHING_CURSE
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_VANISHING_CURSE
  See Also:
  
  Constant Field Values
- ID_TRIDENT_IMPALING
  
  public static final int ID_TRIDENT_IMPALING
  See Also:
  
  Constant Field Values
- NAME_TRIDENT_IMPALING
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_TRIDENT_IMPALING
  See Also:
  
  Constant Field Values
- ID_TRIDENT_RIPTIDE
  
  public static final int ID_TRIDENT_RIPTIDE
  See Also:
  
  Constant Field Values
- NAME_TRIDENT_RIPTIDE
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_TRIDENT_RIPTIDE
  See Also:
  
  Constant Field Values
- ID_TRIDENT_LOYALTY
  
  public static final int ID_TRIDENT_LOYALTY
  See Also:
  
  Constant Field Values
- NAME_TRIDENT_LOYALTY
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_TRIDENT_LOYALTY
  See Also:
  
  Constant Field Values
- ID_TRIDENT_CHANNELING
  
  public static final int ID_TRIDENT_CHANNELING
  See Also:
  
  Constant Field Values
- NAME_TRIDENT_CHANNELING
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_TRIDENT_CHANNELING
  See Also:
  
  Constant Field Values
- ID_CROSSBOW_MULTISHOT
  
  @Since("1.4.0.0-PN") public static final int ID_CROSSBOW_MULTISHOT
  See Also:
  
  Constant Field Values
- NAME_CROSSBOW_MULTISHOT
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_CROSSBOW_MULTISHOT
  See Also:
  
  Constant Field Values
- ID_CROSSBOW_PIERCING
  
  @Since("1.4.0.0-PN") public static final int ID_CROSSBOW_PIERCING
  See Also:
  
  Constant Field Values
- NAME_CROSSBOW_PIERCING
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_CROSSBOW_PIERCING
  See Also:
  
  Constant Field Values
- ID_CROSSBOW_QUICK_CHARGE
  
  @Since("1.4.0.0-PN") public static final int ID_CROSSBOW_QUICK_CHARGE
  See Also:
  
  Constant Field Values
- NAME_CROSSBOW_QUICK_CHARGE
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_CROSSBOW_QUICK_CHARGE
  See Also:
  
  Constant Field Values
- ID_SOUL_SPEED
  
  @Since("1.4.0.0-PN") public static final int ID_SOUL_SPEED
  See Also:
  
  Constant Field Values
- NAME_SOUL_SPEED
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_SOUL_SPEED
  See Also:
  
  Constant Field Values
- ID_SWIFT_SNEAK
  
  @Since("1.4.0.0-PN") public static final int ID_SWIFT_SNEAK
  See Also:
  
  Constant Field Values
- NAME_SWIFT_SNEAK
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static final String NAME_SWIFT_SNEAK
  See Also:
  
  Constant Field Values
- id
  
  public final int id
  
  The internal ID which this enchantment got registered.
- type
  
  @NotNull public EnchantmentType type
  
  The group of objects that this enchantment can be applied.
- level
  
  protected int level
  
  The level of this enchantment. Starting from 1.
- name
  
  protected final String name
  
  The name visible by the player, this is used in conjunction with getName(), unless modified with an override, the getter will automatically add "%enchantment." as prefix to grab the translation key
- identifier
  
  @Nullable protected final Identifier identifier
- words
  
  public static final String[] words
Constructor Details
- Enchantment
  
  @PowerNukkitOnly("Was removed from Nukkit in 1.4.0.0-PN, keeping it in PowerNukkit for backward compatibility") @Deprecated @DeprecationDetails(by="Cloudburst Nukkit", since="1.4.0.0-PN", reason="Changed the signature without backward compatibility", replaceWith="Enchantment(int, String, Rarity, EnchantmentType)") protected Enchantment(int id, String name, int weight, @NotNull EnchantmentType type)
  
  Deprecated.
  
  Constructs this instance using the given data and with level 1.
  
  Parameters:
  
  id - The enchantment ID
  
  name - The translation key without the "%enchantment." suffix
  
  weight - How rare this enchantment is, from 1 to 10 both inclusive where 1 is the rarest
  
  type - Where the enchantment can be applied
- Enchantment
  
  @Since("1.4.0.0-PN") protected Enchantment(int id, String name, Enchantment.Rarity rarity, @NotNull EnchantmentType type)
  
  Constructs this instance using the given data and with level 1.
  
  Parameters:
  
  id - The enchantment ID
  
  name - The translation key without the "%enchantment." suffix
  
  rarity - How rare this enchantment is
  
  type - Where the enchantment can be applied
- Enchantment
  
  @PowerNukkitXOnly @Since("1.19.60-r1") protected Enchantment(@NotNull Identifier identifier, String name, Enchantment.Rarity rarity, @NotNull EnchantmentType type)
  
  自定义附魔使用的构造函数
  
  Parameters:
  
  name - The translation key without the "%enchantment." suffix
  
  rarity - How rare this enchantment is
  
  type - Where the enchantment can be applied
Method Details
- init
  
  public static void init()
- getLevelString
  
  @PowerNukkitXOnly @Since("1.19.60-r1") public static String getLevelString(int level)
- register
  
  @PowerNukkitXOnly @Since("1.19.60-r1") public static OK<?> register(Enchantment enchantment, boolean registerItem)
- register
  
  @PowerNukkitXOnly @Since("1.19.60-r1") public static OK<?> register(Enchantment... enchantments)
- get
  
  @Deprecated @DeprecationDetails(by="PowerNukkit", reason="This is very insecure and can break the environment", since="1.4.0.0-PN", replaceWith="getEnchantment(int)") public static Enchantment get(int id)
  
  Deprecated.
  
  Returns the enchantment object registered with this ID, any change to the returned object affects the creation of new enchantments as the returned object is not a copy.
  
  Parameters:
  
  id - The enchantment id.
  
  Returns:
  
  The enchantment, if no enchantment is found with that id, Enchantment.UnknownEnchantment is returned. The UnknownEnchantment will be always a new instance and changes to it does not affects other calls.
- getEnchantment
  
  public static Enchantment getEnchantment(int id)
  
  The same as get(int) but returns a safe copy of the enchantment.
  
  Parameters:
  
  id - The enchantment id
  
  Returns:
  
  A new enchantment object.
- getEnchantment
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static Enchantment getEnchantment(String name)
  
  使用附魔标识符来获取附魔，原版附魔可以不加命名空间，但是自定义附魔必须加上命名空间才能获取
  Gets enchantment.
  
  Parameters:
  
  name - Enchantment Identifier
  
  Returns:
  
  the enchantment
- getEnchantments
  
  public static Enchantment[] getEnchantments()
  
  Gets an array of all registered enchantments, the objects in the array are linked to the registry, it's not safe to change them. Changing them can cause the same issue as documented in get(int)
  
  Returns:
  
  An array with the enchantment objects, the array may contain null objects but is very unlikely.
- getRegisteredEnchantments
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") public static Collection<Enchantment> getRegisteredEnchantments()
  
  Gets a collection with a safe copy of all enchantments that are currently registered.
  
  Returns:
  
  The objects can be modified without affecting the registry and the collection will not have null values.
- getEnchantmentName2IDMap
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public static Map<String,Integer> getEnchantmentName2IDMap()
- getIdentifier
  
  @PowerNukkitXOnly @Since("1.19.60-r1") @Nullable public Identifier getIdentifier()
  
  获取该附魔的标识符，只有自定义附魔才有
  
  Returns:
  
  the identifier
- getLevel
  
  public int getLevel()
  
  The current level of this enchantment. 0 means that the enchantment is not applied.
  
  Returns:
  
  The level starting from 1.
- setLevel
  
  @NotNull public Enchantment setLevel(int level)
  
  Changes the level of this enchantment. The level is clamped between the values returned in getMinLevel() and getMaxLevel().
  
  Parameters:
  
  level - The level starting from 1.
  
  Returns:
  
  This object so you can do chained calls
- setLevel
  
  @NotNull public Enchantment setLevel(int level, boolean safe)
  
  Changes the level of this enchantment. When the safe param is true, the level is clamped between the values returned in getMinLevel() and getMaxLevel().
  
  Parameters:
  
  level - The level starting from 1.
  
  safe - If the level should clamped or applied directly
  
  Returns:
  
  This object so you can do chained calls
- getId
  
  public int getId()
  
  The ID of this enchantment.
- getRarity
  
  @Since("1.4.0.0-PN") @NotNull public Enchantment.Rarity getRarity()
  
  How rare this enchantment is.
- getWeight
  
  @DeprecationDetails(since="1.4.0.0-PN", by="Cloudburst Nukkit", reason="Refactored enchantments and now uses a Rarity enum", replaceWith="getRarity().getWeight()") @Deprecated public int getWeight()
  
  Deprecated.
  use Enchantment.Rarity.getWeight() instead
  
  How rare this enchantment is, from 1 to 10 where 1 is the rarest.
- getMinLevel
  
  public int getMinLevel()
  
  The minimum safe level which is possible with this enchantment. It is usually 1.
- getMaxLevel
  
  public int getMaxLevel()
  
  The maximum safe level which is possible with this enchantment.
- getMaxEnchantableLevel
  
  public int getMaxEnchantableLevel()
  
  The maximum level that can be obtained using an enchanting table.
- getMinEnchantAbility
  
  public int getMinEnchantAbility(int level)
  
  The minimum enchantability for the given level as described in https://minecraft.gamepedia.com/Enchanting/Levels
  
  Parameters:
  
  level - The level being checked
  
  Returns:
  
  The minimum value
- getMaxEnchantAbility
  
  public int getMaxEnchantAbility(int level)
  
  The maximum enchantability for the given level as described in https://minecraft.gamepedia.com/Enchanting/Levels
  
  Parameters:
  
  level - The level being checked
  
  Returns:
  
  The maximum value
- getProtectionFactor
  
  public float getProtectionFactor(EntityDamageEvent event)
  
  当实体盔甲具有附魔时触发
  覆写该方法提供当实体被攻击时盔甲提供的保护值
  目前只生效于HumanType 和 EntityMob
  
  Parameters:
  
  event - 该实体被攻击的事件
  
  Returns:
  
  the protection factor
- getDamageBonus
  
  public double getDamageBonus(Entity entity)
  
  当实体武器具有附魔时触发
  覆写该方法提供当实体使用附魔武器攻击所增益的攻击力
  目前只生效于Player 和使用了MeleeAttackExecutor行为的实体
  
  Parameters:
  
  entity - 攻击的目标实体
  
  Returns:
  
  the damage value
- doPostAttack
  
  @PowerNukkitXDifference(info="\u79fb\u9664\u5728InventoryTransactionPacket.USE_ITEM_ON_ENTITY_ACTION_ATTACK\u4e2d\u7684\u5207\u5165\u70b9\uff0c\u56e0\u4e3a\u8fd9\u4f1a\u4e0e#doAttack\u6df7\u6dc6\uff0c\u4ed6\u4eec\u662f\u4e00\u6837\u7684\u4f5c\u7528") public void doPostAttack(Entity attacker, Entity entity)
  
  当实体entity穿着附魔盔甲，被实体attacker攻击时触发
  覆写该方法实现该过程中的逻辑
  
  Parameters:
  
  attacker - the attacker
  
  entity - the entity
- doAttack
  
  public void doAttack(Entity attacker, Entity entity)
  
  当实体attacker使用具有附魔的武器攻击实体entity时触发
  覆写该方法实现该过程中的逻辑
  
  Parameters:
  
  attacker - the attacker
  
  entity - the entity
- doPostHurt
  
  @Since("FUTURE") public void doPostHurt(Entity attacker, Entity entity)
  
  目前没有任何作用
  
  Parameters:
  
  attacker - the attacker
  
  entity - the entity
- isCompatibleWith
  
  @PowerNukkitDifference(since="1.4.0.0-PN", info="Cloudburst Nukkit added the final modifier, we removed it to maintain backward compatibility. The right way to implement compatibility now is to override checkCompatibility(Enchantment enchantment) and also make sure to keep it protected! Some overrides was incorrectly made public, let\'s avoid this mistake.") public boolean isCompatibleWith(@NotNull Enchantment enchantment)
  
  Returns true if and only if this enchantment is compatible with the other and the other is also compatible with this enchantment.
  
  Parameters:
  
  enchantment - The enchantment which is being checked
  
  Returns:
  
  If both enchantments are compatible
- checkCompatibility
  
  @Since("1.4.0.0-PN") protected boolean checkCompatibility(Enchantment enchantment)
  
  Checks if this enchantment can be applied to an item that have the give enchantment without doing reverse check.
  
  Parameters:
  
  enchantment - The enchantment to be checked
  
  Returns:
  
  If this enchantment is compatible with the other enchantment.
- getName
  
  public String getName()
- getOriginalName
  
  @PowerNukkitXOnly @Since("1.6.0.0-PNX") public String getOriginalName()
- canEnchant
  
  public boolean canEnchant(@NotNull Item item)
  
  Checks if the given item have a type which is compatible with this enchantment. This method does not check if the item already have incompatible enchantments.
  
  Parameters:
  
  item - The item to be checked
  
  Returns:
  
  If the type of the item is valid for this enchantment
- isMajor
  
  public boolean isMajor()
- clone
  
  protected Enchantment clone()
  
  Overrides:
  
  clone in class Object
- isItemAcceptable
  
  @PowerNukkitOnly @Since("1.2.1.0-PN") @Deprecated @DeprecationDetails(by="PowerNukkit", since="1.4.0.0-PN", reason="Does the same as canEnchant(item)", replaceWith="canEnchant(item)") public boolean isItemAcceptable(Item item)
  
  Deprecated.
  
  Checks if an item can have this enchantment. It's not strict to the enchantment table.
- getRandomName
  
  public static String getRandomName()

Class Enchantment

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

EMPTY_ARRAY

CUSTOM_ENCHANTMENT_ID

enchantments

customEnchantments

ID_PROTECTION_ALL

NAME_PROTECTION_ALL

ID_PROTECTION_FIRE

NAME_PROTECTION_FIRE

ID_PROTECTION_FALL

NAME_PROTECTION_FALL

ID_PROTECTION_EXPLOSION

NAME_PROTECTION_EXPLOSION

ID_PROTECTION_PROJECTILE

NAME_PROTECTION_PROJECTILE

ID_THORNS

NAME_THORNS

ID_WATER_BREATHING

NAME_WATER_BREATHING

ID_WATER_WALKER

NAME_WATER_WALKER

ID_WATER_WORKER

NAME_WATER_WORKER

ID_DAMAGE_ALL

NAME_DAMAGE_ALL

ID_DAMAGE_SMITE

NAME_DAMAGE_SMITE

ID_DAMAGE_ARTHROPODS

NAME_DAMAGE_ARTHROPODS

ID_KNOCKBACK

NAME_KNOCKBACK

ID_FIRE_ASPECT

NAME_FIRE_ASPECT

ID_LOOTING

NAME_LOOTING

ID_EFFICIENCY

NAME_EFFICIENCY

ID_SILK_TOUCH

NAME_SILK_TOUCH

ID_DURABILITY

NAME_DURABILITY

ID_FORTUNE_DIGGING

NAME_FORTUNE_DIGGING

ID_BOW_POWER

NAME_BOW_POWER

ID_BOW_KNOCKBACK

NAME_BOW_KNOCKBACK

ID_BOW_FLAME

NAME_BOW_FLAME

ID_BOW_INFINITY

NAME_BOW_INFINITY

ID_FORTUNE_FISHING

NAME_FORTUNE_FISHING

ID_LURE

NAME_LURE

ID_FROST_WALKER

NAME_FROST_WALKER

ID_MENDING

NAME_MENDING

ID_BINDING_CURSE

NAME_BINDING_CURSE

ID_VANISHING_CURSE

NAME_VANISHING_CURSE

ID_TRIDENT_IMPALING

NAME_TRIDENT_IMPALING

ID_TRIDENT_RIPTIDE

NAME_TRIDENT_RIPTIDE

ID_TRIDENT_LOYALTY

NAME_TRIDENT_LOYALTY

ID_TRIDENT_CHANNELING

NAME_TRIDENT_CHANNELING

ID_CROSSBOW_MULTISHOT

NAME_CROSSBOW_MULTISHOT

ID_CROSSBOW_PIERCING