Class BlockPermutation

Readonlytype

getAllStates

• getAllStates(): Record<string, string | number | boolean>

• Returns Record<string, string | number | boolean>

  Returns the list of all of the block states that the permutation has.

  Remarks

  Returns all available block states associated with this block.

getItemStack

• getItemStack(amount?: number): ItemStack

• Parameters

  • Optionalamount: number

    Number of instances of this block to place in the prototype item stack.

  Returns ItemStack

  Remarks

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

getState

• getState(stateName: string): string | number | boolean

• Parameters

  • stateName: string

    Name of the block state who's value is to be returned.

  Returns string | number | boolean

  Returns the state if the permutation has it, else undefined.

  Remarks

  Gets a state for the permutation.

getTags

• getTags(): string[]

• Returns string[]

  Remarks

  Creates a copy of the permutation.

hasTag

• hasTag(tag: string): boolean

• Parameters

  • tag: string

  Returns boolean

  Returns true if the permutation has the tag, else false.

  Remarks

  Checks to see if the permutation has a specific tag.

  Example: checkBlockTags.ts

  import { DimensionLocation } from "@minecraft/server";
  
  function checkBlockTags(log: (message: string, status?: number) => void, targetLocation: DimensionLocation) {
    // Fetch the block
    const block = targetLocation.dimension.getBlock(targetLocation);
  
    // check that the block is loaded
    if (block) {
      log(`Block is dirt: ${block.hasTag("dirt")}`);
      log(`Block is wood: ${block.hasTag("wood")}`);
      log(`Block is stone: ${block.hasTag("stone")}`);
    }
  }
  Copy

matches

• matches(
      blockName: string,
      states?: Record<string, string | number | boolean>,
  ): boolean

• Parameters

  • blockName: string

    An optional set of states to compare against.
  • Optionalstates: Record<string, string | number | boolean>

  Returns boolean

  Remarks

  Returns a boolean whether a specified permutation matches this permutation. If states is not specified, matches checks against the set of types more broadly.

  Example: test.js

  // Script by WavePlayz
  
  import { world } from "@minecraft/server";
  
  // Function to check if a given block is red wool
  function isRedWool(block) {
      // Define the type id of block we are checking for
      let typeId = "wool";
  
      // Define the block state we are looking for
      // In this case, we want the color to be red
      let states = { color: "red" };
  
      // Check if the block matches the specified type and states
      // The 'matches' method returns true if the block is of the specified type and has the specified states
      return block.matches(typeId, states);
  }
  Copy

withState

• withState(name: string, value: string | number | boolean): BlockPermutation

• Parameters

  • name: string

    Identifier of the block property.
  • value: string | number | boolean

    Value of the block property.

  Returns BlockPermutation

  Remarks

  Returns a derived BlockPermutation with a specific property set.

  Throws

  This function can throw errors.

Staticresolve

• resolve(
      blockName: string,
      states?: Record<string, string | number | boolean>,
  ): BlockPermutation

• Parameters

  • blockName: string

    Identifier of the block to check.
  • Optionalstates: Record<string, string | number | boolean>

  Returns BlockPermutation

  Remarks

  Given a type identifier and an optional set of properties, will return a BlockPermutation object that is usable in other block APIs (e.g., block.setPermutation)

  Throws

  This function can throw errors.

  Example: addBlockColorCube.ts

  import { BlockPermutation, DimensionLocation } from "@minecraft/server";
  import { Vector3Utils } from "@minecraft/math";
  import { MinecraftBlockTypes } from "@minecraft/vanilla-data";
  
  function addBlockColorCube(targetLocation: DimensionLocation) {
    const allWoolBlocks: string[] = [
      MinecraftBlockTypes.WhiteWool,
      MinecraftBlockTypes.OrangeWool,
      MinecraftBlockTypes.MagentaWool,
      MinecraftBlockTypes.LightBlueWool,
      MinecraftBlockTypes.YellowWool,
      MinecraftBlockTypes.LimeWool,
      MinecraftBlockTypes.PinkWool,
      MinecraftBlockTypes.GrayWool,
      MinecraftBlockTypes.LightGrayWool,
      MinecraftBlockTypes.CyanWool,
      MinecraftBlockTypes.PurpleWool,
      MinecraftBlockTypes.BlueWool,
      MinecraftBlockTypes.BrownWool,
      MinecraftBlockTypes.GreenWool,
      MinecraftBlockTypes.RedWool,
      MinecraftBlockTypes.BlackWool,
    ];
  
    const cubeDim = 7;
  
    let colorIndex = 0;
  
    for (let x = 0; x <= cubeDim; x++) {
      for (let y = 0; y <= cubeDim; y++) {
        for (let z = 0; z <= cubeDim; z++) {
          colorIndex++;
          targetLocation.dimension
            .getBlock(Vector3Utils.add(targetLocation, { x, y, z }))
            ?.setPermutation(BlockPermutation.resolve(allWoolBlocks[colorIndex % allWoolBlocks.length]));
        }
      }
    }
  }
  Copy