EntityEquippableComponent

Class in @minecraft/server

Extends EntityComponent

What a player or mob wears and holds: armour, the main hand (a player’s held slot), the offhand, and a mob’s body.

import { EntityEquippableComponent } from '@minecraft/server';

Example

TypeScript JavaScript

import { world, type EntityEquippableComponent } from '@minecraft/server';

for (const player of world.getAllPlayers()) {
    const component: EntityEquippableComponent | undefined = player.getComponent('minecraft:equippable');
    if (component) {
        console.log(player.name, component.typeId);
    }
}

import { world } from '@minecraft/server';

for (const player of world.getAllPlayers()) {
    const component = player.getComponent('minecraft:equippable');
    if (component) {
        console.log(player.name, component.typeId);
    }
}

Properties

typeId

read-only

readonly typeId: "minecraft:equippable";

entity

read-only

readonly entity: Entity;

Types

Entity

isValid

read-only

readonly isValid: boolean;

Methods

getEquipment

getEquipment(equipmentSlot: EquipmentSlot): ItemStack | undefined;

The item in a slot, or undefined if it’s empty.

Parameters

equipmentSlot

EquipmentSlot

Returns

ItemStack | undefined

Types

EquipmentSlotItemStack

getEquipmentSlot

getEquipmentSlot(equipmentSlot: EquipmentSlot): ContainerSlot;

A live handle on a slot, for reading or changing the item in it as it changes, rather than a one-off copy. The same slots getEquipment and setEquipment reach.

Parameters

equipmentSlot

EquipmentSlot

Returns

ContainerSlot

Types

EquipmentSlotContainerSlot

setEquipment

setEquipment(equipmentSlot: EquipmentSlot, itemStack?: ItemStack): boolean;

Puts an item in a slot, or empties it with no item. Those who see a mob are shown it at once, and the mob keeps it when saved (its body slot excepted).

Parameters

equipmentSlot

EquipmentSlot

itemStackoptional

ItemStack

Returns

booleanTrue: the change is sent.

Types

EquipmentSlotItemStack

Used by

EntityComponentTypeMap.minecraft:equippable, EntityComponentTypeMap.equippable