WithDisabled
Add required disabled component types to the query.
Read time 2 minutesLast updated 2 days ago
Definition
- Type: Method
- Namespace: Unity.Entities
- Assembly: UnityEngine.EntitiesModule
WithDisabled<T>()
Add required disabled component types to the query.
public EntityQueryBuilder WithDisabled<T1>()
Returns
Type | Description |
|---|---|
| EntityQueryBuilder | The builder object that invoked this method. |
Remarks
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 WithAll@@@@1. To require components regardless of whether they are enabled on matching entities, use 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 EntityQueryBuilder.WithDisabled@@<c>1(</c>@@0)
The query will request read-only access to the referenced component(s). To request read/write access, use EntityQueryBuilder.WithDisabledRW@@<c>1(</c>@@0)
WithDisabled<T>(T)
Add a list of required disabled component types to the query.
public EntityQueryBuilder WithDisabled<T>(ref T componentTypes) where T : INativeList<ComponentType>
Parameters
Returns
Type | Description |
|---|---|
| EntityQueryBuilder | The builder object that invoked this method. |
Remarks
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.