Version: Unity 7.0 Alpha (7000.0)
LanguageEnglish
  • C#

SystemAPIQueryBuilder

struct in Unity.Entities

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Supports construction of queries matching one or multiple archetypes inside ISystem and SystemBase types. All queried components must be known at compile-time.

Public Methods

Method Description
AddAdditionalQuery Finalize the existing query description. All .WithXXX() invocations chained after this method will create a new query description.
Build Get or create an EntityQuery matching the query description(s).
WithAbsent Specify all read-only component types that must NOT be present.
WithAbsentChunkComponent Add an absent Chunk Component type to the query.
WithAll Specify all read-only component types that must be present and enabled on matching entities.
WithAllChunkComponent Add a required Chunk Component type to the query, which must be enabled.
WithAllChunkComponentRW Add a required Chunk Component type to the query, which must be enabled.
WithAllRW Specify all read-write component types that must be present and enabled on matching entities.
WithAny Specify optional read-only component types that must be present.
WithAnyChunkComponent Add an optional Chunk Component type to the query.
WithAnyChunkComponentRW Add an optional Chunk Component type to the query.
WithAnyRW Specify optional read-write component types that must be present.
WithDisabled Specify all read-only DISABLED component types that must be present.
WithDisabledRW Specify all DISABLED component types (with write access) that must be present.
WithNone Specify component types that must NOT be present.
WithNoneChunkComponent Add an excluded Chunk Component type to the query.
WithOptions Specify your own EntityQueryOptions.
WithPresent Specify all read-only component types that must be present, whether or not they are enabled on matching entities.
WithPresentChunkComponent Add a required Chunk Component type to the query, whether or not it is enabled.
WithPresentChunkComponentRW Add a required Chunk Component type to the query, whether or not it is enabled.
WithPresentRW Specify all read-write component types that must be present, whether or not they are enabled on matching entities.