SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias ExcavateTask

    ExcavateTask: Message<"soulfire.v1.ExcavateTask"> & {
        cornerA?: BlockPosition;
        cornerB?: BlockPosition;
        maximumBlocks: number;
        options?: PathfindOptions;
    }

    Clears every diggable block in an inclusive cuboid.

    Type Declaration

    • OptionalcornerA?: BlockPosition

      from field: soulfire.v1.BlockPosition corner_a = 1;

    • OptionalcornerB?: BlockPosition

      from field: soulfire.v1.BlockPosition corner_b = 2;

    • maximumBlocks: number

      Zero clears the whole cuboid. A positive limit bounds the task.

      from field: uint32 maximum_blocks = 4;

    • Optionaloptions?: PathfindOptions

      from field: soulfire.v1.PathfindOptions options = 3;

    from message soulfire.v1.ExcavateTask

    Settings
    Member Visibility