WithDisabledRW<T1>()
Add required disabled component types to the query with ReadWrite mode.
Read time 1 minuteLast updated 2 days ago
Definition
- Type: Method
- Namespace: Unity.Entities
- Assembly: UnityEngine.EntitiesModule
WithDisabledRW<T>()
public EntityQueryBuilder WithDisabledRW<T1>()
Returns
Type | Description |
|---|---|
| EntityQueryBuilder | The builder object that invoked this method. |
Remarks
If a query uses the EntityQueryOptions.FilterWriteGroup option, you must use WithDisabledRW to specify the query's writeable required components. Refer to the write groups guide for more information.
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.
WithDisabledRW accepts up to two type arguments. You can add more component types by chaining calls together.
To request read-only access, use EntityQueryBuilder.WithDisabled@@<c>1(</c>@@0)