Class BlockVolumeBase

Base type for BlockVolumes.

Hierarchy (View Summary)

BlockVolumeBase

Index

Methods

getBlockLocationIterator getBoundingBox getCapacity getClosest getFarthest getMax getMin getSpan isInside translate

Methods

getBlockLocationIterator

getBlockLocationIterator(): BlockLocationIterator
Returns BlockLocationIterator

Remarks
Fetch a BlockLocationIterator that represents all of the block world locations within the specified volume
- Defined in @minecraft/server.d.ts:6575

getBoundingBox

getBoundingBox(): BlockBoundingBox
Beta
Returns BlockBoundingBox

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

Throws
- Defined in @minecraft/server.d.ts:6584

getCapacity

getCapacity(): number
Returns number

Remarks
Return the capacity (volume) of the BlockVolume (WDH)
- Defined in @minecraft/server.d.ts:6590

getClosest

getClosest(count: number, location: Vector3): Vector3[]
Parameters
- count: number
  Number of closest positions to return
- location: Vector3
  Position to measure distance from
Returns Vector3[]

Remarks
Returns a list of block positions within the volume that are closest to a given location, sorted by distance (nearest first)

Throws
ArgumentOutOfBoundsError
- Defined in @minecraft/server.d.ts:6603

getFarthest

getFarthest(count: number, location: Vector3): Vector3[]
Parameters
- count: number
  Number of farthest positions to return
- location: Vector3
  Position to measure distance from
Returns Vector3[]

Remarks
Returns a list of block positions within the volume that are farthest from a given location, sorted by distance (farthest first)

Throws
ArgumentOutOfBoundsError
- Defined in @minecraft/server.d.ts:6616

getMax

getMax(): Vector3
Returns Vector3

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

Throws
- Defined in @minecraft/server.d.ts:6624

getMin

getMin(): Vector3
Returns Vector3

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

Throws
- Defined in @minecraft/server.d.ts:6632

getSpan

getSpan(): Vector3
Returns Vector3

Remarks
Get a Vector3 object where each component represents the number of blocks along that axis
- Defined in @minecraft/server.d.ts:6639

isInside

isInside(location: Vector3): boolean
Parameters
- location: Vector3
Returns boolean

Remarks
Check to see if a given world block location is inside a BlockVolume
- Defined in @minecraft/server.d.ts:6646

translate

translate(delta: Vector3): void
Parameters
- delta: Vector3
  Amount of blocks to move by
Returns void

Remarks
Move a BlockVolume by a specified amount
- Defined in @minecraft/server.d.ts:6654