Class RelativeVolumeListBlockVolume

Hierarchy

  • BlockVolumeBase
    • RelativeVolumeListBlockVolume

Constructors

constructor

Properties

isEmpty origin? volumeCount

Methods

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

Constructors

constructor

Properties

Readonly isEmpty

isEmpty: boolean

Optional origin

origin?: Vector3

Remarks

This property can't be edited in read-only mode.

Readonly volumeCount

volumeCount: number

Methods

add

  • Parameters

    Returns void

    Remarks

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

clear

  • Returns void

    Remarks

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

getBlockLocationIterator

  • Returns BlockLocationIterator

    Remarks

    Fetch a BlockLocationIterator that represents all of the block world locations within the specified volume

getBoundingBox

  • Beta

    Returns BoundingBox

    Remarks

    Return a BoundingBox object which represents the validated min and max coordinates of the volume

    Throws

    This function can throw errors.

getCapacity

  • Returns number

    Remarks

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

getMax

  • Returns Vector3

    Remarks

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

    Throws

    This function can throw errors.

getMin

  • Returns Vector3

    Remarks

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

    Throws

    This function can throw errors.

getSpan

  • Returns Vector3

    Remarks

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

getVolumeList

  • Returns BlockVolume[]

    Remarks

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

hasAdjacent

  • Parameters

    • location: Vector3
    • normalizedOffset: Vector3

    Returns boolean

isInside

  • Parameters

    • location: Vector3

    Returns boolean

    Remarks

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

moveTo

  • Parameters

    • location: Vector3

    Returns void

    Remarks

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

remove

  • Parameters

    Returns void

    Remarks

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

set

  • Parameters

    Returns void

    Remarks

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

translate

  • Parameters

    • offset: Vector3

    Returns void

    Remarks

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

Settings

Member Visibility

Theme

On This Page