类 ItemEnchantableComponent实验性

只读 实验性slots

静态 只读 实验性componentId

addEnchantment

• addEnchantment(enchantment): void
• 实验性

  参数

  • enchantment: Enchantment

    The enchantment interface to be added.

  返回 void

  备注

  Adds an enchantment to the item stack.

  无法在只读模式下调用此函数，详见 WorldBeforeEvents。

  抛出

  ScriptItemEnchantmentUnknownIdError: Exception thrown if the enchantment type does not exist.

  ScriptItemEnchantmentLevelOutOfBoundsError: Exception thrown if the enchantment level is outside the allowable range for the given enchantment type.

  ScriptItemEnchantmentTypeNotCompatibleError: Exception thrown if the enchantment is not compatible with the item stack.

  EnchantmentLevelOutOfBoundsError

  EnchantmentTypeNotCompatibleError

  EnchantmentTypeUnknownIdError

  Error

addEnchantments

• addEnchantments(enchantments): void
• 实验性

  参数

  • enchantments: Enchantment[]

    The list of enchantments to be added.

  返回 void

  备注

  Adds a list of enchantments to the item stack.

  无法在只读模式下调用此函数，详见 WorldBeforeEvents。

  抛出

  ScriptItemEnchantmentUnknownIdError: Exception thrown if any enchantment type does not exist.

  ScriptItemEnchantmentLevelOutOfBoundsError: Exception thrown if any enchantment level is outside the allowable range for the given enchantment type.

  ScriptItemEnchantmentTypeNotCompatibleError: Exception thrown if any enchantment is not compatible with the item stack.

  EnchantmentLevelOutOfBoundsError

  EnchantmentTypeNotCompatibleError

  EnchantmentTypeUnknownIdError

  Error

canAddEnchantment

• canAddEnchantment(enchantment): boolean
• 实验性

  参数

  • enchantment: Enchantment

    The enchantment interface to be added.

  返回 boolean

  Returns true if the enchantment can be added to the item stack.

  备注

  Checks whether an enchantment can be added to the item stack.

  抛出

  ScriptItemEnchantmentUnknownIdError: Exception thrown if the enchantment type does not exist.

  ScriptItemEnchantmentLevelOutOfBoundsError: Exception thrown if the enchantment level is outside the allowable range for the given enchantment type.

  EnchantmentLevelOutOfBoundsError

  EnchantmentTypeUnknownIdError

getEnchantment

• getEnchantment(enchantmentType): Enchantment
• 实验性

  参数

  • enchantmentType: string | EnchantmentType

    The enchantment type to get.

  返回 Enchantment

  Returns the enchantment if it exists on the item stack.

  备注

  Gets the enchantment of a given type from the item stack.

  抛出

  ScriptItemEnchantmentUnknownIdError: Exception thrown if the enchantment type does not exist.

  EnchantmentTypeUnknownIdError

getEnchantments

• getEnchantments(): Enchantment[]
• 实验性

  返回 Enchantment[]

  Returns a list of enchantments on the item stack.

  备注

  Gets all enchantments on the item stack.

  抛出

  This function can throw errors.

hasEnchantment

• hasEnchantment(enchantmentType): boolean
• 实验性

  参数

  • enchantmentType: string | EnchantmentType

    The enchantment type to check for.

  返回 boolean

  Returns true if the item stack has the enchantment type.

  备注

  Checks whether an item stack has a given enchantment type.

  抛出

  ScriptItemEnchantmentUnknownIdError: Exception thrown if the enchantment type does not exist.

  EnchantmentTypeUnknownIdError

removeAllEnchantments

• removeAllEnchantments(): void
• 实验性

  返回 void

  备注

  Removes all enchantments applied to this item stack.

  无法在只读模式下调用此函数，详见 WorldBeforeEvents。

  抛出

  This function can throw errors.

removeEnchantment

• removeEnchantment(enchantmentType): void
• 实验性

  参数

  • enchantmentType: string | EnchantmentType

    The enchantment type to remove.

  返回 void

  备注

  Removes an enchantment of the given type.

  无法在只读模式下调用此函数，详见 WorldBeforeEvents。

  抛出

  ScriptItemEnchantmentUnknownIdError: Exception thrown if the enchantment type does not exist.

  EnchantmentTypeUnknownIdError

  Error