Class ItemEnchantsComponent`Beta`

When present on an item, this item has applied enchantment effects. Note that this component only applies to data-driven items.

Hierarchy (View Summary)

ItemComponent
- ItemEnchantsComponent

Index

Properties

enchantments typeId componentId

Methods

isValid removeAllEnchantments

Properties

`Beta`enchantments

enchantments: EnchantmentList

Remarks

Returns a collection of the enchantments applied to this item stack.

This property can't be edited in read-only mode.

`Readonly` `Beta`typeId

typeId: string

Remarks

Identifier of the component.

`Static` `Readonly` `Beta`componentId

componentId: "minecraft:enchantments" = 'minecraft:enchantments'

Methods

isValid

isValid(): boolean
Beta
Returns boolean
Whether the component is valid.

Remarks
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.

Inherited from ItemComponent.isValid

removeAllEnchantments

removeAllEnchantments(): void
Beta
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.