From f64158389ae083e2d28f5133e380a820097fec5a Mon Sep 17 00:00:00 2001 From: Ukendio Date: Tue, 30 Jul 2024 17:40:32 +0200 Subject: [PATCH] Add drain to docs --- docs/api/query.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/api/query.md b/docs/api/query.md index 228032d..da66397 100644 --- a/docs/api/query.md +++ b/docs/api/query.md @@ -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(