Function overlayArea

overlayArea<LiteModeEnabled extends boolean = false>(
    begin: Vector3,
    end: Vector3,
    dimension: Dimension,
    block: (location: DimensionLocation, index: bigint) => BlockPermutation,
    options?: OverlayAreaOptions<LiteModeEnabled>,
): Promise<
    LiteModeEnabled extends true
        ? {
            containsUnloadedChunks: boolean;
            endTick: number;
            endTime: number;
            startTick: number;
            startTime: number;
        }
        : {
            containsUnloadedChunks: boolean;
            counter: bigint;
            endTick: number;
            endTime: number;
            startTick: number;
            startTime: number;
        },
>
Covers the blocks in the specified area. Supports block masks.
Type Parameters
- LiteModeEnabled extends boolean = false
  Whether to skip keeping track of how many blocks were actually changed.
Parameters
- begin: Vector3
  The location of a corner of the area to cover.
- end: Vector3
  The location of the opposite corner of the area to cover.
- dimension: Dimension
  The dimension of the area to cover.
- block: (location: DimensionLocation, index: bigint) => BlockPermutation
  The function to determine the BlockPermutation to generate.
- Optionaloptions: OverlayAreaOptions<LiteModeEnabled>
  Optional extra options for the overlay generation execution.
Returns Promise<
    LiteModeEnabled extends true
        ? {
            containsUnloadedChunks: boolean;
            endTick: number;
            endTime: number;
            startTick: number;
            startTime: number;
        }
        : {
            containsUnloadedChunks: boolean;
            counter: bigint;
            endTick: number;
            endTime: number;
            startTick: number;
            startTime: number;
        },
>
A promise that resolves with the details of the overlay generation once the overlay generation is complete.

Async
- Defined in modules/block_generation_utilities/functions/overlayArea.ts:75

Function overlayArea

Type Parameters

Parameters

Returns Promise< LiteModeEnabled extends true ? { containsUnloadedChunks: boolean; endTick: number; endTime: number; startTick: number; startTime: number; } : { containsUnloadedChunks: boolean; counter: bigint; endTick: number; endTime: number; startTick: number; startTime: number; },>

Async

Settings

Returns Promise<
LiteModeEnabled extends true
? {
containsUnloadedChunks: boolean;
endTick: number;
endTime: number;
startTick: number;
startTime: number;
}
: {
containsUnloadedChunks: boolean;
counter: bigint;
endTick: number;
endTime: number;
startTick: number;
startTime: number;
},
>