docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Struct QueryEnumerableWithEntity<T1>

    An enumeration interface for the entities that match an EntityQuery. This variant includes access the the entity and its component values.

    Namespace: Unity.Entities
    Assembly: solution.dll
    Syntax
    public readonly struct QueryEnumerableWithEntity<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.

    Constructors

    Name Description
    QueryEnumerableWithEntity(T1, Entity)

    Construct a new object.

    Fields

    Name Description
    Item1

    A component value for the current entity.

    Item2

    The current entity.

    Methods

    Name Description
    Deconstruct(out T1, out Entity)

    Clean up an existing object.

    GetEnumerator()

    Returns an enumerator over the entities in this query.

    WithAll<TComponent1>()

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

    WithAll<TComponent1, TComponent2>()

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

    WithAll<TComponent1, TComponent2, TComponent3>()

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

    WithAny<TComponent1>()

    Specify optional read-only component types.

    WithAny<TComponent1, TComponent2>()

    Specify optional read-only component types.

    WithAny<TComponent1, TComponent2, TComponent3>()

    Specify optional read-only component types.

    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.

    WithNone<TComponent1>()

    Specify component types that must be absent.

    WithNone<TComponent1, TComponent2>()

    Specify component types that must be absent.

    WithNone<TComponent1, TComponent2, TComponent3>()

    Specify component types that must be absent.

    WithOptions(EntityQueryOptions)

    Specify your own EntityQueryOptions.

    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 a specified value for a shared component.

    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)