Script API - v1.21.120
    Preparing search index...

    Class ItemEnchantableComponent

    When present on an item, this item can have enchantments applied to it.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    isValid slots typeId componentId

    Methods

    addEnchantment addEnchantments canAddEnchantment getEnchantment getEnchantments hasEnchantment removeAllEnchantments removeEnchantment

    Constructors

    Properties

    isValid: boolean

    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.

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

    slots: EnchantmentSlot[]

    This property can throw when used.

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

    typeId: string

    Identifier of the component.

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

    componentId: "minecraft:enchantable" = 'minecraft:enchantable'

    Methods

    • Parameters

      • enchantment: Enchantment

        The enchantment interface to be added.

      Returns void

      Adds an enchantment to the item stack.

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

      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

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

    • Parameters

      • enchantments: Enchantment[]

        The list of enchantments to be added.

      Returns void

      Adds a list of enchantments to the item stack.

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

      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

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

    • Parameters

      • enchantment: Enchantment

        The enchantment interface to be added.

      Returns boolean

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

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

      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

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

    • Returns Enchantment[]

      Returns a list of enchantments on the item stack.

      Gets all enchantments on the item stack.

      This function can throw errors.

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

    • Parameters

      • enchantmentType: string | EnchantmentType

        The enchantment type to check for.

      Returns boolean

      Returns true if the item stack has the enchantment type.

      Checks whether an item stack has a given enchantment type.

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

      EnchantmentTypeUnknownIdError

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

    • Returns void

      Removes all enchantments applied to this item stack.

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

      This function can throw errors.

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

    • Parameters

      Returns void

      Removes an enchantment of the given type.

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

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

      EnchantmentTypeUnknownIdError

      Error

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods