Version: Unity 7.0 Alpha (7000.0)
LanguageEnglish
  • C#

EntityQueryBuilder.WithDisabled

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public EntityQueryBuilder WithDisabled();

Returns

EntityQueryBuilder The builder object that invoked this method.

Description

Add required disabled component types to the query.

To match the resulting query, an Entity must have all of the query's required component types, "and" they must all be disabled. To require components to be enabled on matching entities, use M:Unity.Entities.EntityQueryBuilder.WithAll@@@@1. To require components regardless of whether they are enabled on matching entities, use M:Unity.Entities.EntityQueryBuilder.WithPresent@@@@1.

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.


WithDisabled 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 M:Unity.Entities.EntityQueryBuilder.WithDisabled@@@@1(@@@@0@)

The query will request read-only access to the referenced component(s). To request read/write access, use M:Unity.Entities.EntityQueryBuilder.WithDisabledRW@@@@1(@@@@0@)


Declaration

public EntityQueryBuilder WithDisabled(ref T componentTypes);

Parameters

Parameter Description
componentTypes A list of component types that implements T:Unity.Collections.INativeList@@1. For example, T:Unity.Collections.NativeList@@1 or T:Unity.Collections.FixedList64Bytes`1

Returns

EntityQueryBuilder The builder object that invoked this method.

Description

Add a list of required disabled component types to the query.

To match the resulting query, an Entity must have all of the query's required component types, "and" they must all be disabled.

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.