@minecraft/server
    Preparing search index...

    Class BoundingBoxUtilsBeta

    Bounding Box Utils is a utility class that provides a number of useful functions for the creation and utility of BoundingBox objects

    Index

    Methods

    createValid dilate equals expand getCenter getIntersection getSpan intersects isInside isValid translate

    Methods

    • Beta

      Parameters

      • min: Vector3

        A corner world location

      • max: Vector3

        A corner world location diametrically opposite

      Returns BoundingBox

      Create a validated instance of a BoundingBox where the min and max components are guaranteed to be (min <= max)

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

    • Beta

      Parameters

      Returns BoundingBox

      Return a new BoundingBox object representing the changes

      Expand a BoundingBox by a given amount along each axis. Sizes can be negative to perform contraction. Note: corners can be inverted if the contraction size is greater than the span, but the min/max relationship will remain correct

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

    • Beta

      Parameters

      Returns BoundingBox

      A new BoundingBox instance representing the smallest possible bounding box which can encompass both

      Expand the initial box object bounds to include the 2nd box argument. The resultant BoundingBox object will be a BoundingBox which exactly encompasses the two boxes.

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

    • Beta

      Parameters

      Returns Vector3

      Note that BoundingBox objects represent whole blocks, so the center of boxes which have odd numbered bounds are not mathematically centered... i.e. a BoundingBox( 0,0,0 -> 3,3,3 ) would have a center of (1,1,1) (not (1.5, 1.5, 1.5) as expected)

      Calculate the center block of a given BoundingBox object.

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

    • Beta

      Parameters

      Returns undefined | BoundingBox

      Calculate the BoundingBox which represents the union area of two intersecting BoundingBoxes

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

    • Beta

      Parameters

      Returns Vector3

      Get the Span of each of the BoundingBox Axis components

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

    • Beta

      Parameters

      Returns boolean

      Check to see if two BoundingBox objects intersect

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

    • Beta

      Parameters

      Returns boolean

      Check to see if a given coordinate is inside a BoundingBox

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

    • Beta

      Parameters

      Returns boolean

      Check to see if a BoundingBox is valid (i.e. (min <= max))

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

    • Beta

      Parameters

      Returns BoundingBox

      Return a new BoundingBox object which represents the change

      Move a BoundingBox by a given amount

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

    Settings

    Member Visibility

    On This Page

    Methods