Class BlockMask

constructor

• new BlockMask(
      blocks?: Omit<BlockMaskFilter, "raw" | "rawsb" | "rawns">[],
      type?: "include" | "exclude",
  ): Globals.modules.cmds.BlockMask

  Creates a new block mask.

  Parameters

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

    The filters for the block mask.
  • Optionaltype: "include" | "exclude" = "include"

    The type of the block mask.

  Returns Globals.modules.cmds.BlockMask

  A new block mask.

type

"include"
Copy

blocks

• get blocks(): BlockMaskFilter[]

  The filters in the block mask.

  Returns BlockMaskFilter[]
• set blocks(blocks: Omit<BlockMaskFilter, "raw" | "rawsb" | "rawns">[]): void

  Parameters

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

  Returns void

blockTypes

• get blockTypes(): string[]

  The block IDs and filters types in the block mask.

  Returns string[]

includesStates

• get includesStates(): boolean

  Whether the block mask has any filters with block states.

  Returns boolean

raw

• get raw(): string

  The raw string representation of the block mask.

  Returns string

  Example

  e:preset:liquid,minecraft:example_block["facing"="west","fill_level"=5,"top_slot_bit"=true],tag:minecraft:example_tag
  Copy

evaluateIds

• evaluateIds(): void

  Evaluates the block IDs and filters types in the block mask.

  This method does the following things:

  • Removes any filters that have a block ID of "none" or "any".
  • Converts any filter that is missing its raw, rawsb, or rawns getter to a BlockMaskFilter that does have the getters.

  Returns void

push

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

  Pushes new filters to the block mask.

  Parameters

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

    The filters to push to the block mask.

  Returns number

  The new amount of filters in the block mask.

testIfMatches

• testIfMatches(
      block:
          | string
          | Block
          | BlockPermutation
          | BlockType
          | {
              states?: Record<string, string | number | boolean>;
              type: string | BlockType;
          },
      mode?: "include" | "exclude",
  ): boolean

  Tests if a block matches the block mask.

  Parameters

  • block:
        | string
        | Block
        | BlockPermutation
        | BlockType
        | {
            states?: Record<string, string | number | boolean>;
            type: string | BlockType;
        }

    The block to test.
  • Optionalmode: "include" | "exclude" = ...

    The mode to test in. If specified, this paramter will override the block mask's type property.

  Returns boolean

  Whether the block matches the block mask.

toString

• toString(): string

  Converts the block mask to a string.

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

  Returns string

  The raw string representation of the block mask.

Staticextract

• extract(
      str: string,
      extraIdParsingEnabled?: boolean,
      modeOverride?: "include" | "exclude",
  ): Globals.modules.cmds.BlockMask

  Extracts a block mask from a string.

  Parameters

  • str: string

    The string to extract the block mask from.
  • OptionalextraIdParsingEnabled: boolean = true

    Whether to enable extra ID parsing. If emabled, filters with block IDs of "none" or "any" will be removed.
  • OptionalmodeOverride: "include" | "exclude"

    Override the mode of the block mask. If not provided, the mode will be determined based on the string.

  Returns Globals.modules.cmds.BlockMask

  The block mask extracted from the string.

StaticextractAll

• extractAll(
      str: string,
      extraIdParsingEnabled?: boolean,
      modeOverride?: "include" | "exclude",
  ): Globals.modules.cmds.BlockMask[]

  Extracts all block masks from a string.

  Parameters

  • str: string

    The string to extract the block masks from.
  • OptionalextraIdParsingEnabled: boolean = true

    Whether to enable extra ID parsing. If emabled, filters with block IDs of "none" or "any" will be removed.
  • OptionalmodeOverride: "include" | "exclude"

    Override the mode of the block mask. If not provided, the mode will be determined based on the string.

  Returns Globals.modules.cmds.BlockMask[]

  The block masks extracted from the string.

StaticextractAllRaw

• extractAllRaw(str: string): string[]

  Extracts the raw strings of all block masks from a string.

  Parameters

  • str: string

    The string to extract the block masks from.

  Returns string[]

  The raw strings of the block masks extracted from the string, or null if no block masks were found.

StaticextractAllWRaw

• extractAllWRaw(
      str: string,
      extraIdParsingEnabled?: boolean,
      modeOverride?: "include" | "exclude",
  ): { parsed: Globals.modules.cmds.BlockMask[]; raw: string[] }

  Extracts all block masks from a string and their raw strings.

  Parameters

  • str: string

    The string to extract the block masks from.
  • OptionalextraIdParsingEnabled: boolean = true

    Whether to enable extra ID parsing. If emabled, filters with block IDs of "none" or "any" will be removed. Only applies to the block masks, the raw strings are not affected.
  • OptionalmodeOverride: "include" | "exclude"

    Override the mode of the block mask. If not provided, the mode will be determined based on the string. Only applies to the block masks, the raw strings are not affected.

  Returns { parsed: Globals.modules.cmds.BlockMask[]; raw: string[] }

  An object containing the raw strings and the block masks extracted from the string.

StaticextractRaw

• extractRaw(str: string): string

  Extracts a raw block mask from a string.

  Parameters

  • str: string

    The string to extract the raw block mask from.

  Returns string

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

StaticextractWRaw

• extractWRaw(
      str: string,
      extraIdParsingEnabled?: boolean,
      modeOverride?: "include" | "exclude",
  ): { parsed: Globals.modules.cmds.BlockMask; raw: string }

  Extracts a block mask and its raw string from a string.

  Parameters

  • str: string

    The string to extract the block mask from.
  • OptionalextraIdParsingEnabled: boolean = true

    Whether to enable extra ID parsing. If emabled, filters with block IDs of "none" or "any" will be removed. Only applies to the block mask, the raw string is not affected.
  • OptionalmodeOverride: "include" | "exclude"

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

  Returns { parsed: Globals.modules.cmds.BlockMask; raw: string }

  The raw string and the block mask extracted from the string.

Staticparse

• parse(): void

  Parses a string into a BlockMask object.

  Returns void

  Deprecated

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

StatictestForStatesMatch

• testForStatesMatch(
      states: Record<string, string | number | boolean>,
      statesMask: Record<string, string | number | boolean>,
  ): boolean

  Tests if the states in the first parameter extend the states in the second parameter.

  Parameters

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

    The states to test.
  • statesMask: Record<string, string | number | boolean>

    The states to test against.

  Returns boolean

  True if the states in the first parameter extend the states in the second parameter, false otherwise.

  Example

  const BlockMask = modules.cmds.BlockMask;
  
  const states = {
    "foo": true,
    "bar": false,
  };
  const statesMask = {
    "foo": true,
    "bar": true,
  };
  const result = BlockMask.testForStatesMatch(states, statesMask);
  console.log(result); // false
  Copy

  Example

  const BlockMask = modules.cmds.BlockMask;
  
  const states = {
    "foo": true,
    "bar": false,
  };
  const statesMask = {
    "foo": true,
  };
  const result = BlockMask.testForStatesMatch(states, statesMask);
  console.log(result); // true
  Copy

  Example

  const BlockMask = modules.cmds.BlockMask;
  
  const states = {
    "foo": true,
    "bar": false,
  };
  const statesMask = {
    "foo": true,
    "bar": false,
    "baz": false,
  };
  const result = BlockMask.testForStatesMatch(states, statesMask);
  console.log(result); // false
  Copy