Script API - v1.21.60
    Preparing search index...

    Class ListBlockVolume

    Volume composed of an unordered container of unique block locations.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    add getBlockLocationIterator getCapacity getMax getMin getSpan isInside remove translate

    Constructors

    Methods

    • Parameters

      • locations: Vector3[]

        Array of block locations to be inserted into container.

      Returns void

      Insert block locations into container.

      This function can't be called in read-only mode.

    • Returns number

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

      This function can't be called in read-only mode.

    • Returns Vector3

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

      This function can't be called in read-only mode.

      This function can throw errors.

    • Returns Vector3

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

      This function can't be called in read-only mode.

      This function can throw errors.

    • Returns Vector3

      Get a Vector3 object where each component represents the number of blocks along that axis

      This function can't be called in read-only mode.

    • Parameters

      Returns boolean

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

      This function can't be called in read-only mode.

    • Parameters

      • locations: Vector3[]

        Array of block locations to be removed from container.

      Returns void

      Remove block locations from container.

      This function can't be called in read-only 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 read-only mode.

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods