@minecraft/server

---

@minecraft/server / BlockVolumeBase

Class: BlockVolumeBase

Defined in: @minecraft/server/index.d.ts:5894

Base type for BlockVolumes.

Extended by

• BlockVolume
• ListBlockVolume

Methods

getBlockLocationIterator()

getBlockLocationIterator(): BlockLocationIterator

Defined in: @minecraft/server/index.d.ts:5902

Returns

BlockLocationIterator

Remarks

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

---

getCapacity()

getCapacity(): number

Defined in: @minecraft/server/index.d.ts:5908

Returns

number

Remarks

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

---

getMax()

getMax(): Vector3

Defined in: @minecraft/server/index.d.ts:5916

Returns

Vector3

Remarks

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

Throws

This function can throw errors.

---

getMin()

getMin(): Vector3

Defined in: @minecraft/server/index.d.ts:5924

Returns

Vector3

Remarks

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

Throws

This function can throw errors.

---

getSpan()

getSpan(): Vector3

Defined in: @minecraft/server/index.d.ts:5931

Returns

Vector3

Remarks

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

---

isInside()

isInside(location): boolean

Defined in: @minecraft/server/index.d.ts:5938

Parameters

location

Vector3

Returns

boolean

Remarks

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

---

translate()

translate(delta): void

Defined in: @minecraft/server/index.d.ts:5946

Parameters

delta

Vector3

Amount of blocks to move by

Returns

void

Remarks

Move a BlockVolume by a specified amount