Bedrock API Reference

Appearance

@minecraft/server

@minecraft/server / BlockInventoryComponent

Class: BlockInventoryComponent ​

Defined in: @minecraft/server/index.d.ts:4951

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

Example ​

placeItemsInChest.ts

typescript
import { ItemStack, BlockInventoryComponent, DimensionLocation } from '@minecraft/server';
import { MinecraftBlockTypes, MinecraftItemTypes } from '@minecraft/vanilla-data';

function placeItemsInChest(log: (message: string, status?: number) => void, targetLocation: DimensionLocation) {
  // Fetch block
  const block = targetLocation.dimension.getBlock(targetLocation);

  if (!block) {
    log('Could not find block. Maybe it is not loaded?', -1);
    return;
  }

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

  // Get the inventory
  const inventoryComponent = block.getComponent('inventory') as BlockInventoryComponent;

  if (!inventoryComponent || !inventoryComponent.container) {
    log('Could not find inventory component.', -1);
    return;
  }

  const inventoryContainer = inventoryComponent.container;

  // Set slot 0 to a stack of 10 apples
  inventoryContainer.setItem(0, new ItemStack(MinecraftItemTypes.Apple, 10));
}

Extends ​

Properties ​

block ​

readonly block: Block

Defined in: @minecraft/server/index.d.ts:4377

Remarks ​

Block instance that this component pertains to.

Inherited from ​

BlockComponent.block

container? ​

readonly optional container?: Container

Defined in: @minecraft/server/index.d.ts:4959

Remarks ​

The container which holds an ItemStack.

Throws ​

This property can throw when used.

isValid ​

readonly isValid: boolean

Defined in: @minecraft/server/index.d.ts:6234

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 ​

BlockComponent.isValid

typeId ​

readonly typeId: string

Defined in: @minecraft/server/index.d.ts:6240

Remarks ​

Identifier of the component.

Inherited from ​

BlockComponent.typeId

componentId ​

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

Defined in: @minecraft/server/index.d.ts:4960