Function fillBlocksHFG

  • fillBlocksHFG(
        begin: Vector3,
        end: Vector3,
        dimension: Dimension,
        block: string | (location: DimensionLocation, index: bigint) => BlockType,
        blockStates?: Record<string, string | number | boolean>,
        options?: {
            matchingBlock?: string;
            matchingBlockStates?: Record<string, string | number | boolean>;
            minMSBetweenYields?: number;
        },
        placeholderid?: string,
        replacemode?: boolean,
        integrity?: number,
    ): Promise<
        {
            completionData: {
                containsUnloadedChunks?: boolean;
                done: boolean;
                endTick?: number;
                endTime?: number;
                startTick: number;
                startTime: number;
            };
            counter: number;
        },
    >

    Generates a fill.

    Parameters

    • begin: Vector3

      The location of a corner of the area to fill in.

    • end: Vector3

      The location of the opposite corner of the area to fill in.

    • dimension: Dimension

      The dimension to generate the fill in.

    • block: string | (location: DimensionLocation, index: bigint) => BlockType

      A string representing the block type to generate or a function to determine the BlockType to generate.

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

      The block states of the block permutation to generate.

    • Optionaloptions: {
          matchingBlock?: string;
          matchingBlockStates?: Record<string, string | number | boolean>;
          minMSBetweenYields?: number;
      }

      Optional extra options for the fill generation execution.

      • OptionalmatchingBlock?: string

        The type of the block mask to match.

      • OptionalmatchingBlockStates?: Record<string, string | number | boolean>

        The block states of the block mask to match.

      • OptionalminMSBetweenYields?: number

        The shortest the generation can run for before pausing until the next tick.

    • Optionalplaceholderid: string

      The namespaced id of the block type to use as a placeholder block during generation.

    • replacemode: boolean = false

      Whether or not to clear container blocks before replacing them.

    • integrity: number = 100

      The integrity of the fill generation.

    Returns Promise<
        {
            completionData: {
                containsUnloadedChunks?: boolean;
                done: boolean;
                endTick?: number;
                endTime?: number;
                startTick: number;
                startTime: number;
            };
            counter: number;
        },
    >

    A promise that resolves with the details of the fill generation once the fill generation is complete.

    Deprecated

    Legacy function. Superceeded by fillBlocksHFGB.

    Async

Settings

Member Visibility