Function fillBlocksHSGGB

  • fillBlocksHSGGB(
        from: Vector3,
        to: Vector3,
        skygridSize: number,
        dimension: Dimension,
        block: (location: DimensionLocation, index: bigint) => BlockPermutation,
        options?: {
            matchingBlock?: string;
            matchingBlockStates?: Record<string, string | number | boolean>;
            minMSBetweenYields?: number;
        },
        replacemode?: boolean,
        integrity?: number,
    ): Promise<
        {
            completionData: {
                containsUnloadedChunks?: boolean;
                done: boolean;
                endTick?: number;
                endTime?: number;
                startTick: number;
                startTime: number;
            };
            counter: number;
        },
    >

    Generates a skygrid.

    Parameters

    • from: Vector3

      The location of a corner of the area to generate the skygrid in.

    • to: Vector3

      The location of the opposite corner of the area to generate the skygrid in.

    • skygridSize: number

      The size of the skygrid.

    • dimension: Dimension

      The dimension to generate the skygrid in.

    • block: (location: DimensionLocation, index: bigint) => BlockPermutation

      The block type of the BlockPermutation to generate.

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

      Optional extra options for the skygrid generation execution.

    • replacemode: boolean = false

      Whether or not to clear container blocks before replacing them.

    • integrity: number = 100

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

    Since

    1.18.0-development.20

    Deprecated

    Legacy function. Superceeded by fillSkygrid.

    Version

    1.0.0

    Async

Settings

Member Visibility