Class BlockPermutation

Contains the combination of type BlockType and properties (also sometimes called block state) which describe a block (but does not belong to a specific Block).

Methods

getState matches withState resolve

Methods

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.

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.

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

      const allColorNames: string[] = [
        "white",
        "orange",
        "magenta",
        "light_blue",
        "yellow",
        "lime",
        "pink",
        "gray",
        "silver",
        "cyan",
        "purple",
        "blue",
        "brown",
        "green",
        "red",
        "black",
      ];

      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++;
            overworld
              .getBlock({ x: targetLocation.x + x, y: targetLocation.y + y, z: targetLocation.z + z })
              ?.setPermutation(
                mc.BlockPermutation.resolve("minecraft:wool", {
                  color: allColorNames[colorIndex % allColorNames.length],
                })
              );
          }
        }
      }

Settings

Member Visibility

On This Page

Methods