Class BlockPermutation<T>

constructor

• new BlockPermutation<T extends keyof BlockState = keyof BlockState>(
      networkId: number,
      state: BlockState[T],
      type: BlockType<T>,
      query?: string,
  ): BlockPermutation<T>

  Create a new block permutation.

  Type Parameters

  • T extends keyof BlockState = keyof BlockState

  Parameters

  • networkId: number
  • state: BlockState[T]

    The state of the block permutation.
  • type: BlockType<T>

    The block type of the block permutation.
  • Optionalquery: string

    The Molang conditional query of the block permutation.

  Returns BlockPermutation<T>

Readonlycomponents

Readonlyindex

Readonlynbt

ReadonlynetworkId

Readonlyquery

Readonlystate

Readonlytype

Static ReadonlyhashOffset

Static Readonlypermutations

isComponentBased

• get isComponentBased(): boolean

  Whether the block permutation is component based. This is determined by the presence of any components in the block permutation.

  Returns boolean

matches

• matches(state: BlockState[T]): boolean

  Check if the block permutation matches the identifier and state.

  Parameters

  • state: BlockState[T]

    The block state to match.

  Returns boolean

Staticcreate

• create(
      type: BlockType,
      state?: GenericBlockState,
      components?: Partial<BlockTypeComponentCollection>,
      query?: string,
  ): BlockPermutation

  Create a new block permutation. Primarily used for custom block types.

  Parameters

  • type: BlockType

    The block type of the block permutation.
  • state: GenericBlockState = {}

    The state of the block permutation.
  • components: Partial<BlockTypeComponentCollection> = {}
  • Optionalquery: string

  Returns BlockPermutation

StaticfromCompound

• fromCompound(nbt: CompoundTag): BlockPermutation

  Get a block permutation from a compound tag. (Used for disk storage)

  Parameters

  • nbt: CompoundTag

    The compound tag to convert.

  Returns BlockPermutation

  The block permutation.

Statichash

• hash(identifier: string, state: GenericBlockState): number

  Parameters

  • identifier: string
  • state: GenericBlockState

  Returns number

Staticresolve

• resolve(
      identifier: string | number,
      state?: GenericBlockState,
  ): BlockPermutation

  Resolve a block permutation from the block identifier and state.

  Parameters

  • identifier: string | number

    The block identifier to resolve.
  • Optionalstate: GenericBlockState

    The block state to resolve.

  Returns BlockPermutation

StatictoCompound

• toCompound(permutation: BlockPermutation): CompoundTag

  Convert the block permutation to a compound tag. (Used for disk storage)

  Parameters

  • permutation: BlockPermutation

    The block permutation to convert.

  Returns CompoundTag

  The compound tag representation of the block permutation.