Class ItemEnchantableComponent

Hierarchy (View Summary)

ItemComponent
- ItemEnchantableComponent

Index

Constructors

Properties

isValid slots typeId componentId

Methods

addEnchantment addEnchantments canAddEnchantment getEnchantment getEnchantments hasEnchantment removeAllEnchantments removeEnchantment

Constructors

`Private`constructor

new ItemEnchantableComponent(): ItemEnchantableComponent
Returns ItemEnchantableComponent
Overrides ItemComponent.constructor

Properties

`Readonly`isValid

isValid: boolean

`Readonly`slots

slots: EnchantmentSlot[]

Throws

This property can throw when used.

World Ready

This property can't be read in early-execution mode.

`Readonly`typeId

typeId: string

`Static` `Readonly`componentId

componentId: "minecraft:enchantable"

Methods

addEnchantment

addEnchantment(enchantment: Enchantment): void
Parameters
- enchantment: Enchantment
Returns void
Remarks
This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

EnchantmentLevelOutOfBoundsError

EnchantmentTypeNotCompatibleError

EnchantmentTypeUnknownIdError

Error

World Ready
This function can't be called in early-execution mode.

addEnchantments

addEnchantments(enchantments: Enchantment[]): void
Parameters
- enchantments: Enchantment[]
Returns void
Remarks
This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

EnchantmentLevelOutOfBoundsError

EnchantmentTypeNotCompatibleError

EnchantmentTypeUnknownIdError

Error

World Ready
This function can't be called in early-execution mode.

canAddEnchantment

canAddEnchantment(enchantment: Enchantment): boolean
Parameters
- enchantment: Enchantment
Returns boolean
Throws
This function can throw errors.

EnchantmentLevelOutOfBoundsError

EnchantmentTypeUnknownIdError

World Ready
This function can't be called in early-execution mode.

getEnchantment

getEnchantment(enchantmentType: string | EnchantmentType): Enchantment
Parameters
- enchantmentType: string | EnchantmentType
Returns Enchantment
Throws
This function can throw errors.

EnchantmentTypeUnknownIdError

World Ready
This function can't be called in early-execution mode.

getEnchantments

getEnchantments(): Enchantment[]
Returns Enchantment[]
Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

hasEnchantment

hasEnchantment(enchantmentType: string | EnchantmentType): boolean
Parameters
- enchantmentType: string | EnchantmentType
Returns boolean
Throws
This function can throw errors.

EnchantmentTypeUnknownIdError

World Ready
This function can't be called in early-execution mode.

removeAllEnchantments

removeAllEnchantments(): void
Returns void
Remarks
This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

removeEnchantment

removeEnchantment(enchantmentType: string | EnchantmentType): void
Parameters
- enchantmentType: string | EnchantmentType
Returns void
Remarks
This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

EnchantmentTypeUnknownIdError

Error

World Ready
This function can't be called in early-execution mode.