Class RelativeVolumeListBlockVolume

Base type for BlockVolumes.

Hierarchy (View Summary)

BlockVolumeBase
- RelativeVolumeListBlockVolume

Index

Constructors

Properties

isEmpty origin? volumeCount

Methods

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

Constructors

constructor

new RelativeVolumeListBlockVolume(
origin?: Vector3,
): RelativeVolumeListBlockVolume
Parameters
- Optionalorigin: Vector3
Returns RelativeVolumeListBlockVolume
Overrides BlockVolumeBase.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

add(
    toAdd:
        | Vector3
        | Vector3[]
        | BlockVolume
        | BlockVolumeBase
        | RelativeVolumeListBlockVolume,
): void
Parameters
- toAdd:
      | Vector3
      | Vector3[]
      | BlockVolume
      | BlockVolumeBase
      | RelativeVolumeListBlockVolume
Returns void
Remarks
This function can't be called in read-only mode.

clear

clear(): void
Returns void
Remarks
This function can't be called in read-only mode.

getBlockLocationIterator

getBlockLocationIterator(): BlockLocationIterator
Returns BlockLocationIterator
Remarks
Fetch a BlockLocationIterator that represents all of the block world locations within the specified volume

Inherited from BlockVolumeBase.getBlockLocationIterator

getBoundingBox

getBoundingBox(): BlockBoundingBox
Beta
Returns BlockBoundingBox
Remarks
Return a BlockBoundingBox object which represents the validated min and max coordinates of the volume

Throws
This function can throw errors.

Inherited from BlockVolumeBase.getBoundingBox

getCapacity

getCapacity(): number
Returns number
Remarks
Return the capacity (volume) of the BlockVolume (WDH)

Inherited from BlockVolumeBase.getCapacity

getMax

getMax(): Vector3
Returns Vector3
Remarks
Get the largest corner position of the volume (guaranteed to be >= min)

Throws
This function can throw errors.

Inherited from BlockVolumeBase.getMax

getMin

getMin(): Vector3
Returns Vector3
Remarks
Get the smallest corner position of the volume (guaranteed to be <= max)

Throws
This function can throw errors.

Inherited from BlockVolumeBase.getMin

getSpan

getSpan(): Vector3
Returns Vector3
Remarks
Get a Vector3 object where each component represents the number of blocks along that axis

Inherited from BlockVolumeBase.getSpan

getVolumeList

getVolumeList(): BlockVolume[]
Returns BlockVolume[]
Remarks
This function can't be called in read-only mode.

hasAdjacent

hasAdjacent(location: Vector3, normalizedOffset: Vector3): boolean
Parameters
- location: Vector3
- normalizedOffset: Vector3
Returns boolean

isInside

isInside(location: Vector3): boolean
Parameters
- location: Vector3
Returns boolean
Remarks
Check to see if a given world block location is inside a BlockVolume

Inherited from BlockVolumeBase.isInside

moveTo

moveTo(location: Vector3): void
Parameters
- location: Vector3
Returns void
Remarks
This function can't be called in read-only mode.

remove

remove(
    toRemove:
        | Vector3
        | Vector3[]
        | BlockVolume
        | BlockVolumeBase
        | RelativeVolumeListBlockVolume,
): void
Parameters
- toRemove:
      | Vector3
      | Vector3[]
      | BlockVolume
      | BlockVolumeBase
      | RelativeVolumeListBlockVolume
Returns void
Remarks
This function can't be called in read-only mode.

set

set(
    toSet:
        | Vector3
        | Vector3[]
        | BlockVolume
        | BlockVolumeBase
        | RelativeVolumeListBlockVolume,
): void
Parameters
- toSet:
      | Vector3
      | Vector3[]
      | BlockVolume
      | BlockVolumeBase
      | RelativeVolumeListBlockVolume
Returns void
Remarks
This function can't be called in read-only mode.

translate

translate(offset: Vector3): void
Parameters
- offset: Vector3
Returns void
Remarks
This function can't be called in read-only mode.

Overrides BlockVolumeBase.translate