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: solution.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.

    WithAllChunkComponent<T>()

    Add a required Chunk Component type to the query.

    WithAllRW<T1>()

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

    WithAllRW<T1, T2>()

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

    WithAll<T1>()

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

    WithAll<T1, T2>()

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

    WithAll<T1, T2, T3>()

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

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

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

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

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

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

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

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

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

    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.


    Did you find this page useful? Please give it a rating:

    Thanks for rating this page!

    Report a problem on this page

    What kind of problem would you like to report?

    • This page needs code samples
    • Code samples do not work
    • Information is missing
    • Information is incorrect
    • Information is unclear or confusing
    • There is a spelling/grammar error on this page
    • Something else

    Thanks for letting us know! This page has been marked for review based on your feedback.

    If you have time, you can provide more information to help us fix the problem faster.

    Provide more information

    You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:

    You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:

    You've told us there is information missing from this page. Please tell us more about what's missing:

    You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:

    You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:

    You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:

    You've told us this page has a problem. Please tell us more about what's wrong:

    Thank you for helping to make the Unity documentation better!

    Your feedback has been submitted as a ticket for our documentation team to review.

    We are not able to reply to every ticket submitted.

    In This Article
    • Methods
    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)