Class ItemEnchantableComponent

Readonlyslots

Static ReadonlycomponentId

addEnchantment

• addEnchantment(enchantment: Enchantment): void

• Parameters

  • enchantment: Enchantment

    The enchantment interface to be added.

  Returns void

  Remarks

  Adds an enchantment to the item stack.

  This function can't be called in read-only mode.

  Throws

  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

• Parameters

  • enchantments: Enchantment[]

    The list of enchantments to be added.

  Returns void

  Remarks

  Adds a list of enchantments to the item stack.

  This function can't be called in read-only mode.

  Throws

  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

• Parameters

  • enchantment: Enchantment

    The enchantment interface to be added.

  Returns boolean

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

  Remarks

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

  Throws

  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

• Parameters

  • enchantmentType: string | EnchantmentType

    The enchantment type to get.

  Returns Enchantment

  Returns the enchantment if it exists on the item stack.

  Remarks

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

  Throws

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

  EnchantmentTypeUnknownIdError

getEnchantments

• getEnchantments(): Enchantment[]

• Returns Enchantment[]

  Returns a list of enchantments on the item stack.

  Remarks

  Gets all enchantments on the item stack.

  Throws

  This function can throw errors.

hasEnchantment

• hasEnchantment(enchantmentType: string | EnchantmentType): boolean

• Parameters

  • enchantmentType: string | EnchantmentType

    The enchantment type to check for.

  Returns boolean

  Returns true if the item stack has the enchantment type.

  Remarks

  Checks whether an item stack has a given enchantment type.

  Throws

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

  EnchantmentTypeUnknownIdError

removeAllEnchantments

• removeAllEnchantments(): void

• Returns void

  Remarks

  Removes all enchantments applied to this item stack.

  This function can't be called in read-only mode.

  Throws

  This function can throw errors.

removeEnchantment

• removeEnchantment(enchantmentType: string | EnchantmentType): void

• Parameters

  • enchantmentType: string | EnchantmentType

    The enchantment type to remove.

  Returns void

  Remarks

  Removes an enchantment of the given type.

  This function can't be called in read-only mode.

  Throws

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

  EnchantmentTypeUnknownIdError

  Error