Function fillBlocksHFGBM

  • fillBlocksHFGBM(
        begin: Vector3,
        end: Vector3,
        dimension: Dimension,
        block: (location: DimensionLocation, index: bigint) => BlockPermutation,
        options?: {
            blockMask: Globals.modules.cmds.BlockMask;
            minMSBetweenYields?: number;
        },
        replacemode?: boolean,
        integrity?: number,
    ): Promise<
        {
            completionData: {
                containsUnloadedChunks?: boolean;
                done: boolean;
                endTick?: number;
                endTime?: number;
                startTick: number;
                startTime: number;
            };
            counter: number;
        },
    >

    Generates a fill. Supports block masks.

    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: (location: DimensionLocation, index: bigint) => BlockPermutation

      The function to determine the BlockPermutation to generate.

    • Optionaloptions: { blockMask: Globals.modules.cmds.BlockMask; minMSBetweenYields?: number }

      Optional extra options for the fill generation execution.

      • blockMask: Globals.modules.cmds.BlockMask

        The block mask to match.

      • OptionalminMSBetweenYields?: number

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

    • 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 fillArea.

    Async

Settings

Member Visibility