docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Struct QueryEnumerable<T1>

    An enumeration interface for the entities that match an EntityQuery.

    Namespace: Unity.Entities
    Assembly: Unity.Entities.dll
    Syntax
    public struct QueryEnumerable<T1>
    Type Parameters
    Name Description
    T1

    A component type

    Remarks

    This feature is primarily intended as a backend implementation for Query<T1>(). Application code should prefer to use that interface rather than using this type directly.

    Methods

    Name Description
    GetEnumerator()

    Returns an enumerator over the entities in this query.

    WithAbsent<TComponent1>()

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

    WithAbsent<TComponent1, TComponent2>()

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

    WithAbsent<TComponent1, TComponent2, TComponent3>()

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

    WithAll<TComponent1>()

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

    WithAll<TComponent1, TComponent2>()

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

    WithAll<TComponent1, TComponent2, TComponent3>()

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

    WithAny<TComponent1>()

    Specify optional read-only component types (which must be enabled).

    WithAny<TComponent1, TComponent2>()

    Specify optional read-only component types (which must be enabled).

    WithAny<TComponent1, TComponent2, TComponent3>()

    Specify optional read-only component types (which must be enabled).

    WithChangeFilter<TChangeFilter1>()

    Only select components in chunks in which the specified component might have changed since the last time the system updated.

    WithChangeFilter<TChangeFilter1, TChangeFilter2>()

    Only select components in chunks in which the specified component might have changed since the last time the system updated.

    WithDisabled<TComponent1>()

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

    WithDisabled<TComponent1, TComponent2>()

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

    WithDisabled<TComponent1, TComponent2, TComponent3>()

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

    WithEntityAccess()

    Invoke this method if you wish to retrieve a tuple with an Entity parameter, thus giving you direct access to an entity.

    WithNone<TComponent1>()

    Specify component types that must be absent, or present and disabled.

    WithNone<TComponent1, TComponent2>()

    Specify component types that must be absent, or present and disabled.

    WithNone<TComponent1, TComponent2, TComponent3>()

    Specify component types that must be absent, or present and disabled.

    WithOptions(EntityQueryOptions)

    Specify your own EntityQueryOptions.

    WithPresent<TComponent1>()

    Specify all read-only component types that must be present, whether enabled or disabled.

    WithPresent<TComponent1, TComponent2>()

    Specify all read-only component types that must be present, whether enabled or disabled.

    WithPresent<TComponent1, TComponent2, TComponent3>()

    Specify all read-only component types that must be present, whether enabled or disabled.

    WithSharedComponentFilterManaged<TSharedComponent1>(TSharedComponent1)

    Only select chunks that have a specified value for a managed shared component.

    WithSharedComponentFilterManaged<TSharedComponent1, TSharedComponent2>(TSharedComponent1, TSharedComponent2)

    Only select chunks that have the specified values for two managed shared components.

    WithSharedComponentFilter<TSharedComponent1>(TSharedComponent1)

    Only select chunks that have a specified value for a shared component.

    WithSharedComponentFilter<TSharedComponent1, TSharedComponent2>(TSharedComponent1, TSharedComponent2)

    Only select chunks that have the specified values for two shared components.


    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 © 2025 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)