Function fillDrain

  • fillDrain<LiteModeEnabled extends boolean = false>(
        begin: Vector3,
        end: Vector3,
        dimension: Dimension,
        options?: {
            blockMask: Globals.modules.cmds.BlockMask;
            integrity?: number;
            liteMode?: LiteModeEnabled;
            minMSBetweenTickWaits?: number;
        },
    ): Promise<
        LiteModeEnabled extends true
            ? {
                containsUnloadedChunks: boolean;
                endTick: number;
                endTime: number;
                startTick: number;
                startTime: number;
            }
            : {
                containsUnloadedChunks: boolean;
                counter: bigint;
                done: boolean;
                endTick: number;
                endTime: number;
                startTick: number;
                startTime: number;
            },
    >

    Drains the specified area. Supports block masks.

    Type Parameters

    • LiteModeEnabled extends boolean = false

    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.

    • Optionaloptions: {
          blockMask: Globals.modules.cmds.BlockMask;
          integrity?: number;
          liteMode?: LiteModeEnabled;
          minMSBetweenTickWaits?: number;
      }

      Optional extra options for the fill generation execution.

      • blockMask: Globals.modules.cmds.BlockMask

        The block mask to match.

      • Optionalintegrity?: number

        The integrity of the fill generation.

      • OptionalliteMode?: LiteModeEnabled

        Whether to skip keeping track of how many blocks were actually changed.

      • OptionalminMSBetweenTickWaits?: number

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

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

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

    Async

    Remarks

    The most modern version of the drain filling functions.

Settings

Member Visibility