Script API - v26.40.29
    Preparing search index...

    Class BlockVolumeBase

    Base type for BlockVolumes.

    export class BlockVolumeBase {
        private constructor();
        getBlockLocationIterator(): BlockLocationIterator;
        getBoundingBox(): BlockBoundingBox;
        getCapacity(): number;
        getClosest(count: number, location: Vector3): Vector3[];
        getFarthest(count: number, location: Vector3): Vector3[];
        getMax(): Vector3;
        getMin(): Vector3;
        getSpan(): Vector3;
        isInside(location: Vector3): boolean;
        translate(delta: Vector3): void;
    }

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    getBlockLocationIterator getBoundingBox getCapacity getClosest getFarthest getMax getMin getSpan isInside translate

    Constructors

    Methods

    • Returns number

      Return the capacity (volume) of the BlockVolume (WDH)

      This function can't be called in early-execution mode.

    • Beta

      Parameters

      • count: number

        Number of closest positions to return

      • location: Vector3

        Position to measure distance from

      Returns Vector3[]

      Returns a list of block positions within the volume that are closest to a given location, sorted by distance (nearest first)

      This function can throw errors.

      minecraftcommon.ArgumentOutOfBoundsError

      This function can't be called in early-execution mode.

    • Beta

      Parameters

      • count: number

        Number of farthest positions to return

      • location: Vector3

        Position to measure distance from

      Returns Vector3[]

      Returns a list of block positions within the volume that are farthest from a given location, sorted by distance (farthest first)

      This function can throw errors.

      minecraftcommon.ArgumentOutOfBoundsError

      This function can't be called in early-execution mode.

    • Returns Vector3

      Get the largest corner position of the volume (guaranteed to be >= min)

      This function can throw errors.

      This function can't be called in early-execution mode.

    • Returns Vector3

      Get the smallest corner position of the volume (guaranteed to be <= max)

      This function can throw errors.

      This function can't be called in early-execution mode.

    • Parameters

      Returns boolean

      Check to see if a given world block location is inside a BlockVolume

      This function can't be called in early-execution mode.

    • Parameters

      • delta: Vector3

        Amount of blocks to move by

      Returns void

      Move a BlockVolume by a specified amount

      This function can't be called in early-execution mode.

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods