Function fillBlocksHSG

  • fillBlocksHSG(
        center: Vector3,
        radius: number,
        dimension: Dimension,
        block: string,
        blockStates?: Record<string, string | number | boolean>,
        options?: {
            matchingBlock?: string;
            matchingBlockStates?: Record<string, string | number | boolean>;
            minMSBetweenYields?: number;
        },
        placeholderid?: string,
        replacemode?: boolean,
        integrity?: number,
    ): Promise<
        {
            completionData: {
                containsUnloadedChunks?: boolean;
                done: boolean;
                endTick?: number;
                endTime?: number;
                startTick: number;
                startTime: number;
            };
            counter: number;
        },
    >

    Generates a sphere.

    Parameters

    • center: Vector3

      The location of the center of the sphere.

    • radius: number

      Radius of the sphere.

    • dimension: Dimension

      The dimension to generate the sphere in.

    • block: string

      The block type of the block permutation to generate.

    • OptionalblockStates: Record<string, string | number | boolean>

      The block states of the block permutation to generate.

    • Optionaloptions: {
          matchingBlock?: string;
          matchingBlockStates?: Record<string, string | number | boolean>;
          minMSBetweenYields?: number;
      }

      Optional extra options for the sphere generation execution.

      • OptionalmatchingBlock?: string

        The type of the block mask to match.

      • OptionalmatchingBlockStates?: Record<string, string | number | boolean>

        The block states of the block mask to match.

      • OptionalminMSBetweenYields?: number

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

    • Optionalplaceholderid: string

      The namespaced id of the block type to use as a placeholder block during generation.

    • replacemode: boolean = false

      Whether or not to clear container blocks before replacing them.

    • integrity: number = 100

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

    Deprecated

    Legacy function. Superceeded by fillBlocksHSGB.

    Async

Settings

Member Visibility