@minecraft/server
    Preparing search index...

    Class EntityEquippableComponent

    Provides access to a mob's equipment slots. This component exists on player entities.

    // Gives the player Elytra
    import { EquipmentSlot, ItemStack, Player, EntityComponentTypes } from '@minecraft/server';
    import { MinecraftItemTypes } from '@minecraft/vanilla-data';

    function giveEquipment(player: Player) {
        const equipmentCompPlayer = player.getComponent(EntityComponentTypes.Equippable);
        if (equipmentCompPlayer) {
            equipmentCompPlayer.setEquipment(EquipmentSlot.Chest, new ItemStack(MinecraftItemTypes.Elytra));
        }
    }

    Hierarchy (View Summary)

    Index

    Properties

    entity isValid totalArmor totalToughness typeId componentId

    Methods

    getEquipment getEquipmentSlot setEquipment

    Properties

    entity: Entity

    The entity that owns this component. The entity will be undefined if it has been removed.

    This property can throw when used.

    InvalidEntityError

    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.

    totalArmor: number

    Returns the total Armor level of the owner.

    This property can throw when used.

    InvalidEntityError

    totalToughness: number

    Returns the total Toughness level of the owner.

    This property can throw when used.

    InvalidEntityError

    typeId: string

    Identifier of the component.

    componentId: "minecraft:equippable" = 'minecraft:equippable'

    Methods

    • Parameters

      • equipmentSlot: EquipmentSlot

        The equipment slot. e.g. "head", "chest", "offhand"

      Returns undefined | ItemStack

      Returns the item equipped to the given EquipmentSlot. If empty, returns undefined.

      Gets the equipped item for the given EquipmentSlot.

      This function can throw errors.

    • Parameters

      • equipmentSlot: EquipmentSlot

        The equipment slot. e.g. "head", "chest", "offhand".

      Returns ContainerSlot

      Returns the ContainerSlot corresponding to the given EquipmentSlot.

      Gets the ContainerSlot corresponding to the given EquipmentSlot.

      This function can throw errors.

    • Parameters

      • equipmentSlot: EquipmentSlot

        The equipment slot. e.g. "head", "chest", "offhand".

      • OptionalitemStack: ItemStack

        The item to equip. If undefined, clears the slot.

      Returns boolean

      Replaces the item in the given EquipmentSlot.

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

      This function can throw errors.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods