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

    Class RelativeVolumeListBlockVolume

    Base type for BlockVolumes.

    export class BlockVolumeBase {
        private constructor();
        getBlockLocationIterator(): BlockLocationIterator;
        getCapacity(): number;
        getMax(): Vector3;
        getMin(): Vector3;
        getSpan(): Vector3;
        isInside(location: Vector3): boolean;
        translate(delta: Vector3): void;
    }

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    isEmpty origin? volumeCount

    Methods

    add clear getBlockLocationIterator getBoundingBox getCapacity getClosest getFarthest getMax getMin getSpan getVolumeList hasAdjacent isInside moveTo remove set translate

    Constructors

    Properties

    isEmpty: boolean
    origin?: Vector3

    This property can't be edited in restricted-execution mode.

    This property can't be read in early-execution mode.

    volumeCount: number

    Methods

    • Returns void

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

      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.

    • Parameters

      Returns void

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

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods