Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

SystemAPIQueryBuilder

Supports construction of queries matching one or multiple archetypes inside ISystem and SystemBase types. All queried components must be known at compile-time.
Read time 2 minutesLast updated a day ago

Definition

  • Type: Struct
  • Namespace: Unity.Entities
  • Assembly: UnityEngine.EntitiesModule
public struct SystemAPIQueryBuilder

Methods

Method

Description

AddAdditionalQueryFinalize the existing query description. All 
.WithXXX()
invocations chained after this method will create a new query description.
BuildGet or create an 
EntityQuery
matching the query description(s).
WithAbsentSpecify all read-only component types that must NOT be present.
WithAbsentChunkComponentAdd an absent Chunk Component type to the query.
WithAllSpecify all read-only component types that must be present and enabled on matching entities.
WithAllChunkComponentAdd a required Chunk Component type to the query, which must be enabled.
WithAllChunkComponentRWAdd a required Chunk Component type to the query, which must be enabled.
WithAllRWSpecify all read-write component types that must be present and enabled on matching entities.
WithAnySpecify optional read-only component types that must be present.
WithAnyChunkComponentAdd an optional Chunk Component type to the query.
WithAnyChunkComponentRWAdd an optional Chunk Component type to the query.
WithAnyRWSpecify optional read-write component types that must be present.
WithDisabledSpecify all read-only DISABLED component types that must be present.
WithDisabledRWSpecify all DISABLED component types (with write access) that must be present.
WithNoneSpecify component types that must NOT be present.
WithNoneChunkComponentAdd an excluded Chunk Component type to the query.
WithOptionsSpecify your own 
EntityQueryOptions
.
WithPresentSpecify all read-only component types that must be present, whether or not they are enabled on matching entities.
WithPresentChunkComponentAdd a required Chunk Component type to the query, whether or not it is enabled.
WithPresentChunkComponentRWAdd a required Chunk Component type to the query, whether or not it is enabled.
WithPresentRWSpecify all read-write component types that must be present, whether or not they are enabled on matching entities.