Class ListBlockVolume

Volume composed of an unordered container of unique block locations.

Hierarchy (View Summary)

BlockVolumeBase
- ListBlockVolume

Index

Constructors

Methods

add getBlockLocationIterator getBoundingBox getCapacity getMax getMin getSpan isInside remove translate

Constructors

constructor

new ListBlockVolume(locations: Vector3[]): ListBlockVolume
Parameters
- locations: Vector3[]
  Initial array of block locations that ListBlockVolume will be constructed with.
Returns ListBlockVolume
Remarks
Creates a new instance of ListBlockVolume.
Overrides BlockVolumeBase.constructor
- Defined in @minecraft/server.d.ts:14666

Methods

add

add(locations: Vector3[]): void
Parameters
- locations: Vector3[]
  Array of block locations to be inserted into container.
Returns void
Remarks
Insert block locations into container.
- Defined in @minecraft/server.d.ts:14674

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
- Defined in @minecraft/server.d.ts:5830

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
- Defined in @minecraft/server.d.ts:5839

getCapacity

getCapacity(): number
Returns number
Remarks
Return the capacity (volume) of the BlockVolume (WDH)
Inherited from BlockVolumeBase.getCapacity
- Defined in @minecraft/server.d.ts:5845

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
- Defined in @minecraft/server.d.ts:5853

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
- Defined in @minecraft/server.d.ts:5861

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
- Defined in @minecraft/server.d.ts:5868

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
- Defined in @minecraft/server.d.ts:5875

remove

remove(locations: Vector3[]): void
Parameters
- locations: Vector3[]
  Array of block locations to be removed from container.
Returns void
Remarks
Remove block locations from container.
- Defined in @minecraft/server.d.ts:14682

translate

translate(delta: Vector3): void
Parameters
- delta: Vector3
  Amount of blocks to move by
Returns void
Remarks
Move a BlockVolume by a specified amount
Inherited from BlockVolumeBase.translate
- Defined in @minecraft/server.d.ts:5883