Function fillBlocksHFFGB

  • fillBlocksHFFGB(
        begin: Vector3,
        end: Vector3,
        dimension: Dimension,
        options?: { minMSBetweenYields?: number },
        integrity?: number,
    ): Promise<
        {
            completionData: {
                containsUnloadedChunks?: boolean;
                done: boolean;
                endTick?: number;
                endTime?: number;
                startTick: number;
                startTime: number;
            };
            counter: number;
        },
    >

    Generates a flood fill.

    Parameters

    • begin: Vector3

      The location of a corner of the area to flood.

    • end: Vector3

      The location of the opposite corner of the area to flood.

    • dimension: Dimension

      The dimension to generate the flood fill in.

    • Optionaloptions: { minMSBetweenYields?: number }

      Optional extra options for the fill generation execution.

      • OptionalminMSBetweenYields?: number

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

    • integrity: number = 100

      The integrity of the flood 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 flood fill generation once the flood fill generation is complete.

    Deprecated

    Legacy function. Superceeded by fillFlood.

    Async

Settings

Member Visibility