zscript-doc/api/level/LineIdIterator.md

24 lines
362 B
Markdown
Raw Permalink Normal View History

2018-12-29 16:05:19 -08:00
# LineIdIterator
Iterates over line indices with a specified tag.
```
class LineIdIterator : Object
2018-12-29 16:05:19 -08:00
{
2019-08-14 03:32:51 -07:00
static LineIdIterator Create(int tag);
2018-12-29 16:05:19 -08:00
2019-08-14 03:32:51 -07:00
int Next();
2018-12-29 16:05:19 -08:00
}
```
2019-08-14 03:31:41 -07:00
### `Create`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
Creates a new iterator over lines with tag `tag`.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `Next`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
Returns the index of the current line and advances the iterator. Returns `-1`
when the list is exhausted.
2018-12-29 16:05:19 -08:00
<!-- EOF -->