Class BoundingBoxUtilsBeta

Bounding Box Utils is a utility class that provides a number of useful functions for the creation and utility of @minecraft-server.BoundingBox objects

Methods

createValid dilate equals expand getCenter getIntersection getSpan intersects isInside isValid translate

Methods

StaticcreateValid

  • createValid(min: Vector3, max: Vector3): BoundingBox
    Beta

    Parameters

    • min: Vector3

      A corner world location

    • max: Vector3

      A corner world location diametrically opposite

    Returns BoundingBox

    Remarks

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

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

Staticdilate

  • dilate(box: BoundingBox, size: Vector3): BoundingBox
    Beta

    Parameters

    Returns BoundingBox

    Return a new @minecraft-server.BoundingBox object representing the changes

    Remarks

    Expand a @minecraft-server.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.

Staticequals

  • equals(box: BoundingBox, other: BoundingBox): boolean
    Beta

    Parameters

    Returns boolean

    Remarks

    Check if two @minecraft-server.BoundingBox objects are identical

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

Staticexpand

  • expand(box: BoundingBox, other: BoundingBox): BoundingBox
    Beta

    Parameters

    Returns BoundingBox

    A new @minecraft-server.BoundingBox instance representing the smallest possible bounding box which can encompass both

    Remarks

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

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

StaticgetCenter

  • getCenter(box: BoundingBox): Vector3
    Beta

    Parameters

    Returns Vector3

    Note that @minecraft-server.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)

    Remarks

    Calculate the center block of a given @minecraft-server.BoundingBox object.

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

StaticgetIntersection

StaticgetSpan

  • getSpan(box: BoundingBox): Vector3
    Beta

    Parameters

    Returns Vector3

    Remarks

    Get the Span of each of the BoundingBox Axis components

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

Staticintersects

  • intersects(box: BoundingBox, other: BoundingBox): boolean
    Beta

    Parameters

    Returns boolean

    Remarks

    Check to see if two BoundingBox objects intersect

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

StaticisInside

  • isInside(box: BoundingBox, pos: Vector3): boolean
    Beta

    Parameters

    Returns boolean

    Remarks

    Check to see if a given coordinate is inside a BoundingBox

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

StaticisValid

  • isValid(box: BoundingBox): boolean
    Beta

    Parameters

    Returns boolean

    Remarks

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

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

Statictranslate

Settings

Member Visibility

On This Page

Methods