Class KeyIterator

A key range iterator.

Implements

Iterator<number>
Iterable<number>

Index

Constructors

Methods

[iterator] next reset return

Constructors

constructor

new KeyIterator(keyDesign, min, max): KeyIterator
Constructs a new key iterator.

This iterator returns all keys in the specified coordinate range, including those at min and max.
Parameters
- keyDesign: KeyDesign
  A key design.
- min: Vector3
  The lower index bounds (zero-based uint coordinates).
- max: Vector3
  The upper index bounds (zero-based uint coordinates).
Returns KeyIterator
- Defined in core/KeyIterator.ts:62

Methods

[iterator]

[iterator](): Iterator<number, any, undefined>
Returns Iterator<number, any, undefined>
Implementation of Iterable.[iterator]
- Defined in core/KeyIterator.ts:160

next

next(): IteratorResult<number, any>
Returns IteratorResult<number, any>
Implementation of Iterator.next
- Defined in core/KeyIterator.ts:110

reset

reset(): KeyIterator
Returns KeyIterator
- Defined in core/KeyIterator.ts:75

return

return(value): IteratorResult<number, any>
Parameters
- value: number
Returns IteratorResult<number, any>
Implementation of Iterator.return
- Defined in core/KeyIterator.ts:151