Class Block

Readonlydimension

ReadonlyisAir

ReadonlyisLiquid

Readonlylocation

Readonlypermutation

Readonlyx

Readonlyy

Readonlyz

getComponent

• getComponent(componentName: string): BlockComponent

  Parameters

  • componentName: string

  Returns BlockComponent

  Returns the component if it exists on the block, otherwise undefined.

  Remarks

  Gets a component (that represents additional capabilities) for a block - for example, an inventory component of a chest block.

  Throws

  This function can throw errors.

  LocationInUnloadedChunkError

  LocationOutOfWorldBoundariesError

  Example: getBlockInventoryComponent.js

  const getEntityInventoryComponent = block.getComponent("inventory");
  const inventoryContainer = getEntityInventoryComponent.container;
  
  // Custom function to add an item to the inventory
  function addItemToInventory(itemStack) {
      return inventoryContainer.addItem(itemStack);
  }
  
  // Custom function to move an item within the inventory
  function moveItemWithinInventory(fromSlot, toSlot) {
      inventoryContainer.moveItem(fromSlot, toSlot, inventoryContainer);
  }
  
  // Custom function to transfer an item from inventory to another container
  function transferItemToContainer(fromSlot, targetContainer) {
      return inventoryContainer.transferItem(fromSlot, targetContainer);
  }
  
  // Example usage of the custom functions
  const newItemStack = new ItemStack("apple", 10); // Assuming "apple" is a valid item
  const addedItem = addItemToInventory(newItemStack);
  if (addedItem) {
      console.log("Item added to inventory:", addedItem);
  }
  
  const sourceSlot = 2;
  const destinationSlot = 5;
  moveItemWithinInventory(sourceSlot, destinationSlot);
  
  const targetContainer = someOtherContainer; // Assuming 'someOtherContainer' is an instance of another container
  const transferredItem = transferItemToContainer(0, targetContainer);
  if (transferredItem) {
      console.log("Item transferred to another container:", transferredItem);
  }
  Copy

isValid

• isValid(): boolean

  Returns boolean

  True if this block object is still working and valid.

  Remarks

  Returns true if this reference to a block is still valid (for example, if the block is unloaded, references to that block will no longer be valid.)

setPermutation

• setPermutation(permutation: BlockPermutation): void

  Parameters

  • permutation: BlockPermutation

    Permutation that contains a set of property states for the Block.

  Returns void

  Remarks

  Sets the block in the dimension to the state of the permutation.

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

  Throws

  This function can throw errors.

  LocationInUnloadedChunkError

  LocationOutOfWorldBoundariesError