Class EnchantmentListBeta

constructor

• new EnchantmentList(enchantmentSlot): EnchantmentList

• Parameters

  • enchantmentSlot: number

  Returns EnchantmentList

  Remarks

  Creates a new EnchantmentList.

Readonly slot

[iterator]

• [iterator](): Iterator<Enchantment, any, undefined>

• Returns Iterator<Enchantment, any, undefined>

  Remarks

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

addEnchantment

• addEnchantment(enchantment): boolean

• Parameters

  • enchantment: Enchantment

  Returns boolean

  Remarks

  Attempts to add the enchantment to this collection. Returns true if successful.

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

canAddEnchantment

• canAddEnchantment(enchantment): boolean

• Parameters

  • enchantment: Enchantment

  Returns boolean

  Remarks

  Returns whether or not the provided EnchantmentInstance can be added to this collection.

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

getEnchantment

• getEnchantment(enchantmentType): Enchantment

• Parameters

  • enchantmentType: EnchantmentType

  Returns Enchantment

  Remarks

  Returns an enchantment associated with a type.

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

hasEnchantment

• hasEnchantment(enchantmentType): number

• Parameters

  • enchantmentType: EnchantmentType

  Returns number

  Remarks

  If this collection has an EnchantmentInstance with type, returns the level of the enchantment. Returns 0 if not present.

next

• next(): IteratorResult<Enchantment, any>

• Returns IteratorResult<Enchantment, any>

  Remarks

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

removeEnchantment

• removeEnchantment(enchantmentType): void

• Parameters

  • enchantmentType: EnchantmentType

  Returns void

  Remarks

  Removes an EnchantmentInstance with type from this collection if present.

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