Class BlockVolumeBase

Base type for BlockVolumes.

Hierarchy (View Summary)

BlockVolumeBase
- BlockVolume
- ListBlockVolume

Index

Constructors

Methods

getBlockLocationIterator getBoundingBox getCapacity getMax getMin getSpan isInside translate

Constructors

`Private`constructor

new BlockVolumeBase(): BlockVolumeBase
Returns BlockVolumeBase

Methods

getBlockLocationIterator

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

World Ready
This function can't be called in early-execution mode.

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.

World Ready
This function can't be called in early-execution mode.

getCapacity

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

World Ready
This function can't be called in early-execution mode.

getMax

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

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

getMin

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

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

getSpan

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

World Ready
This function can't be called in early-execution mode.

isInside

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

World Ready
This function can't be called in early-execution mode.

translate

translate(delta: Vector3): void
Parameters
- delta: Vector3
  Amount of blocks to move by
Returns void
Remarks
Move a BlockVolume by a specified amount

World Ready
This function can't be called in early-execution mode.