Function fillSphere

  • fillSphere<LiteModeEnabled extends boolean = false>(
        center: Vector3,
        radius: number,
        dimension: Dimension,
        block: (location: DimensionLocation, index: bigint) => BlockPermutation,
        options?: {
            blockMask: Globals.modules.cmds.BlockMask;
            integrity?: number;
            liteMode?: LiteModeEnabled;
            minMSBetweenTickWaits?: number;
            replacemode?: boolean;
        },
    ): 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;
            },
    >

    Generates a sphere in the specified area. Supports block masks.

    Type Parameters

    • LiteModeEnabled extends boolean = false

    Parameters

    • center: Vector3

      The location of the center of the sphere.

    • radius: number

      The radius of the sphere.

    • 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;
          integrity?: number;
          liteMode?: LiteModeEnabled;
          minMSBetweenTickWaits?: number;
          replacemode?: boolean;
      }

      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.

      • Optionalreplacemode?: boolean

        Whether or not to clear container blocks before replacing them.

    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 sphere block filling functions.

Settings

Member Visibility