Skip to content

Commit

Permalink
Add drain to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Ukendio committed Jul 30, 2024
1 parent d7bda01 commit f641583
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/api/query.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,18 @@ A World contains entities which have components. The World is queryable and can

## Functions

### drain()
```luau
function query:drain(): Query
```
This function will impede it from being reset when the query is being iterated.

### next()
```luau
function query:next(): Query
```
Get the next result in the query. Drain must have been called beforehand or otherwise it will error.

### with()
```luau
function query:with(
Expand Down

0 comments on commit f641583

Please sign in to comment.