Class Query<P>

A Query represents a collection of Entitys matching a given set of criteria. It can also provide deltas relative to the previous result.

Type Parameters

P extends QueryProps = QueryProps

The QueryProps the Query was constructed with.

Hierarchy

Query

Index

Constructors

constructor

Methods

Constructors

constructor

new Query<P>(param0: P): Query<P>

- Defined in ecs/src/lib/Query.ts:109
Constructs a new Query. See QueryProps for options.

Type Parameters
- P extends QueryProps<ComponentDeclaration<object>[], P> = QueryProps<ComponentDeclaration<object>[]>
Parameters
- param0: P
  
  see QueryProps
Returns Query<P>

Methods

collect

collect(): QueryResult<P>

- Defined in ecs/src/lib/Query.ts:258
Returns the query result at this point in time.

remarks
Note, that only the result of the most recent call to Query.collect is valid. Previous results are unstable and will yield incorrect results.

Returns QueryResult<P>
The query result.

isDestroyed

isDestroyed(): boolean

- Defined in ecs/src/lib/Query.ts:292
Returns whether Query.destroy has been called on the query.

Returns boolean
true if the query was destroyed, false otherwise.

destroy

destroy(): void

- Defined in ecs/src/lib/Query.ts:301
Destroys the Query, clearing all previous results and preventing it from being updated in the future.

Returns void

Generated using TypeDoc