Class EntityEquippableComponentBeta

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 (View Summary)

Constructors

constructor

Properties

entity isValid typeId componentId

Methods

getEquipment getEquipmentSlot setEquipment

Constructors

Privateconstructor

Properties

Readonly Betaentity

entity: Entity

Remarks

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

Throws

This property can throw when used.

InvalidEntityError

Readonly BetaisValid

isValid: boolean

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.

Readonly BetatypeId

typeId: string

Remarks

Identifier of the component.

Static Readonly BetacomponentId

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

Methods

getEquipment

getEquipmentSlot

setEquipment

Settings

Member Visibility

On This Page

Constructors
Properties
Methods