Struct EntityQueryMask

Provides an efficient test of whether a specific entity would be selected by an EntityQuery.

Namespace: Unity.Entities
Syntax
public struct EntityQueryMask
Remarks

Use a mask to quickly identify whether an entity would be selected by an EntityQuery.

       var mask = EntityManager.GetEntityQueryMask(query);
       bool doesMatch = mask.Matches(entity);

You can create up to 1024 unique EntityQueryMasks in an application. Note that EntityQueryMask only filters by Archetype, it doesn't support EntityQuery shared component or change filtering.

Methods

Matches(Entity)

Reports whether an entity would be selected by the EntityQuery instance used to create this entity query mask.

Declaration
public bool Matches(Entity entity)
Parameters
Type Name Description
Entity entity

The entity to check.
Returns
Type Description
Boolean

True if the entity would be returned by the EntityQuery, false if it would not.
Remarks

The match does not consider any filter settings of the EntityQuery.

See Also