docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Method WithAbsent

    WithAbsent<T1>()

    Add absent component types to the query.

    Declaration
    [GenerateTestsForBurstCompatibility(GenericTypeArguments = new Type[] { typeof(BurstCompatibleComponentData) })]
    public EntityQueryBuilder WithAbsent<T1>()
    Returns
    Type Description
    EntityQueryBuilder

    The builder object that invoked this method.

    Type Parameters
    Name Description
    T1

    An absent component type

    Remarks

    To match the resulting query, an archetype must not have any of the absent components (whether they are disabled or enabled).

    There are several ways to exclude components from a query:

    • WithAbsent<T>() matches all entities in chunks that do not have T at all.
    • WithDisabled<T>() matches chunks that must have T, but only matches entities where T is disabled.
    • WithNone<T>() matches both of the above cases: either the component isn't present at all, or it is present but disabled.

    WithAbsent accepts up to seven type arguments. You can add more component types by chaining calls together.

    To add component types that are not known at compile time, use WithAbsent<T>(ref T)

    Component types added using WithAbsent are never written to. If the ComponentType.AccessMode field of the provided component type is ReadWrite, it will be forced to ReadOnly in the final query.

    WithAbsent<T1, T2>()

    Add absent component types to the query.

    Declaration
    [GenerateTestsForBurstCompatibility(GenericTypeArguments = new Type[] { typeof(BurstCompatibleComponentData), typeof(BurstCompatibleComponentData) })]
    public EntityQueryBuilder WithAbsent<T1, T2>()
    Returns
    Type Description
    EntityQueryBuilder

    The builder object that invoked this method.

    Type Parameters
    Name Description
    T1

    An absent component type

    T2

    An absent component type

    Remarks

    To match the resulting query, an archetype must not have any of the absent components (whether they are disabled or enabled).

    There are several ways to exclude components from a query:

    • WithAbsent<T>() matches all entities in chunks that do not have T at all.
    • WithDisabled<T>() matches chunks that must have T, but only matches entities where T is disabled.
    • WithNone<T>() matches both of the above cases: either the component isn't present at all, or it is present but disabled.

    WithAbsent accepts up to seven type arguments. You can add more component types by chaining calls together.

    To add component types that are not known at compile time, use WithAbsent<T>(ref T)

    Component types added using WithAbsent are never written to. If the ComponentType.AccessMode field of the provided component type is ReadWrite, it will be forced to ReadOnly in the final query.

    WithAbsent<T1, T2, T3>()

    Add absent component types to the query.

    Declaration
    [GenerateTestsForBurstCompatibility(GenericTypeArguments = new Type[] { typeof(BurstCompatibleComponentData), typeof(BurstCompatibleComponentData), typeof(BurstCompatibleComponentData) })]
    public EntityQueryBuilder WithAbsent<T1, T2, T3>()
    Returns
    Type Description
    EntityQueryBuilder

    The builder object that invoked this method.

    Type Parameters
    Name Description
    T1

    An absent component type

    T2

    An absent component type

    T3

    An absent component type

    Remarks

    To match the resulting query, an archetype must not have any of the absent components (whether they are disabled or enabled).

    There are several ways to exclude components from a query:

    • WithAbsent<T>() matches all entities in chunks that do not have T at all.
    • WithDisabled<T>() matches chunks that must have T, but only matches entities where T is disabled.
    • WithNone<T>() matches both of the above cases: either the component isn't present at all, or it is present but disabled.

    WithAbsent accepts up to seven type arguments. You can add more component types by chaining calls together.

    To add component types that are not known at compile time, use WithAbsent<T>(ref T)

    Component types added using WithAbsent are never written to. If the ComponentType.AccessMode field of the provided component type is ReadWrite, it will be forced to ReadOnly in the final query.

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

    Add absent component types to the query.

    Declaration
    [GenerateTestsForBurstCompatibility(GenericTypeArguments = new Type[] { typeof(BurstCompatibleComponentData), typeof(BurstCompatibleComponentData), typeof(BurstCompatibleComponentData), typeof(BurstCompatibleComponentData) })]
    public EntityQueryBuilder WithAbsent<T1, T2, T3, T4>()
    Returns
    Type Description
    EntityQueryBuilder

    The builder object that invoked this method.

    Type Parameters
    Name Description
    T1

    An absent component type

    T2

    An absent component type

    T3

    An absent component type

    T4

    An absent component type

    Remarks

    To match the resulting query, an archetype must not have any of the absent components (whether they are disabled or enabled).

    There are several ways to exclude components from a query:

    • WithAbsent<T>() matches all entities in chunks that do not have T at all.
    • WithDisabled<T>() matches chunks that must have T, but only matches entities where T is disabled.
    • WithNone<T>() matches both of the above cases: either the component isn't present at all, or it is present but disabled.

    WithAbsent accepts up to seven type arguments. You can add more component types by chaining calls together.

    To add component types that are not known at compile time, use WithAbsent<T>(ref T)

    Component types added using WithAbsent are never written to. If the ComponentType.AccessMode field of the provided component type is ReadWrite, it will be forced to ReadOnly in the final query.

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

    Add absent component types to the query.

    Declaration
    [GenerateTestsForBurstCompatibility(GenericTypeArguments = new Type[] { typeof(BurstCompatibleComponentData), typeof(BurstCompatibleComponentData), typeof(BurstCompatibleComponentData), typeof(BurstCompatibleComponentData), typeof(BurstCompatibleComponentData) })]
    public EntityQueryBuilder WithAbsent<T1, T2, T3, T4, T5>()
    Returns
    Type Description
    EntityQueryBuilder

    The builder object that invoked this method.

    Type Parameters
    Name Description
    T1

    An absent component type

    T2

    An absent component type

    T3

    An absent component type

    T4

    An absent component type

    T5

    An absent component type

    Remarks

    To match the resulting query, an archetype must not have any of the absent components (whether they are disabled or enabled).

    There are several ways to exclude components from a query:

    • WithAbsent<T>() matches all entities in chunks that do not have T at all.
    • WithDisabled<T>() matches chunks that must have T, but only matches entities where T is disabled.
    • WithNone<T>() matches both of the above cases: either the component isn't present at all, or it is present but disabled.

    WithAbsent accepts up to seven type arguments. You can add more component types by chaining calls together.

    To add component types that are not known at compile time, use WithAbsent<T>(ref T)

    Component types added using WithAbsent are never written to. If the ComponentType.AccessMode field of the provided component type is ReadWrite, it will be forced to ReadOnly in the final query.

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

    Add absent component types to the query.

    Declaration
    [GenerateTestsForBurstCompatibility(GenericTypeArguments = new Type[] { typeof(BurstCompatibleComponentData), typeof(BurstCompatibleComponentData), typeof(BurstCompatibleComponentData), typeof(BurstCompatibleComponentData), typeof(BurstCompatibleComponentData), typeof(BurstCompatibleComponentData) })]
    public EntityQueryBuilder WithAbsent<T1, T2, T3, T4, T5, T6>()
    Returns
    Type Description
    EntityQueryBuilder

    The builder object that invoked this method.

    Type Parameters
    Name Description
    T1

    An absent component type

    T2

    An absent component type

    T3

    An absent component type

    T4

    An absent component type

    T5

    An absent component type

    T6

    An absent component type

    Remarks

    To match the resulting query, an archetype must not have any of the absent components (whether they are disabled or enabled).

    There are several ways to exclude components from a query:

    • WithAbsent<T>() matches all entities in chunks that do not have T at all.
    • WithDisabled<T>() matches chunks that must have T, but only matches entities where T is disabled.
    • WithNone<T>() matches both of the above cases: either the component isn't present at all, or it is present but disabled.

    WithAbsent accepts up to seven type arguments. You can add more component types by chaining calls together.

    To add component types that are not known at compile time, use WithAbsent<T>(ref T)

    Component types added using WithAbsent are never written to. If the ComponentType.AccessMode field of the provided component type is ReadWrite, it will be forced to ReadOnly in the final query.

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

    Add absent component types to the query.

    Declaration
    [GenerateTestsForBurstCompatibility(GenericTypeArguments = new Type[] { typeof(BurstCompatibleComponentData), typeof(BurstCompatibleComponentData), typeof(BurstCompatibleComponentData), typeof(BurstCompatibleComponentData), typeof(BurstCompatibleComponentData), typeof(BurstCompatibleComponentData), typeof(BurstCompatibleComponentData) })]
    public EntityQueryBuilder WithAbsent<T1, T2, T3, T4, T5, T6, T7>()
    Returns
    Type Description
    EntityQueryBuilder

    The builder object that invoked this method.

    Type Parameters
    Name Description
    T1

    An absent component type

    T2

    An absent component type

    T3

    An absent component type

    T4

    An absent component type

    T5

    An absent component type

    T6

    An absent component type

    T7

    An absent component type

    Remarks

    To match the resulting query, an archetype must not have any of the absent components (whether they are disabled or enabled).

    There are several ways to exclude components from a query:

    • WithAbsent<T>() matches all entities in chunks that do not have T at all.
    • WithDisabled<T>() matches chunks that must have T, but only matches entities where T is disabled.
    • WithNone<T>() matches both of the above cases: either the component isn't present at all, or it is present but disabled.

    WithAbsent accepts up to seven type arguments. You can add more component types by chaining calls together.

    To add component types that are not known at compile time, use WithAbsent<T>(ref T)

    Component types added using WithAbsent are never written to. If the ComponentType.AccessMode field of the provided component type is ReadWrite, it will be forced to ReadOnly in the final query.

    WithAbsent<T>(ref T)

    Add absent component types to the query.

    Declaration
    [GenerateTestsForBurstCompatibility(GenericTypeArguments = new Type[] { typeof(FixedList32Bytes<ComponentType>) })]
    public EntityQueryBuilder WithAbsent<T>(ref T componentTypes) where T : INativeList<ComponentType>
    Parameters
    Type Name Description
    T componentTypes

    A list of component types that implements INativeList<T>. For example, NativeList<T> or FixedList64Bytes<T>

    Returns
    Type Description
    EntityQueryBuilder

    The builder object that invoked this method.

    Type Parameters
    Name Description
    T

    A container of component types

    Remarks

    To match the resulting query, an archetype must not have any of the absent components.

    To add component types that are known at compile time, use WithNone<T1>()

    There are several ways to exclude components from a query:

    • WithAbsent<T>() matches all entities in chunks that do not have T at all.
    • WithDisabled<T>() matches chunks that must have T, but only matches entities where T is disabled.
    • WithNone<T>() matches both of the above cases: either the component isn't present at all, or it is present but disabled.

    Component types added using WithAbsent are never written to. If the ComponentType.AccessMode field of the provided component type is ReadWrite, it will be forced to ReadOnly in the final query.


    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
    • WithAbsent<T1>()
    • WithAbsent<T1, T2>()
    • WithAbsent<T1, T2, T3>()
    • WithAbsent<T1, T2, T3, T4>()
    • WithAbsent<T1, T2, T3, T4, T5>()
    • WithAbsent<T1, T2, T3, T4, T5, T6>()
    • WithAbsent<T1, T2, T3, T4, T5, T6, T7>()
    • WithAbsent<T>(ref T)
    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)