docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Struct SystemAPIQueryBuilder

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

    Namespace: Unity.Entities
    Assembly: Unity.Entities.dll
    Syntax
    public struct SystemAPIQueryBuilder

    Methods

    Name 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).

    WithAbsentChunkComponent<T1>()

    Add an absent Chunk Component type to the query.

    WithAbsent<T1>()

    Specify all read-only component types that must NOT be present.

    WithAbsent<T1, T2>()

    Specify all read-only component types that must NOT be present.

    WithAbsent<T1, T2, T3>()

    Specify all read-only component types that must NOT be present.

    WithAbsent<T1, T2, T3, T4>()

    Specify all read-only component types that must NOT be present.

    WithAbsent<T1, T2, T3, T4, T5>()

    Specify all read-only component types that must NOT be present.

    WithAbsent<T1, T2, T3, T4, T5, T6>()

    Specify all read-only component types that must NOT be present.

    WithAbsent<T1, T2, T3, T4, T5, T6, T7>()

    Specify all read-only component types that must NOT be present.

    WithAllChunkComponentRW<T>()

    Add a required Chunk Component type to the query, which must be enabled.

    WithAllChunkComponent<T>()

    Add a required Chunk Component type to the query, which must be enabled.

    WithAllRW<T1>()

    Specify all read-write component types that must be present and enabled on matching entities.

    WithAllRW<T1, T2>()

    Specify all read-write component types that must be present and enabled on matching entities.

    WithAll<T1>()

    Specify all read-only component types that must be present and enabled on matching entities.

    WithAll<T1, T2>()

    Specify all read-only component types that must be present and enabled on matching entities.

    WithAll<T1, T2, T3>()

    Specify all read-only component types that must be present and enabled on matching entities.

    WithAll<T1, T2, T3, T4>()

    Specify all read-only component types that must be present and enabled on matching entities.

    WithAll<T1, T2, T3, T4, T5>()

    Specify all read-only component types that must be present and enabled on matching entities.

    WithAll<T1, T2, T3, T4, T5, T6>()

    Specify all read-only component types that must be present and enabled on matching entities.

    WithAll<T1, T2, T3, T4, T5, T6, T7>()

    Specify all read-only component types that must be present and enabled on matching entities.

    WithAnyChunkComponentRW<T>()

    Add an optional Chunk Component type to the query.

    WithAnyChunkComponent<T>()

    Add an optional Chunk Component type to the query.

    WithAnyRW<T1>()

    Specify optional read-write component types that must be present.

    WithAnyRW<T1, T2>()

    Specify optional read-write component types that must be present.

    WithAny<T1>()

    Specify optional read-only component types that must be present.

    WithAny<T1, T2>()

    Specify optional read-only component types that must be present.

    WithAny<T1, T2, T3>()

    Specify optional read-only component types that must be present.

    WithAny<T1, T2, T3, T4>()

    Specify optional read-only component types that must be present.

    WithAny<T1, T2, T3, T4, T5>()

    Specify optional read-only component types that must be present.

    WithAny<T1, T2, T3, T4, T5, T6>()

    Specify optional read-only component types that must be present.

    WithAny<T1, T2, T3, T4, T5, T6, T7>()

    Specify optional read-only component types that must be present.

    WithAspect<TAspect>()

    Add component type requirement for a given aspect.

    WithDisabledRW<T1>()

    Specify all DISABLED component types (with write access) that must be present.

    WithDisabledRW<T1, T2>()

    Specify all DISABLED component types (with write access) that must be present.

    WithDisabled<T1>()

    Specify all read-only DISABLED component types that must be present.

    WithDisabled<T1, T2>()

    Specify all read-only DISABLED component types that must be present.

    WithDisabled<T1, T2, T3>()

    Specify all read-only DISABLED component types that must be present.

    WithDisabled<T1, T2, T3, T4>()

    Specify all read-only DISABLED component types that must be present.

    WithDisabled<T1, T2, T3, T4, T5>()

    Specify all read-only DISABLED component types that must be present.

    WithDisabled<T1, T2, T3, T4, T5, T6>()

    Specify all read-only DISABLED component types that must be present.

    WithDisabled<T1, T2, T3, T4, T5, T6, T7>()

    Specify all read-only DISABLED component types that must be present.

    WithNoneChunkComponent<T>()

    Add an excluded Chunk Component type to the query.

    WithNone<T1>()

    Specify component types that must NOT be present.

    WithNone<T1, T2>()

    Specify component types that must NOT be present.

    WithNone<T1, T2, T3>()

    Specify component types that must NOT be present.

    WithNone<T1, T2, T3, T4>()

    Specify component types that must NOT be present.

    WithNone<T1, T2, T3, T4, T5>()

    Specify component types that must NOT be present.

    WithNone<T1, T2, T3, T4, T5, T6>()

    Specify component types that must NOT be present.

    WithNone<T1, T2, T3, T4, T5, T6, T7>()

    Specify component types that must NOT be present.

    WithOptions(EntityQueryOptions)

    Specify your own EntityQueryOptions.

    WithPresentChunkComponentRW<T>()

    Add a required Chunk Component type to the query, whether or not it is enabled.

    WithPresentChunkComponent<T>()

    Add a required Chunk Component type to the query, whether or not it is enabled.

    WithPresentRW<T1>()

    Specify all read-write component types that must be present, whether or not they are enabled on matching entities.

    WithPresentRW<T1, T2>()

    Specify all read-write component types that must be present, whether or not they are enabled on matching entities.

    WithPresent<T1>()

    Specify all read-only component types that must be present, whether or not they are enabled on matching entities.

    WithPresent<T1, T2>()

    Specify all read-only component types that must be present, whether or not they are enabled on matching entities.

    WithPresent<T1, T2, T3>()

    Specify all read-only component types that must be present, whether or not they are enabled on matching entities.

    WithPresent<T1, T2, T3, T4>()

    Specify all read-only component types that must be present, whether or not they are enabled on matching entities.

    WithPresent<T1, T2, T3, T4, T5>()

    Specify all read-only component types that must be present, whether or not they are enabled on matching entities.

    WithPresent<T1, T2, T3, T4, T5, T6>()

    Specify all read-only component types that must be present, whether or not they are enabled on matching entities.

    WithPresent<T1, T2, T3, T4, T5, T6, T7>()

    Specify all read-only component types that must be present, whether or not they are enabled on matching entities.

    In This Article
    Back to top
    Copyright © 2024 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)