Function fillCylinder

  • fillCylinder<LiteModeEnabled extends boolean = false>(
        center: Vector3,
        radius: number,
        length: number,
        axis: "x" | "y" | "z",
        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 cylinder in the specified area. Supports block masks.

    Type Parameters

    • LiteModeEnabled extends boolean = false

    Parameters

    • center: Vector3

      The location of the center of the cylinder.

    • radius: number

      The radius of the cylinder.

    • length: number

      The length of the cylinder.

    • axis: "x" | "y" | "z"

      The axis of the cylinder.

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

    Warning

    THIS FUNCTION NEEDS LOTS OF TESTING AS IT WAS GREATLY SIMPLIFIED WHEN THE AI CHANGED IT TO GENERATE CYLINDERS INSTEAD OF SPHERES, AND REMOVED THE BLOCK MASK MATCHER, SO I HAD TO ADD IT BACK AGIAN, SO OTHER FUNCTIONS MIGHT HAVE GOT MESSED UP TOO!

    Todo

    Test this function FULLY.

Settings

Member Visibility