Skip to main content

Class: BlockLocationIterator

A BlockLocationIterator returns the next block location of the block volume across which it is iterating. The BlockLocationIterator is used to abstract the shape of the block volume it was fetched from (so it can represent all the block locations that make up rectangles, cubes, spheres, lines and complex shapes). Each iteration pass returns the next valid block location in the parent shape. Unless otherwise specified by the parent shape - the BlockLocationIterator will iterate over a 3D space in the order of increasing X, followed by increasing Z followed by increasing Y. (Effectively stepping across the XZ plane, and when all the locations in that plane are exhausted, increasing the Y coordinate to the next XZ slice)

Implements​

Constructors​

new BlockLocationIterator()​

private new BlockLocationIterator(): BlockLocationIterator

Returns​

BlockLocationIterator

Methods​

[iterator]()​

[iterator](): Iterator ↗️ <Vector3, any, undefined>

Returns​

Iterator ↗️ <Vector3, any, undefined>

Implementation of​

Iterable.[iterator]

Remarks​

This function can't be called in read-only mode.

next()​

next(): IteratorResult ↗️ <Vector3, any>

Returns​

IteratorResult ↗️ <Vector3, any>

Remarks​

This function can't be called in read-only mode.