Class BlockPattern

constructor

• new BlockPattern(
      blocks?: Omit<BlockPatternEntry, "raw" | "rawsb" | "rawns">[],
      type?: "random" | "sequence",
  ): Globals.modules.cmds.BlockPattern

  Creates a new block pattern.

  Parameters

  • blocks: Omit<BlockPatternEntry, "raw" | "rawsb" | "rawns">[] = []

    The entries for the block pattern.
  • Optionaltype: "random" | "sequence" = "random"

    The type of the block pattern.

  Returns Globals.modules.cmds.BlockPattern

  A new block pattern.

blocks

[]
Copy

type

"random"
Copy

raw

• get raw(): string

  The raw string representation of the block pattern.

  Returns string

  Example

  s:minecraft:example_block%36["facing"="west","fill_level"=5,"top_slot_bit"=true],minecraft:glass,minecraft:stone%10,minecraft:spruce_slab["top_slot_bit"=true]
  Copy

  Since

  v1.33.1-preview.20+BUILD.1

generateBlock

• generateBlock(
      generateIndex?: number | bigint,
      forceMode?: "random" | "sequence",
  ): BlockPatternEntry

  Gets a block pattern entry.

  Parameters

  • OptionalgenerateIndex: number | bigint = 0

    The current index of the generation. This is used to determine which block pattern entry to get if the type is "sequence".
  • OptionalforceMode: "random" | "sequence"

    The type of the block pattern. If specified, it will override the type property of the block pattern.

  Returns BlockPatternEntry

  The block pattern entry.

generateBlockP

• generateBlockP(
      generateIndex?: number | bigint,
      forceMode?: "random" | "sequence",
  ): BlockPermutation

  Gets a block permutation from a block pattern entry.

  Parameters

  • OptionalgenerateIndex: number | bigint = 0

    The current index of the generation. This is used to determine which block pattern entry to get if the type is "sequence".
  • OptionalforceMode: "random" | "sequence"

    The type of the block pattern. If specified, it will override the type property of the block pattern.

  Returns BlockPermutation

  The block permutation.

push

• push(...blocks: Omit<BlockPatternEntry, "raw" | "rawsb" | "rawns">[]): number

  Pushes a block pattern entry to the block pattern.

  Parameters

  • ...blocks: Omit<BlockPatternEntry, "raw" | "rawsb" | "rawns">[]

    The entries to push to the block pattern.

  Returns number

  The new amount of entries in the block pattern.

toString

• toString(): string

  Converts the block pattern to a string.

  It returns the same value as BlockPattern.prototype.raw.

  Returns string

  The raw string representation of the block pattern.

  Since

  v1.33.1-preview.20+BUILD.1

Staticextract

• extract(
      str: string,
      mode?: "random" | "sequence",
  ): Globals.modules.cmds.BlockPattern

  Extracts a block pattern from a string.

  Parameters

  • str: string

    The string to extract the block pattern from.
  • Optionalmode: "random" | "sequence"

    The type of the block pattern. If not provided, the mode will be determined based on the string.

  Returns Globals.modules.cmds.BlockPattern

  The block pattern extracted from the string.

StaticextractAll

• extractAll(
      str: string,
      mode?: "random" | "sequence",
  ): Globals.modules.cmds.BlockPattern[]

  Extracts all block patterns from a string.

  Parameters

  • str: string

    The string to extract the block patterns from.
  • Optionalmode: "random" | "sequence"

    The type of the block patterns. If not provided, the mode will be determined based on the string.

  Returns Globals.modules.cmds.BlockPattern[]

  The block patterns extracted from the string.

StaticextractAllRaw

• extractAllRaw(str: string): null | string[]

  Extracts all raw block patterns from a string.

  Parameters

  • str: string

    The string to extract the raw block patterns from.

  Returns null | string[]

  The raw block patterns, or null if no raw block patterns were found.

StaticextractAllWRaw

• extractAllWRaw(
      str: string,
      mode?: "random" | "sequence",
  ): { parsed: Globals.modules.cmds.BlockPattern[]; raw: null | string[] }

  Extracts all raw block patterns from a string and returns the raw strings and the parsed block patterns.

  Parameters

  • str: string

    The string to extract the raw block patterns from.
  • Optionalmode: "random" | "sequence"

    The type of the block patterns. If not provided, the mode will be determined based on the string. Only applies to the block patterns, the raw strings are not affected.

  Returns { parsed: Globals.modules.cmds.BlockPattern[]; raw: null | string[] }

  The raw strings and the parsed block patterns. Only applies to the block patterns, the raw strings are not affected.

StaticextractRaw

• extractRaw(str: string): null | string

  Extracts a raw block pattern from a string.

  Parameters

  • str: string

    The string to extract the raw block pattern from.

  Returns null | string

  The raw block pattern, or null if no raw block pattern was found.

StaticextractWRaw

• extractWRaw(
      str: string,
      mode?: "random" | "sequence",
  ): { parsed: Globals.modules.cmds.BlockPattern; raw: null | string }

  Extracts a block pattern from a string and returns the raw string and the parsed block pattern.

  Parameters

  • str: string

    The string to extract the block pattern from.
  • Optionalmode: "random" | "sequence"

    The type of the block pattern. If not provided, the mode will be determined based on the string. Only Only applies to the block pattern, the raw string is not affected.

  Returns { parsed: Globals.modules.cmds.BlockPattern; raw: null | string }

  The raw string and the parsed block pattern. Only applies to the block pattern, the raw string is not affected.

Staticparse

• parse(): void

  Parses a string into a BlockPattern object.

  Returns void

  Deprecated

  This function is non-functional, and does absolutely nothing.