Class EntityEquippableComponent

Provides access to a mob's equipment slots. This component exists for all mob entities.

Example

givePlayerElytra.ts

// 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

Constructors

constructor

Properties

entity typeId componentId

Methods

getEquipment getEquipmentSlot isValid setEquipment

Constructors

Private constructor

Properties

Readonly entity

entity: Entity

Remarks

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

Readonly typeId

typeId: string

Remarks

Identifier of the component.

Static Readonly componentId

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

Methods

getEquipment

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

    Remarks

    Gets the equipped item for the given EquipmentSlot.

    Throws

    This function can throw errors.

getEquipmentSlot

  • Parameters

    • equipmentSlot: EquipmentSlot

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

    Returns ContainerSlot

    Returns the ContainerSlot corresponding to the given EquipmentSlot.

    Remarks

    Gets the ContainerSlot corresponding to the given EquipmentSlot.

    Throws

    This function can throw errors.

isValid

  • Returns boolean

    Whether the component is valid.

    Deprecated

    This function is deprecated and will be removed in 2.0.0.

    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.

setEquipment

  • Parameters

    • equipmentSlot: EquipmentSlot

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

    • Optional itemStack: ItemStack

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

    Returns boolean

    Remarks

    Replaces the item in the given EquipmentSlot.

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

    Throws

    This function can throw errors.

Settings

Member Visibility

Theme

On This Page