Documentation

Unity Engine


Unity Engine


Matches(Entity)

Returns true if the entity matches the query, false if it does not.
Read time 1 minuteLast updated a day ago

Definition

  • Type: Method
  • Namespace: Unity.Entities
  • Assembly: UnityEngine.EntitiesModule
public bool Matches(Entity e)

Parameters

The entity to check for match

Returns

Type

Description

boolTrue if the entity is matched by the query, or false if not.

Remarks

This function will automatically block on any running jobs writing to component data that would affect the results of the check. For a non-blocking variant that ignores any query filtering, see EntityQuery.MatchesIgnoreFilter.
This function creates a EntityQueryMask, if one does not exist for this query already. A maximum of 1024 EntityQueryMasks can be allocated per World.
Additional Resources: EntityQuery.MatchesIgnoreFilter