Class EnchantmentListBeta

constructor

• new EnchantmentList(enchantmentSlot: number): EnchantmentList
  Beta

  Parameters

  • enchantmentSlot: number

  Returns EnchantmentList

  Remarks

  Creates a new EnchantmentList.

Readonly Betaslot

[iterator]

• "[iterator]"(): Iterator<Enchantment>
  Beta

  Returns Iterator<Enchantment>

  Remarks

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

addEnchantment

• addEnchantment(enchantment: Enchantment): boolean
  Beta

  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: Enchantment): boolean
  Beta

  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: string | EnchantmentType): Enchantment
  Beta

  Parameters

  • enchantmentType: string | EnchantmentType

  Returns Enchantment

  Remarks

  Returns an enchantment associated with a type.

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

  Throws

  This function can throw errors.

hasEnchantment

• hasEnchantment(enchantmentType: string | EnchantmentType): number
  Beta

  Parameters

  • enchantmentType: string | EnchantmentType

  Returns number

  Remarks

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

  Throws

  This function can throw errors.

next

• next(): IteratorResult<Enchantment>
  Beta

  Returns IteratorResult<Enchantment>

  Remarks

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

removeEnchantment

• removeEnchantment(enchantmentType: string | EnchantmentType): void
  Beta

  Parameters

  • enchantmentType: string | EnchantmentType

  Returns void

  Remarks

  Removes an EnchantmentInstance with type from this collection if present.

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

  Throws

  This function can throw errors.