Class EntityEquippableComponent`Beta`

Hierarchy

EntityComponent
- EntityEquippableComponent

Index

Constructors

Properties

entity typeId componentId

Methods

getEquipment getEquipmentSlot isValid setEquipment

Constructors

`Private` constructor

new EntityEquippableComponent(): EntityEquippableComponent
Returns EntityEquippableComponent
Overrides EntityComponent.constructor
- Defined in tmp/package/index.d.ts:5204

Properties

`Readonly` `Beta` entity

entity: Entity

Remarks

The entity that owns this component.

`Readonly` typeId

typeId: string

Remarks

Identifier of the component.

`Static` `Readonly` componentId

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

Methods

getEquipment

getEquipment(equipmentSlot): undefined | ItemStack
Parameters
- equipmentSlot: EquipmentSlot
Returns undefined | ItemStack

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

Throws
This function can throw errors.
- Defined in tmp/package/index.d.ts:5212

getEquipmentSlot

getEquipmentSlot(equipmentSlot): ContainerSlot
Parameters
- equipmentSlot: EquipmentSlot
Returns ContainerSlot

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

Throws
This function can throw errors.
- Defined in tmp/package/index.d.ts:5219

isValid

isValid(): boolean
Beta
Returns boolean
Whether the component is valid.

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.
Inherited from EntityComponent.isValid
- Defined in tmp/package/index.d.ts:2227

setEquipment

setEquipment(equipmentSlot, itemStack?): boolean
Parameters
- equipmentSlot: EquipmentSlot
- Optional itemStack: ItemStack
Returns boolean

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

Throws
This function can throw errors.
- Defined in tmp/package/index.d.ts:5226