Skip to main content

Class: BlockInventoryComponent

Represents the inventory of a block in the world. Used with blocks like chests.

Example​

import { world, MinecraftBlockTypes, Items, ItemStack } from "@minecraft/server";

// Fetch block
const block = world.getDimension("overworld").getBlock({ x: 1, y: 2, z: 3 });

// Make it a chest
block.setType(MinecraftBlockTypes.chest);

// Get the inventory
const inventoryComponent = block.getComponent("inventory");
const inventoryContainer = inventoryComponent.container;

// Set slot 0 to a stack of 10 apples
inventoryContainer.setItem(0, new ItemStack(Items.apple, 10, 0));

Extends​

Constructors​

new BlockInventoryComponent()​

private new BlockInventoryComponent(): BlockInventoryComponent

Returns​

BlockInventoryComponent

Overrides​

BlockComponent . constructor

Properties​

block​

readonly block: Block

Remarks​

Block instance that this component pertains to.

Inherited from​

BlockComponent . block

container?​

optional readonly container: Container

Remarks​

The container which holds an ItemStack.

Throws​

This property can throw when used.

typeId​

readonly typeId: string

Remarks​

Identifier of the component.

Inherited from​

BlockComponent . typeId

componentId​

static readonly componentId: "minecraft:inventory" = 'minecraft:inventory'

Methods​

isValid()​

isValid(): boolean

Returns​

boolean

Whether the component is valid.

Inherited from​

BlockComponent . isValid

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.