Class Block

BetaisWaterlogged

Readonly Betatype

Readonly BetatypeId

canPlace

• canPlace(
      blockToPlace: BlockPermutation | BlockType,
      faceToPlaceOn?: Direction,
  ): boolean
  Beta

  Parameters

  • blockToPlace: BlockPermutation | BlockType

    Block type or block permutation to check placement for.
  • OptionalfaceToPlaceOn: Direction

    Optional specific face of this block to check placement against.

  Returns boolean

  Returns true if the block type or permutation can be placed on this block, else false.

  Remarks

  Checks to see whether it is valid to place the specified block type or block permutation, on a specified face on this block

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

  Throws

  This function can throw errors.

getComponent

• getComponent(componentName: string): undefined | BlockComponent
  Beta

  Parameters

  • componentName: string

    Identifier of the component. If a namespace is not specified, minecraft: is assumed.

  Returns undefined | BlockComponent

  Returns the component object if it is present on the particular block.

  Remarks

  Gets additional configuration properties (a component) for specific capabilities of particular blocks - for example, an inventory component of a chest block.

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

  Throws

  This function can throw errors.

getItemStack

• getItemStack(amount?: number, withData?: boolean): ItemStack
  Beta

  Parameters

  • Optionalamount: number

    Number of instances of this block to place in the item stack.
  • OptionalwithData: boolean

    Whether additional data facets of the item stack are included.

  Returns ItemStack

  Remarks

  Creates a prototype item stack based on this block that can be used with Container/ContainerSlot APIs.

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

getRedstonePower

• getRedstonePower(): undefined | number
  Beta

  Returns undefined | number

  Returns undefined if redstone power is not applicable to this block.

  Remarks

  Returns the net redstone power of this block.

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

  Throws

  This function can throw errors.

getTags

• getTags(): string[]
  Beta

  Returns string[]

  The list of tags that the block has.

  Remarks

  Returns a set of tags for a block.

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

  Throws

  This function can throw errors.

hasTag

• hasTag(tag: string): boolean
  Beta

  Parameters

  • tag: string

    Tag to check for.

  Returns boolean

  Returns true if the permutation of this block has the tag, else false.

  Remarks

  Checks to see if the permutation of this block has a specific tag.

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

  Throws

  This function can throw errors.

  Example: check_block_tags.js

         import { world } from "@minecraft/server";
  
         // Fetch the block
         const block = world.getDimension("overworld").getBlock({ x: 1, y: 2, z: 3 });
  
         console.log(`Block is dirt: ${block.hasTag("dirt")}`);
         console.log(`Block is wood: ${block.hasTag("wood")}`);
         console.log(`Block is stone: ${block.hasTag("stone")}`);
  
  Copy

isAir

• isAir(): boolean
  Beta

  Returns boolean

  Remarks

  Returns true if this block is an air block (i.e., empty space).

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

  Throws

  This function can throw errors.

isLiquid

• isLiquid(): boolean
  Beta

  Returns boolean

  Remarks

  Returns true if this block is a liquid block - (e.g., a water block and a lava black are liquid, while an air block and a stone block are not).

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

  Throws

  This function can throw errors.

isSolid

• isSolid(): boolean
  Beta

  Returns boolean

  Remarks

  Returns true if this block is solid and impassible - (e.g., a cobblestone block and a diamond block are solid, while a ladder block and a fence block are not).

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

  Throws

  This function can throw errors.

setType

• setType(blockType: BlockType): void
  Beta

  Parameters

  • blockType: BlockType

    Identifier of the type of block to apply - for example, minecraft:powered_repeater.

  Returns void

  Remarks

  Sets the type of block.

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

  Throws

  This function can throw errors.

trySetPermutation

• trySetPermutation(permutation: BlockPermutation): boolean
  Beta

  Parameters

  • permutation: BlockPermutation

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

  Returns boolean

  Returns true if the block permutation data was successfully set, else false.

  Remarks

  Tries to set the block in the dimension to the state of the permutation by first checking if the placement is valid.

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

  Throws

  This function can throw errors.