From bfc3eb99808aace211253e2d2762caf520ad4b20 Mon Sep 17 00:00:00 2001 From: kuro Date: Wed, 29 Apr 2026 10:23:40 -0400 Subject: [PATCH] comments for world:targets (#312) * docs for world:targets * Update src/jecs.d.ts Co-authored-by: dai * remove world:targets() mention in 042_target.luau * ensure doc comments are same across files --------- Co-authored-by: dai --- src/jecs.d.ts | 8 ++++++++ src/jecs.luau | 3 ++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/src/jecs.d.ts b/src/jecs.d.ts index e2de9d6..7b113df 100755 --- a/src/jecs.d.ts +++ b/src/jecs.d.ts @@ -155,6 +155,14 @@ export class World { */ target(entity: Entity, relation: Entity, index?: number): Entity | undefined; + /** + * Gets an iterator for all targets of a relationship. + * Returns an empty iterator if no matches are found. + * @param entity The entity using a relationship pair. + * @param relation The "relationship" component/tag + */ + targets(entity: Entity, relation: Entity): IterFn<[]> + /** * Deletes an entity (and its components/relationships) from the world entirely. * @param entity The entity to delete. diff --git a/src/jecs.luau b/src/jecs.luau index 453bc88..a8cb226 100755 --- a/src/jecs.luau +++ b/src/jecs.luau @@ -254,7 +254,8 @@ export type World = { index: number? ) -> Entity?, - -- Gets an iterator for all viable targets of a relationship + -- Gets an iterator for all targets of a relationship. + -- Returns an empty iterator if no matches are found. targets: ( self: World, id: Entity | number,