Script API - v1.21.110
    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));
        }
    }

    import { EquipmentSlot, Player } from "@minecraft/server";

    function clearOffhand(player: Player) {
        const equippable = player.getComponent("minecraft:equippable");
        equippable.setEquipment(EquipmentSlot.Offhand); // Assuming undefined (empty slot) as an example
    }

    import { world, EquipmentSlot } from "@minecraft/server";

    const player = world.getPlayers()[0];
    const equippable = player.getComponent("equippable");
    const slot = equippable.getEquipmentSlot(EquipmentSlot.Mainhand);
    Note

    This component only exists for all players. It does not exist on all entities.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    entity isValid totalArmor totalToughness typeId componentId

    Methods

    getEquipment getEquipmentSlot setEquipment

    Constructors

    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

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

    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.

    totalArmor: number

    Returns the total Armor level of the owner.

    This property can throw when used.

    InvalidEntityError

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

    totalToughness: number

    Returns the total Toughness level of the owner.

    This property can throw when used.

    InvalidEntityError

    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:equippable" = 'minecraft:equippable'

    Methods

    • Parameters

      • equipmentSlot: EquipmentSlot

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

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

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

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

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

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

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods