Documentation

Unity Engine


Unity Engine


QueryEnumerable<T1, T2, T3, T4>

An enumeration interface for the entities that match an EntityQuery.
Read time 1 minuteLast updated a day ago

Definition

public struct QueryEnumerable<T1, T2, T3, T4> : IEnumerable<(T1, T2, T3, T4)>, IEnumerable

Remarks

This feature is primarily intended as a backend implementation for SystemAPI.Query. Application code should prefer to use that interface rather than using this type directly.

Methods

Method

Description

GetEnumeratorReturns an enumerator over the entities in this query.
WithAbsentSpecify all read-only component types that must NOT be present.
WithAllSpecify all read-only component types that must be present AND enabled.
WithAnySpecify optional read-only component types (which must be enabled).
WithChangeFilterOnly select components in chunks in which the specified component might have changed since the last time the system updated.
WithDisabledSpecify all read-only component types that must be present AND disabled.
WithEntityAccessInvoke this method if you wish to retrieve a tuple with an
Entity
parameter, thus giving you direct access to an entity.
WithNoneSpecify component types that must be absent, or present and disabled.
WithOptionsSpecify your own
EntityQueryOptions
.
WithPresentSpecify all read-only component types that must be present, whether enabled or disabled.
WithSharedComponentFilterOnly select chunks that have a specified value for a shared component.