Script API - v1.19.80
    Preparing search index...

    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). This type was introduced as of version 1.17.10.21.

    Index

    Constructors

    Methods

    Constructors

    Methods

    • Parameters

      • blockName: string

        An optional set of states to compare against.

      • Optionalproperties: Record<string, string | number | boolean>

      Returns boolean

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

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

    • Parameters

      • blockName: string

        Identifier of the block to check.

      • Optionalproperties: Record<string, string | number | boolean>

        Optional additional set of properties to check against.

      Returns BlockPermutation

      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)

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

      This function can throw errors.