类 ItemEnchantableComponent实验性

When present on an item, this item can have enchantments applied to it.

层级 (查看层级一览)

属性

isValid slots typeId componentId

方法

addEnchantment addEnchantments canAddEnchantment getEnchantment getEnchantments hasEnchantment removeAllEnchantments removeEnchantment

属性

只读 实验性isValid

isValid: boolean

备注

返回组件是否有效。若组件的拥有者有效，并且组件需要的任何 额外验证也通过，则该组件被认为是有效的。

Returns whether the component is valid. A component is considered valid if its owner is valid, in addition to any addition to any additional validation required by the component.

只读 实验性slots

slots: EnchantmentSlot[]

抛出

This property can throw when used.

只读 实验性typeId

typeId: string

备注

组件的标识符。 Identifier of the component.

静态 只读 实验性componentId

componentId: "minecraft:enchantable" = 'minecraft:enchantable'

方法

addEnchantment

  • addEnchantment(enchantment: 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: Enchantment[]): 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: 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: string | EnchantmentType): Enchantment
  • 实验性

    参数

    返回 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: string | 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: string | EnchantmentType): void
  • 实验性

    参数

    返回 void

    备注

    Removes an enchantment of the given type.

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

    抛出

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

    EnchantmentTypeUnknownIdError

    Error

显示设置

成员可见性

目录

属性
方法